\RolesAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
AdminRealmsRealmClientsClientUuidRolesGet	Get /admin/realms/{realm}/clients/{client-uuid}/roles	Get all roles for the realm or client
AdminRealmsRealmClientsClientUuidRolesPost	Post /admin/realms/{realm}/clients/{client-uuid}/roles	Create a new role for the realm or client
AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet	Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/clients/{client-in-composite-uuid}	Get client-level roles for the client that are in the role's composite
AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesDelete	Delete /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites	Remove roles from the role's composite
AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet	Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites	Get composites of the role
AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesPost	Post /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites	Add a composite to the role
AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet	Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/realm	Get realm-level roles of the role's composite
AdminRealmsRealmClientsClientUuidRolesRoleNameDelete	Delete /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}	Delete a role by name
AdminRealmsRealmClientsClientUuidRolesRoleNameGet	Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}	Get a role by name
AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet	Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/groups	Returns a stream of groups that have the specified role name
AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet	Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/management/permissions	Return object stating whether role Authorization permissions have been initialized or not and a reference
AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPut	Put /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/management/permissions	Return object stating whether role Authorization permissions have been initialized or not and a reference
AdminRealmsRealmClientsClientUuidRolesRoleNamePut	Put /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}	Update a role by name
AdminRealmsRealmClientsClientUuidRolesRoleNameUsersGet	Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/users	Returns a stream of users that have the specified role name.
AdminRealmsRealmRolesGet	Get /admin/realms/{realm}/roles	Get all roles for the realm or client
AdminRealmsRealmRolesPost	Post /admin/realms/{realm}/roles	Create a new role for the realm or client
AdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGet	Get /admin/realms/{realm}/roles/{role-name}/composites/clients/{client-uuid}	Get client-level roles for the client that are in the role's composite
AdminRealmsRealmRolesRoleNameCompositesDelete	Delete /admin/realms/{realm}/roles/{role-name}/composites	Remove roles from the role's composite
AdminRealmsRealmRolesRoleNameCompositesGet	Get /admin/realms/{realm}/roles/{role-name}/composites	Get composites of the role
AdminRealmsRealmRolesRoleNameCompositesPost	Post /admin/realms/{realm}/roles/{role-name}/composites	Add a composite to the role
AdminRealmsRealmRolesRoleNameCompositesRealmGet	Get /admin/realms/{realm}/roles/{role-name}/composites/realm	Get realm-level roles of the role's composite
AdminRealmsRealmRolesRoleNameDelete	Delete /admin/realms/{realm}/roles/{role-name}	Delete a role by name
AdminRealmsRealmRolesRoleNameGet	Get /admin/realms/{realm}/roles/{role-name}	Get a role by name
AdminRealmsRealmRolesRoleNameGroupsGet	Get /admin/realms/{realm}/roles/{role-name}/groups	Returns a stream of groups that have the specified role name
AdminRealmsRealmRolesRoleNameManagementPermissionsGet	Get /admin/realms/{realm}/roles/{role-name}/management/permissions	Return object stating whether role Authorization permissions have been initialized or not and a reference
AdminRealmsRealmRolesRoleNameManagementPermissionsPut	Put /admin/realms/{realm}/roles/{role-name}/management/permissions	Return object stating whether role Authorization permissions have been initialized or not and a reference
AdminRealmsRealmRolesRoleNamePut	Put /admin/realms/{realm}/roles/{role-name}	Update a role by name
AdminRealmsRealmRolesRoleNameUsersGet	Get /admin/realms/{realm}/roles/{role-name}/users	Returns a stream of users that have the specified role name.

AdminRealmsRealmClientsClientUuidRolesGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidRolesGet(ctx, realm, clientUuid).BriefRepresentation(briefRepresentation).First(first).Max(max).Search(search).Execute()

Get all roles for the realm or client

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	briefRepresentation := true // bool |  (optional) (default to true)
	first := int32(56) // int32 |  (optional)
	max := int32(56) // int32 |  (optional)
	search := "search_example" // string |  (optional) (default to "")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesGet(context.Background(), realm, clientUuid).BriefRepresentation(briefRepresentation).First(first).Max(max).Search(search).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesPost

AdminRealmsRealmClientsClientUuidRolesPost(ctx, realm, clientUuid).RoleRepresentation(roleRepresentation).Execute()

Create a new role for the realm or client

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleRepresentation := *openapiclient.NewRoleRepresentation() // RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesPost(context.Background(), realm, clientUuid).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesPostRequest struct via the builder pattern

Name	Type	Description	Notes

roleRepresentation | RoleRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet(ctx, realm, clientUuid, roleName, clientInCompositeUuid).Execute()

Get client-level roles for the client that are in the role's composite

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | 
	roleName := "roleName_example" // string | role's name (not id!)
	clientInCompositeUuid := "clientInCompositeUuid_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet(context.Background(), realm, clientUuid, roleName, clientInCompositeUuid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string
roleName	string	role's name (not id!)
clientInCompositeUuid	string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesDelete

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesDelete(ctx, realm, clientUuid, roleName).RoleRepresentation(roleRepresentation).Execute()

Remove roles from the role's composite

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | role's name (not id!)
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesDelete(context.Background(), realm, clientUuid, roleName).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameCompositesDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

roleRepresentation | []RoleRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet(ctx, realm, clientUuid, roleName).Execute()

Get composites of the role

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet(context.Background(), realm, clientUuid, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesPost

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesPost(ctx, realm, clientUuid, roleName).RoleRepresentation(roleRepresentation).Execute()

Add a composite to the role

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | role's name (not id!)
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesPost(context.Background(), realm, clientUuid, roleName).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameCompositesPostRequest struct via the builder pattern

Name	Type	Description	Notes

roleRepresentation | []RoleRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet(ctx, realm, clientUuid, roleName).Execute()

Get realm-level roles of the role's composite

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet(context.Background(), realm, clientUuid, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameDelete

AdminRealmsRealmClientsClientUuidRolesRoleNameDelete(ctx, realm, clientUuid, roleName).Execute()

Delete a role by name

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameDelete(context.Background(), realm, clientUuid, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameGet

RoleRepresentation AdminRealmsRealmClientsClientUuidRolesRoleNameGet(ctx, realm, clientUuid, roleName).Execute()

Get a role by name

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameGet(context.Background(), realm, clientUuid, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesRoleNameGet`: RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet

[]GroupRepresentation AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet(ctx, realm, clientUuid, roleName).BriefRepresentation(briefRepresentation).First(first).Max(max).Execute()

Returns a stream of groups that have the specified role name

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | the role name.
	briefRepresentation := true // bool | if false, return a full representation of the {@code GroupRepresentation} objects. (optional) (default to true)
	first := int32(56) // int32 | first result to return. Ignored if negative or {@code null}. (optional)
	max := int32(56) // int32 | maximum number of results to return. Ignored if negative or {@code null}. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet(context.Background(), realm, clientUuid, roleName).BriefRepresentation(briefRepresentation).First(first).Max(max).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet`: []GroupRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	the role name.

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGetRequest struct via the builder pattern

Name	Type	Description	Notes

briefRepresentation | bool | if false, return a full representation of the {@code GroupRepresentation} objects. | [default to true] first | int32 | first result to return. Ignored if negative or {@code null}. | max | int32 | maximum number of results to return. Ignored if negative or {@code null}. |

Return type

[]GroupRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet

ManagementPermissionReference AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet(ctx, realm, clientUuid, roleName).Execute()

Return object stating whether role Authorization permissions have been initialized or not and a reference

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet(context.Background(), realm, clientUuid, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet`: ManagementPermissionReference
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ManagementPermissionReference

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPut

ManagementPermissionReference AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPut(ctx, realm, clientUuid, roleName).ManagementPermissionReference(managementPermissionReference).Execute()

Return object stating whether role Authorization permissions have been initialized or not and a reference

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | 
	managementPermissionReference := *openapiclient.NewManagementPermissionReference() // ManagementPermissionReference |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPut(context.Background(), realm, clientUuid, roleName).ManagementPermissionReference(managementPermissionReference).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPut`: ManagementPermissionReference
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPut`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPutRequest struct via the builder pattern

Name	Type	Description	Notes

managementPermissionReference | ManagementPermissionReference | |

Return type

ManagementPermissionReference

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNamePut

AdminRealmsRealmClientsClientUuidRolesRoleNamePut(ctx, realm, clientUuid, roleName).RoleRepresentation(roleRepresentation).Execute()

Update a role by name

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | role's name (not id!)
	roleRepresentation := *openapiclient.NewRoleRepresentation() // RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNamePut(context.Background(), realm, clientUuid, roleName).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNamePut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNamePutRequest struct via the builder pattern

Name	Type	Description	Notes

roleRepresentation | RoleRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmClientsClientUuidRolesRoleNameUsersGet

[]UserRepresentation AdminRealmsRealmClientsClientUuidRolesRoleNameUsersGet(ctx, realm, clientUuid, roleName).BriefRepresentation(briefRepresentation).First(first).Max(max).Execute()

Returns a stream of users that have the specified role name.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | id of client (not client-id!)
	roleName := "roleName_example" // string | the role name.
	briefRepresentation := true // bool | Boolean which defines whether brief representations are returned (default: false) (optional)
	first := int32(56) // int32 | first result to return. Ignored if negative or {@code null}. (optional)
	max := int32(56) // int32 | maximum number of results to return. Ignored if negative or {@code null}. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameUsersGet(context.Background(), realm, clientUuid, roleName).BriefRepresentation(briefRepresentation).First(first).Max(max).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameUsersGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidRolesRoleNameUsersGet`: []UserRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmClientsClientUuidRolesRoleNameUsersGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string	id of client (not client-id!)
roleName	string	the role name.

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidRolesRoleNameUsersGetRequest struct via the builder pattern

Name	Type	Description	Notes

briefRepresentation | bool | Boolean which defines whether brief representations are returned (default: false) | first | int32 | first result to return. Ignored if negative or {@code null}. | max | int32 | maximum number of results to return. Ignored if negative or {@code null}. |

Return type

[]UserRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesGet

[]RoleRepresentation AdminRealmsRealmRolesGet(ctx, realm).BriefRepresentation(briefRepresentation).First(first).Max(max).Search(search).Execute()

Get all roles for the realm or client

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	briefRepresentation := true // bool |  (optional) (default to true)
	first := int32(56) // int32 |  (optional)
	max := int32(56) // int32 |  (optional)
	search := "search_example" // string |  (optional) (default to "")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesGet(context.Background(), realm).BriefRepresentation(briefRepresentation).First(first).Max(max).Search(search).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesPost

AdminRealmsRealmRolesPost(ctx, realm).RoleRepresentation(roleRepresentation).Execute()

Create a new role for the realm or client

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleRepresentation := *openapiclient.NewRoleRepresentation() // RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmRolesPost(context.Background(), realm).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesPostRequest struct via the builder pattern

Name	Type	Description	Notes

roleRepresentation | RoleRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGet

[]RoleRepresentation AdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGet(ctx, realm, clientUuid, roleName).Execute()

Get client-level roles for the client that are in the role's composite

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	clientUuid := "clientUuid_example" // string | 
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGet(context.Background(), realm, clientUuid, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
clientUuid	string
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameCompositesDelete

AdminRealmsRealmRolesRoleNameCompositesDelete(ctx, realm, roleName).RoleRepresentation(roleRepresentation).Execute()

Remove roles from the role's composite

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | role's name (not id!)
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameCompositesDelete(context.Background(), realm, roleName).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameCompositesDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameCompositesDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

roleRepresentation | []RoleRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameCompositesGet

[]RoleRepresentation AdminRealmsRealmRolesRoleNameCompositesGet(ctx, realm, roleName).Execute()

Get composites of the role

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameCompositesGet(context.Background(), realm, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameCompositesGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesRoleNameCompositesGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesRoleNameCompositesGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameCompositesGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameCompositesPost

AdminRealmsRealmRolesRoleNameCompositesPost(ctx, realm, roleName).RoleRepresentation(roleRepresentation).Execute()

Add a composite to the role

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | role's name (not id!)
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameCompositesPost(context.Background(), realm, roleName).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameCompositesPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameCompositesPostRequest struct via the builder pattern

Name	Type	Description	Notes

roleRepresentation | []RoleRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameCompositesRealmGet

[]RoleRepresentation AdminRealmsRealmRolesRoleNameCompositesRealmGet(ctx, realm, roleName).Execute()

Get realm-level roles of the role's composite

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameCompositesRealmGet(context.Background(), realm, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameCompositesRealmGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesRoleNameCompositesRealmGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesRoleNameCompositesRealmGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameCompositesRealmGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameDelete

AdminRealmsRealmRolesRoleNameDelete(ctx, realm, roleName).Execute()

Delete a role by name

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameDelete(context.Background(), realm, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameGet

RoleRepresentation AdminRealmsRealmRolesRoleNameGet(ctx, realm, roleName).Execute()

Get a role by name

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | role's name (not id!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameGet(context.Background(), realm, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesRoleNameGet`: RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesRoleNameGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

RoleRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameGroupsGet

[]GroupRepresentation AdminRealmsRealmRolesRoleNameGroupsGet(ctx, realm, roleName).BriefRepresentation(briefRepresentation).First(first).Max(max).Execute()

Returns a stream of groups that have the specified role name

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | the role name.
	briefRepresentation := true // bool | if false, return a full representation of the {@code GroupRepresentation} objects. (optional) (default to true)
	first := int32(56) // int32 | first result to return. Ignored if negative or {@code null}. (optional)
	max := int32(56) // int32 | maximum number of results to return. Ignored if negative or {@code null}. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameGroupsGet(context.Background(), realm, roleName).BriefRepresentation(briefRepresentation).First(first).Max(max).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameGroupsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesRoleNameGroupsGet`: []GroupRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesRoleNameGroupsGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	the role name.

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameGroupsGetRequest struct via the builder pattern

Name	Type	Description	Notes

briefRepresentation | bool | if false, return a full representation of the {@code GroupRepresentation} objects. | [default to true] first | int32 | first result to return. Ignored if negative or {@code null}. | max | int32 | maximum number of results to return. Ignored if negative or {@code null}. |

Return type

[]GroupRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameManagementPermissionsGet

ManagementPermissionReference AdminRealmsRealmRolesRoleNameManagementPermissionsGet(ctx, realm, roleName).Execute()

Return object stating whether role Authorization permissions have been initialized or not and a reference

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameManagementPermissionsGet(context.Background(), realm, roleName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameManagementPermissionsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesRoleNameManagementPermissionsGet`: ManagementPermissionReference
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesRoleNameManagementPermissionsGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameManagementPermissionsGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ManagementPermissionReference

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameManagementPermissionsPut

ManagementPermissionReference AdminRealmsRealmRolesRoleNameManagementPermissionsPut(ctx, realm, roleName).ManagementPermissionReference(managementPermissionReference).Execute()

Return object stating whether role Authorization permissions have been initialized or not and a reference

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | 
	managementPermissionReference := *openapiclient.NewManagementPermissionReference() // ManagementPermissionReference |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameManagementPermissionsPut(context.Background(), realm, roleName).ManagementPermissionReference(managementPermissionReference).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameManagementPermissionsPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesRoleNameManagementPermissionsPut`: ManagementPermissionReference
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesRoleNameManagementPermissionsPut`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameManagementPermissionsPutRequest struct via the builder pattern

Name	Type	Description	Notes

managementPermissionReference | ManagementPermissionReference | |

Return type

ManagementPermissionReference

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNamePut

AdminRealmsRealmRolesRoleNamePut(ctx, realm, roleName).RoleRepresentation(roleRepresentation).Execute()

Update a role by name

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | role's name (not id!)
	roleRepresentation := *openapiclient.NewRoleRepresentation() // RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNamePut(context.Background(), realm, roleName).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNamePut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	role's name (not id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNamePutRequest struct via the builder pattern

Name	Type	Description	Notes

roleRepresentation | RoleRepresentation | |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminRealmsRealmRolesRoleNameUsersGet

[]UserRepresentation AdminRealmsRealmRolesRoleNameUsersGet(ctx, realm, roleName).BriefRepresentation(briefRepresentation).First(first).Max(max).Execute()

Returns a stream of users that have the specified role name.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	roleName := "roleName_example" // string | the role name.
	briefRepresentation := true // bool | Boolean which defines whether brief representations are returned (default: false) (optional)
	first := int32(56) // int32 | first result to return. Ignored if negative or {@code null}. (optional)
	max := int32(56) // int32 | maximum number of results to return. Ignored if negative or {@code null}. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RolesAPI.AdminRealmsRealmRolesRoleNameUsersGet(context.Background(), realm, roleName).BriefRepresentation(briefRepresentation).First(first).Max(max).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RolesAPI.AdminRealmsRealmRolesRoleNameUsersGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmRolesRoleNameUsersGet`: []UserRepresentation
	fmt.Fprintf(os.Stdout, "Response from `RolesAPI.AdminRealmsRealmRolesRoleNameUsersGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
roleName	string	the role name.

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmRolesRoleNameUsersGetRequest struct via the builder pattern

Name	Type	Description	Notes

briefRepresentation | bool | Boolean which defines whether brief representations are returned (default: false) | first | int32 | first result to return. Ignored if negative or {@code null}. | max | int32 | maximum number of results to return. Ignored if negative or {@code null}. |

Return type

[]UserRepresentation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

RolesAPI.md

Latest commit

History

RolesAPI.md

File metadata and controls

\RolesAPI

AdminRealmsRealmClientsClientUuidRolesGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet

Example

Path Parameters