Skip to content

Latest commit

 

History

History
2447 lines (1597 loc) · 88.6 KB

ScopeMappingsAPI.md

File metadata and controls

2447 lines (1597 loc) · 88.6 KB

\ScopeMappingsAPI

All URIs are relative to http://localhost

Method HTTP request Description
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientAvailableGet Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}/available The available client-level roles Returns the roles for the client that can be associated with the client's scope
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientCompositeGet Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}/composite Get effective client roles Returns the roles for the client that are associated with the client's scope.
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientDelete Delete /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client} Remove client-level roles from the client's scope.
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientGet Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client} Get the roles associated with a client's scope Returns roles for the client.
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientPost Post /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client} Add client-level roles to the client's scope
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsGet Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings Get all scope mappings for the client
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmAvailableGet Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm/available Get realm-level roles that are available to attach to this client's scope
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmCompositeGet Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm/composite Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmDelete Delete /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm Remove a set of realm-level roles from the client's scope
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGet Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm Get realm-level roles associated with the client's scope
AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmPost Post /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm Add a set of realm-level roles to the client's scope
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientAvailableGet Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}/available The available client-level roles Returns the roles for the client that can be associated with the client's scope
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientCompositeGet Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}/composite Get effective client roles Returns the roles for the client that are associated with the client's scope.
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientDelete Delete /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client} Remove client-level roles from the client's scope.
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientGet Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client} Get the roles associated with a client's scope Returns roles for the client.
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientPost Post /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client} Add client-level roles to the client's scope
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsGet Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings Get all scope mappings for the client
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmAvailableGet Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm/available Get realm-level roles that are available to attach to this client's scope
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmCompositeGet Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm/composite Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmDelete Delete /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm Remove a set of realm-level roles from the client's scope
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGet Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm Get realm-level roles associated with the client's scope
AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmPost Post /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm Add a set of realm-level roles to the client's scope
AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientAvailableGet Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}/available The available client-level roles Returns the roles for the client that can be associated with the client's scope
AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientCompositeGet Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}/composite Get effective client roles Returns the roles for the client that are associated with the client's scope.
AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientDelete Delete /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client} Remove client-level roles from the client's scope.
AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientGet Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client} Get the roles associated with a client's scope Returns roles for the client.
AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientPost Post /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client} Add client-level roles to the client's scope
AdminRealmsRealmClientsClientUuidScopeMappingsGet Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings Get all scope mappings for the client
AdminRealmsRealmClientsClientUuidScopeMappingsRealmAvailableGet Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm/available Get realm-level roles that are available to attach to this client's scope
AdminRealmsRealmClientsClientUuidScopeMappingsRealmCompositeGet Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm/composite Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.
AdminRealmsRealmClientsClientUuidScopeMappingsRealmDelete Delete /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm Remove a set of realm-level roles from the client's scope
AdminRealmsRealmClientsClientUuidScopeMappingsRealmGet Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm Get realm-level roles associated with the client's scope
AdminRealmsRealmClientsClientUuidScopeMappingsRealmPost Post /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm Add a set of realm-level roles to the client's scope

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientAvailableGet

[]RoleRepresentation AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientAvailableGet(ctx, realm, clientScopeId, client).Execute()

The available client-level roles Returns the roles for the client that can be associated with the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientAvailableGet(context.Background(), realm, clientScopeId, client).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientAvailableGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientAvailableGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientAvailableGet`: %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!)
clientScopeId string
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientAvailableGetRequest 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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientCompositeGet

[]RoleRepresentation AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientCompositeGet(ctx, realm, clientScopeId, client).BriefRepresentation(briefRepresentation).Execute()

Get effective client roles Returns the roles for the client that are associated with the client's scope.

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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 
	briefRepresentation := true // bool | if false, return roles with their attributes (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientCompositeGet(context.Background(), realm, clientScopeId, client).BriefRepresentation(briefRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientCompositeGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientCompositeGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientCompositeGet`: %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!)
clientScopeId string
client string

Other Parameters

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

Name Type Description Notes

briefRepresentation | bool | if false, return roles with their attributes | [default to true]

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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientDelete

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientDelete(ctx, realm, clientScopeId, client).RoleRepresentation(roleRepresentation).Execute()

Remove client-level roles from the client's scope.

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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientDelete(context.Background(), realm, clientScopeId, client).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientDelete``: %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!)
clientScopeId string
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientDeleteRequest 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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientGet

[]RoleRepresentation AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientGet(ctx, realm, clientScopeId, client).Execute()

Get the roles associated with a client's scope Returns roles for the 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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientGet(context.Background(), realm, clientScopeId, client).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientGet`: %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!)
clientScopeId string
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientGetRequest 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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientPost

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientPost(ctx, realm, clientScopeId, client).RoleRepresentation(roleRepresentation).Execute()

Add client-level roles to the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientPost(context.Background(), realm, clientScopeId, client).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientPost``: %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!)
clientScopeId string
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientPostRequest 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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsGet

MappingsRepresentation AdminRealmsRealmClientScopesClientScopeIdScopeMappingsGet(ctx, realm, clientScopeId).Execute()

Get all scope mappings for the 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!)
	clientScopeId := "clientScopeId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsGet(context.Background(), realm, clientScopeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientScopesClientScopeIdScopeMappingsGet`: MappingsRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsGet`: %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!)
clientScopeId string

Other Parameters

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

Name Type Description Notes

Return type

MappingsRepresentation

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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmAvailableGet

[]RoleRepresentation AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmAvailableGet(ctx, realm, clientScopeId).Execute()

Get realm-level roles that are available to attach to this client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmAvailableGet(context.Background(), realm, clientScopeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmAvailableGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmAvailableGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmAvailableGet`: %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!)
clientScopeId string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmAvailableGetRequest 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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmCompositeGet

[]RoleRepresentation AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmCompositeGet(ctx, realm, clientScopeId).BriefRepresentation(briefRepresentation).Execute()

Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.

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!)
	clientScopeId := "clientScopeId_example" // string | 
	briefRepresentation := true // bool | if false, return roles with their attributes (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmCompositeGet(context.Background(), realm, clientScopeId).BriefRepresentation(briefRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmCompositeGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmCompositeGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmCompositeGet`: %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!)
clientScopeId string

Other Parameters

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

Name Type Description Notes

briefRepresentation | bool | if false, return roles with their attributes | [default to true]

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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmDelete

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmDelete(ctx, realm, clientScopeId).RoleRepresentation(roleRepresentation).Execute()

Remove a set of realm-level roles from the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmDelete(context.Background(), realm, clientScopeId).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmDelete``: %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!)
clientScopeId string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmDeleteRequest 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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGet

[]RoleRepresentation AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGet(ctx, realm, clientScopeId).Execute()

Get realm-level roles associated with the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGet(context.Background(), realm, clientScopeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGet`: %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!)
clientScopeId string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGetRequest 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]

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmPost

AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmPost(ctx, realm, clientScopeId).RoleRepresentation(roleRepresentation).Execute()

Add a set of realm-level roles to the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmPost(context.Background(), realm, clientScopeId).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmPost``: %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!)
clientScopeId string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmPostRequest 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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientAvailableGet

[]RoleRepresentation AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientAvailableGet(ctx, realm, clientScopeId, client).Execute()

The available client-level roles Returns the roles for the client that can be associated with the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientAvailableGet(context.Background(), realm, clientScopeId, client).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientAvailableGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientAvailableGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientAvailableGet`: %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!)
clientScopeId string
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientAvailableGetRequest 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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientCompositeGet

[]RoleRepresentation AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientCompositeGet(ctx, realm, clientScopeId, client).BriefRepresentation(briefRepresentation).Execute()

Get effective client roles Returns the roles for the client that are associated with the client's scope.

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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 
	briefRepresentation := true // bool | if false, return roles with their attributes (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientCompositeGet(context.Background(), realm, clientScopeId, client).BriefRepresentation(briefRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientCompositeGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientCompositeGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientCompositeGet`: %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!)
clientScopeId string
client string

Other Parameters

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

Name Type Description Notes

briefRepresentation | bool | if false, return roles with their attributes | [default to true]

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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientDelete

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientDelete(ctx, realm, clientScopeId, client).RoleRepresentation(roleRepresentation).Execute()

Remove client-level roles from the client's scope.

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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientDelete(context.Background(), realm, clientScopeId, client).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientDelete``: %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!)
clientScopeId string
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientDeleteRequest 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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientGet

[]RoleRepresentation AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientGet(ctx, realm, clientScopeId, client).Execute()

Get the roles associated with a client's scope Returns roles for the 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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientGet(context.Background(), realm, clientScopeId, client).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientGet`: %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!)
clientScopeId string
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientGetRequest 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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientPost

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientPost(ctx, realm, clientScopeId, client).RoleRepresentation(roleRepresentation).Execute()

Add client-level roles to the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 
	client := "client_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientPost(context.Background(), realm, clientScopeId, client).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientPost``: %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!)
clientScopeId string
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientPostRequest 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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsGet

MappingsRepresentation AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsGet(ctx, realm, clientScopeId).Execute()

Get all scope mappings for the 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!)
	clientScopeId := "clientScopeId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsGet(context.Background(), realm, clientScopeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsGet`: MappingsRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsGet`: %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!)
clientScopeId string

Other Parameters

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

Name Type Description Notes

Return type

MappingsRepresentation

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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmAvailableGet

[]RoleRepresentation AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmAvailableGet(ctx, realm, clientScopeId).Execute()

Get realm-level roles that are available to attach to this client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmAvailableGet(context.Background(), realm, clientScopeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmAvailableGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmAvailableGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmAvailableGet`: %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!)
clientScopeId string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmAvailableGetRequest 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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmCompositeGet

[]RoleRepresentation AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmCompositeGet(ctx, realm, clientScopeId).BriefRepresentation(briefRepresentation).Execute()

Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.

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!)
	clientScopeId := "clientScopeId_example" // string | 
	briefRepresentation := true // bool | if false, return roles with their attributes (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmCompositeGet(context.Background(), realm, clientScopeId).BriefRepresentation(briefRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmCompositeGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmCompositeGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmCompositeGet`: %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!)
clientScopeId string

Other Parameters

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

Name Type Description Notes

briefRepresentation | bool | if false, return roles with their attributes | [default to true]

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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmDelete

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmDelete(ctx, realm, clientScopeId).RoleRepresentation(roleRepresentation).Execute()

Remove a set of realm-level roles from the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmDelete(context.Background(), realm, clientScopeId).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmDelete``: %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!)
clientScopeId string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmDeleteRequest 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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGet

[]RoleRepresentation AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGet(ctx, realm, clientScopeId).Execute()

Get realm-level roles associated with the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGet(context.Background(), realm, clientScopeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGet`: %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!)
clientScopeId string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGetRequest 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]

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmPost

AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmPost(ctx, realm, clientScopeId).RoleRepresentation(roleRepresentation).Execute()

Add a set of realm-level roles to the client's scope

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!)
	clientScopeId := "clientScopeId_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmPost(context.Background(), realm, clientScopeId).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmPost``: %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!)
clientScopeId string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmPostRequest 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]

AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientAvailableGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientAvailableGet(ctx, realm, clientUuid, client).Execute()

The available client-level roles Returns the roles for the client that can be associated with the client's scope

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!)
	client := "client_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientAvailableGet(context.Background(), realm, clientUuid, client).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientAvailableGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientAvailableGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientAvailableGet`: %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!)
clientUuid string id of client (not client-id!)
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidScopeMappingsClientsClientAvailableGetRequest 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]

AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientCompositeGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientCompositeGet(ctx, realm, clientUuid, client).BriefRepresentation(briefRepresentation).Execute()

Get effective client roles Returns the roles for the client that are associated with the client's scope.

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!)
	client := "client_example" // string | 
	briefRepresentation := true // bool | if false, return roles with their attributes (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientCompositeGet(context.Background(), realm, clientUuid, client).BriefRepresentation(briefRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientCompositeGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientCompositeGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientCompositeGet`: %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!)
clientUuid string id of client (not client-id!)
client string

Other Parameters

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

Name Type Description Notes

briefRepresentation | bool | if false, return roles with their attributes | [default to true]

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]

AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientDelete

AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientDelete(ctx, realm, clientUuid, client).RoleRepresentation(roleRepresentation).Execute()

Remove client-level roles from the client's scope.

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!)
	client := "client_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientDelete(context.Background(), realm, clientUuid, client).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientDelete``: %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!)
clientUuid string id of client (not client-id!)
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidScopeMappingsClientsClientDeleteRequest 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]

AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientGet(ctx, realm, clientUuid, client).Execute()

Get the roles associated with a client's scope Returns roles for the 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!)
	client := "client_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientGet(context.Background(), realm, clientUuid, client).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientGet`: %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!)
clientUuid string id of client (not client-id!)
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidScopeMappingsClientsClientGetRequest 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]

AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientPost

AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientPost(ctx, realm, clientUuid, client).RoleRepresentation(roleRepresentation).Execute()

Add client-level roles to the client's scope

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!)
	client := "client_example" // string | 
	roleRepresentation := []openapiclient.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientPost(context.Background(), realm, clientUuid, client).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientPost``: %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!)
clientUuid string id of client (not client-id!)
client string

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidScopeMappingsClientsClientPostRequest 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]

AdminRealmsRealmClientsClientUuidScopeMappingsGet

MappingsRepresentation AdminRealmsRealmClientsClientUuidScopeMappingsGet(ctx, realm, clientUuid).Execute()

Get all scope mappings for the 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!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsGet(context.Background(), realm, clientUuid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidScopeMappingsGet`: MappingsRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsGet`: %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!)
clientUuid string id of client (not client-id!)

Other Parameters

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

Name Type Description Notes

Return type

MappingsRepresentation

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]

AdminRealmsRealmClientsClientUuidScopeMappingsRealmAvailableGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidScopeMappingsRealmAvailableGet(ctx, realm, clientUuid).Execute()

Get realm-level roles that are available to attach to this client's scope

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!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmAvailableGet(context.Background(), realm, clientUuid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmAvailableGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidScopeMappingsRealmAvailableGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmAvailableGet`: %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!)
clientUuid string id of client (not client-id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidScopeMappingsRealmAvailableGetRequest 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]

AdminRealmsRealmClientsClientUuidScopeMappingsRealmCompositeGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidScopeMappingsRealmCompositeGet(ctx, realm, clientUuid).BriefRepresentation(briefRepresentation).Execute()

Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.

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 | if false, return roles with their attributes (optional) (default to true)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmCompositeGet(context.Background(), realm, clientUuid).BriefRepresentation(briefRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmCompositeGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidScopeMappingsRealmCompositeGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmCompositeGet`: %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!)
clientUuid string id of client (not client-id!)

Other Parameters

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

Name Type Description Notes

briefRepresentation | bool | if false, return roles with their attributes | [default to true]

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]

AdminRealmsRealmClientsClientUuidScopeMappingsRealmDelete

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

Remove a set of realm-level roles from the client's scope

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.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmDelete(context.Background(), realm, clientUuid).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmDelete``: %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!)
clientUuid string id of client (not client-id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidScopeMappingsRealmDeleteRequest 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]

AdminRealmsRealmClientsClientUuidScopeMappingsRealmGet

[]RoleRepresentation AdminRealmsRealmClientsClientUuidScopeMappingsRealmGet(ctx, realm, clientUuid).Execute()

Get realm-level roles associated with the client's scope

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!)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmGet(context.Background(), realm, clientUuid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AdminRealmsRealmClientsClientUuidScopeMappingsRealmGet`: []RoleRepresentation
	fmt.Fprintf(os.Stdout, "Response from `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmGet`: %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!)
clientUuid string id of client (not client-id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidScopeMappingsRealmGetRequest 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]

AdminRealmsRealmClientsClientUuidScopeMappingsRealmPost

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

Add a set of realm-level roles to the client's scope

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.RoleRepresentation{*openapiclient.NewRoleRepresentation()} // []RoleRepresentation |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmPost(context.Background(), realm, clientUuid).RoleRepresentation(roleRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ScopeMappingsAPI.AdminRealmsRealmClientsClientUuidScopeMappingsRealmPost``: %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!)
clientUuid string id of client (not client-id!)

Other Parameters

Other parameters are passed through a pointer to a apiAdminRealmsRealmClientsClientUuidScopeMappingsRealmPostRequest 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]