Go API client for openapi

This is a REST API reference for the Keycloak Admin REST API.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0
• Package version: 1.0.0
• Generator version: 7.12.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.keycloak.org/documentation

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://keycloak.example.com/admin/realms

Class	Method	HTTP request	Description
AttackDetectionAPI	DeleteBruteForceUser	Delete /{realm}/attack-detection/brute-force/users/{userId}
AttackDetectionAPI	DeleteUsers	Delete /{realm}/attack-detection/brute-force/users
AttackDetectionAPI	GetBruteForceUser	Get /{realm}/attack-detection/brute-force/users/{userId}
AuthenticationManagementAPI	DeleteConfig	Delete /{realm}/authentication/config/{id}
AuthenticationManagementAPI	DeleteExecution	Delete /{realm}/authentication/executions/{executionId}
AuthenticationManagementAPI	DeleteFlow	Delete /{realm}/authentication/flows/{id}
AuthenticationManagementAPI	DeleteRequiredAction	Delete /{realm}/authentication/required-actions/{alias}
AuthenticationManagementAPI	GetAuthenticationConfig	Get /{realm}/authentication/config/{id}
AuthenticationManagementAPI	GetAuthenticatorProviders	Get /{realm}/authentication/authenticator-providers
AuthenticationManagementAPI	GetClientAuthenticatorProviders	Get /{realm}/authentication/client-authenticator-providers
AuthenticationManagementAPI	GetConfigDescription	Get /{realm}/authentication/config-description/{providerId}
AuthenticationManagementAPI	GetExecution	Get /{realm}/authentication/executions/{executionId}
AuthenticationManagementAPI	GetExecutionConfig	Get /{realm}/authentication/executions/{executionId}/config/{id}
AuthenticationManagementAPI	GetExecutions	Get /{realm}/authentication/flows/{flowAlias}/executions
AuthenticationManagementAPI	GetFlow	Get /{realm}/authentication/flows/{id}
AuthenticationManagementAPI	GetFlows	Get /{realm}/authentication/flows
AuthenticationManagementAPI	GetFormActionProviders	Get /{realm}/authentication/form-action-providers
AuthenticationManagementAPI	GetFormProviders	Get /{realm}/authentication/form-providers
AuthenticationManagementAPI	GetPerClientConfigDescription	Get /{realm}/authentication/per-client-config-description
AuthenticationManagementAPI	GetRequiredAction	Get /{realm}/authentication/required-actions/{alias}
AuthenticationManagementAPI	GetRequiredActions	Get /{realm}/authentication/required-actions
AuthenticationManagementAPI	GetUnregisteredRequiredActions	Get /{realm}/authentication/unregistered-required-actions
AuthenticationManagementAPI	PostAuthenticationConfig	Post /{realm}/authentication/config
AuthenticationManagementAPI	PostCopy	Post /{realm}/authentication/flows/{flowAlias}/copy
AuthenticationManagementAPI	PostExecution	Post /{realm}/authentication/flows/{flowAlias}/executions/execution
AuthenticationManagementAPI	PostExecutionConfig	Post /{realm}/authentication/executions/{executionId}/config
AuthenticationManagementAPI	PostExecutionLowerPriority	Post /{realm}/authentication/executions/{executionId}/lower-priority
AuthenticationManagementAPI	PostExecutionRaisePriority	Post /{realm}/authentication/executions/{executionId}/raise-priority
AuthenticationManagementAPI	PostExecutions	Post /{realm}/authentication/executions
AuthenticationManagementAPI	PostFlow	Post /{realm}/authentication/flows/{flowAlias}/executions/flow
AuthenticationManagementAPI	PostFlows	Post /{realm}/authentication/flows
AuthenticationManagementAPI	PostRegisterRequiredAction	Post /{realm}/authentication/register-required-action
AuthenticationManagementAPI	PostRequiredActionLowerPriority	Post /{realm}/authentication/required-actions/{alias}/lower-priority
AuthenticationManagementAPI	PostRequiredActionRaisePriority	Post /{realm}/authentication/required-actions/{alias}/raise-priority
AuthenticationManagementAPI	PutAuthenticationConfig	Put /{realm}/authentication/config/{id}
AuthenticationManagementAPI	PutExecutions	Put /{realm}/authentication/flows/{flowAlias}/executions
AuthenticationManagementAPI	PutFlow	Put /{realm}/authentication/flows/{id}
AuthenticationManagementAPI	PutRequiredAction	Put /{realm}/authentication/required-actions/{alias}
ClientAttributeCertificateAPI	GetCertificate	Get /{realm}/clients/{id}/certificates/{attr}
ClientAttributeCertificateAPI	PostDownload	Post /{realm}/clients/{id}/certificates/{attr}/download
ClientAttributeCertificateAPI	PostGenerate	Post /{realm}/clients/{id}/certificates/{attr}/generate
ClientAttributeCertificateAPI	PostGenerateAndDownload	Post /{realm}/clients/{id}/certificates/{attr}/generate-and-download
ClientAttributeCertificateAPI	PostUpload	Post /{realm}/clients/{id}/certificates/{attr}/upload
ClientAttributeCertificateAPI	PostUploadCertificate	Post /{realm}/clients/{id}/certificates/{attr}/upload-certificate
ClientInitialAccessAPI	DeleteClientsInitialAcces	Delete /{realm}/clients-initial-access/{id}
ClientInitialAccessAPI	GetClientsInitialAccess	Get /{realm}/clients-initial-access
ClientInitialAccessAPI	PostClientsInitialAccess	Post /{realm}/clients-initial-access
ClientRegistrationPolicyAPI	GetProviders	Get /{realm}/client-registration-policy/providers
ClientRoleMappingsAPI	DeleteGroupRoleMappingsClient	Delete /{realm}/groups/{id}/role-mappings/clients/{client}
ClientRoleMappingsAPI	DeleteUserRoleMappingsClient	Delete /{realm}/users/{id}/role-mappings/clients/{client}
ClientRoleMappingsAPI	GetGroupRoleMappingsClient	Get /{realm}/groups/{id}/role-mappings/clients/{client}
ClientRoleMappingsAPI	GetGroupRoleMappingsClientAvailable	Get /{realm}/groups/{id}/role-mappings/clients/{client}/available
ClientRoleMappingsAPI	GetGroupRoleMappingsClientComposite	Get /{realm}/groups/{id}/role-mappings/clients/{client}/composite
ClientRoleMappingsAPI	GetUserRoleMappingsClient	Get /{realm}/users/{id}/role-mappings/clients/{client}
ClientRoleMappingsAPI	GetUserRoleMappingsClientAvailable	Get /{realm}/users/{id}/role-mappings/clients/{client}/available
ClientRoleMappingsAPI	GetUserRoleMappingsClientComposite	Get /{realm}/users/{id}/role-mappings/clients/{client}/composite
ClientRoleMappingsAPI	PostGroupRoleMappingsClient	Post /{realm}/groups/{id}/role-mappings/clients/{client}
ClientRoleMappingsAPI	PostUserRoleMappingsClient	Post /{realm}/users/{id}/role-mappings/clients/{client}
ClientScopesAPI	DeleteClientScope	Delete /{realm}/client-scopes/{id}
ClientScopesAPI	DeleteClientTemplate	Delete /{realm}/client-templates/{id}
ClientScopesAPI	GetClientScope	Get /{realm}/client-scopes/{id}
ClientScopesAPI	GetClientScopes	Get /{realm}/client-scopes
ClientScopesAPI	GetClientTemplate	Get /{realm}/client-templates/{id}
ClientScopesAPI	GetClientTemplates	Get /{realm}/client-templates
ClientScopesAPI	PostClientScopes	Post /{realm}/client-scopes
ClientScopesAPI	PostClientTemplates	Post /{realm}/client-templates
ClientScopesAPI	PutClientScope	Put /{realm}/client-scopes/{id}
ClientScopesAPI	PutClientTemplate	Put /{realm}/client-templates/{id}
ClientsAPI	DeleteClientByRealmById	Delete /{realm}/clients/{id}
ClientsAPI	DeleteDefaultClientScope	Delete /{realm}/clients/{id}/default-client-scopes/{clientScopeId}
ClientsAPI	DeleteNode	Delete /{realm}/clients/{id}/nodes/{node}
ClientsAPI	DeleteOptionalClientScope	Delete /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}
ClientsAPI	DeleteRotated	Delete /{realm}/clients/{id}/client-secret/rotated
ClientsAPI	GetClientByRealmById	Get /{realm}/clients/{id}
ClientsAPI	GetClientManagementPermissions	Get /{realm}/clients/{id}/management/permissions
ClientsAPI	GetClientSecret	Get /{realm}/clients/{id}/client-secret
ClientsAPI	GetClientUserSessions	Get /{realm}/clients/{id}/user-sessions
ClientsAPI	GetClients	Get /{realm}/clients
ClientsAPI	GetDefaultClientScopes	Get /{realm}/clients/{id}/default-client-scopes
ClientsAPI	GetGenerateExampleAccessToken	Get /{realm}/clients/{id}/evaluate-scopes/generate-example-access-token
ClientsAPI	GetGenerateExampleIdToken	Get /{realm}/clients/{id}/evaluate-scopes/generate-example-id-token
ClientsAPI	GetGenerateExampleUserinfo	Get /{realm}/clients/{id}/evaluate-scopes/generate-example-userinfo
ClientsAPI	GetGranted	Get /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/granted
ClientsAPI	GetInstallationProvider	Get /{realm}/clients/{id}/installation/providers/{providerId}
ClientsAPI	GetNotGranted	Get /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted
ClientsAPI	GetOfflineSessionCount	Get /{realm}/clients/{id}/offline-session-count
ClientsAPI	GetOfflineSessions	Get /{realm}/clients/{id}/offline-sessions
ClientsAPI	GetOptionalClientScopes	Get /{realm}/clients/{id}/optional-client-scopes
ClientsAPI	GetProtocolMappers	Get /{realm}/clients/{id}/evaluate-scopes/protocol-mappers
ClientsAPI	GetRotated	Get /{realm}/clients/{id}/client-secret/rotated
ClientsAPI	GetServiceAccountUser	Get /{realm}/clients/{id}/service-account-user
ClientsAPI	GetSessionCount	Get /{realm}/clients/{id}/session-count
ClientsAPI	GetTestNodesAvailable	Get /{realm}/clients/{id}/test-nodes-available
ClientsAPI	PostClientPushRevocation	Post /{realm}/clients/{id}/push-revocation
ClientsAPI	PostClientSecret	Post /{realm}/clients/{id}/client-secret
ClientsAPI	PostClients	Post /{realm}/clients
ClientsAPI	PostNodes	Post /{realm}/clients/{id}/nodes
ClientsAPI	PostRegistrationAccessToken	Post /{realm}/clients/{id}/registration-access-token
ClientsAPI	PutClient	Put /{realm}/clients/{id}
ClientsAPI	PutClientManagementPermissions	Put /{realm}/clients/{id}/management/permissions
ClientsAPI	PutDefaultClientScope	Put /{realm}/clients/{id}/default-client-scopes/{clientScopeId}
ClientsAPI	PutOptionalClientScope	Put /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}
ComponentAPI	DeleteComponent	Delete /{realm}/components/{id}
ComponentAPI	GetComponent	Get /{realm}/components/{id}
ComponentAPI	GetComponents	Get /{realm}/components
ComponentAPI	GetSubComponentTypes	Get /{realm}/components/{id}/sub-component-types
ComponentAPI	PostComponents	Post /{realm}/components
ComponentAPI	PutComponent	Put /{realm}/components/{id}
GroupsAPI	DeleteGroupByRealmById	Delete /{realm}/groups/{id}
GroupsAPI	GetChildren	Get /{realm}/groups/{id}/children
GroupsAPI	GetGroup	Get /{realm}/groups/{id}
GroupsAPI	GetGroupManagementPermissions	Get /{realm}/groups/{id}/management/permissions
GroupsAPI	GetGroupsByRealm	Get /{realm}/groups
GroupsAPI	GetGroupsCountByRealm	Get /{realm}/groups/count
GroupsAPI	GetMembers	Get /{realm}/groups/{id}/members
GroupsAPI	PostChildren	Post /{realm}/groups/{id}/children
GroupsAPI	PostGroups	Post /{realm}/groups
GroupsAPI	PutGroupByRealmById	Put /{realm}/groups/{id}
GroupsAPI	PutGroupManagementPermissions	Put /{realm}/groups/{id}/management/permissions
IdentityProvidersAPI	DeleteInstance	Delete /{realm}/identity-provider/instances/{alias}
IdentityProvidersAPI	DeleteMapper	Delete /{realm}/identity-provider/instances/{alias}/mappers/{id}
IdentityProvidersAPI	GetExport	Get /{realm}/identity-provider/instances/{alias}/export
IdentityProvidersAPI	GetIdentityProviderProvider	Get /{realm}/identity-provider/providers/{provider_id}
IdentityProvidersAPI	GetInstance	Get /{realm}/identity-provider/instances/{alias}
IdentityProvidersAPI	GetInstanceManagementPermissions	Get /{realm}/identity-provider/instances/{alias}/management/permissions
IdentityProvidersAPI	GetInstances	Get /{realm}/identity-provider/instances
IdentityProvidersAPI	GetMapper	Get /{realm}/identity-provider/instances/{alias}/mappers/{id}
IdentityProvidersAPI	GetMapperTypes	Get /{realm}/identity-provider/instances/{alias}/mapper-types
IdentityProvidersAPI	GetMappers	Get /{realm}/identity-provider/instances/{alias}/mappers
IdentityProvidersAPI	PostImportConfig	Post /{realm}/identity-provider/import-config
IdentityProvidersAPI	PostInstances	Post /{realm}/identity-provider/instances
IdentityProvidersAPI	PostMappers	Post /{realm}/identity-provider/instances/{alias}/mappers
IdentityProvidersAPI	PutInstance	Put /{realm}/identity-provider/instances/{alias}
IdentityProvidersAPI	PutInstanceManagementPermissions	Put /{realm}/identity-provider/instances/{alias}/management/permissions
IdentityProvidersAPI	PutMapper	Put /{realm}/identity-provider/instances/{alias}/mappers/{id}
KeyAPI	GetKeys	Get /{realm}/keys
ProtocolMappersAPI	DeleteClientProtocolMappersModel	Delete /{realm}/clients/{id1}/protocol-mappers/models/{id2}
ProtocolMappersAPI	DeleteClientScopeProtocolMappersModel	Delete /{realm}/client-scopes/{id1}/protocol-mappers/models/{id2}
ProtocolMappersAPI	DeleteClientTemplateProtocolMappersModel	Delete /{realm}/client-templates/{id1}/protocol-mappers/models/{id2}
ProtocolMappersAPI	GetClientProtocolMappersModel	Get /{realm}/clients/{id1}/protocol-mappers/models/{id2}
ProtocolMappersAPI	GetClientProtocolMappersModels	Get /{realm}/clients/{id}/protocol-mappers/models
ProtocolMappersAPI	GetClientProtocolMappersProtocol	Get /{realm}/clients/{id}/protocol-mappers/protocol/{protocol}
ProtocolMappersAPI	GetClientScopeProtocolMappersModel	Get /{realm}/client-scopes/{id1}/protocol-mappers/models/{id2}
ProtocolMappersAPI	GetClientScopeProtocolMappersModels	Get /{realm}/client-scopes/{id}/protocol-mappers/models
ProtocolMappersAPI	GetClientScopeProtocolMappersProtocol	Get /{realm}/client-scopes/{id}/protocol-mappers/protocol/{protocol}
ProtocolMappersAPI	GetClientTemplateProtocolMappersModel	Get /{realm}/client-templates/{id1}/protocol-mappers/models/{id2}
ProtocolMappersAPI	GetClientTemplateProtocolMappersModels	Get /{realm}/client-templates/{id}/protocol-mappers/models
ProtocolMappersAPI	GetClientTemplateProtocolMappersProtocol	Get /{realm}/client-templates/{id}/protocol-mappers/protocol/{protocol}
ProtocolMappersAPI	PostClientProtocolMappersAddModels	Post /{realm}/clients/{id}/protocol-mappers/add-models
ProtocolMappersAPI	PostClientProtocolMappersModels	Post /{realm}/clients/{id}/protocol-mappers/models
ProtocolMappersAPI	PostClientScopeProtocolMappersAddModels	Post /{realm}/client-scopes/{id}/protocol-mappers/add-models
ProtocolMappersAPI	PostClientScopeProtocolMappersModels	Post /{realm}/client-scopes/{id}/protocol-mappers/models
ProtocolMappersAPI	PostClientTemplateProtocolMappersAddModels	Post /{realm}/client-templates/{id}/protocol-mappers/add-models
ProtocolMappersAPI	PostClientTemplateProtocolMappersModels	Post /{realm}/client-templates/{id}/protocol-mappers/models
ProtocolMappersAPI	PutClientProtocolMappersModel	Put /{realm}/clients/{id1}/protocol-mappers/models/{id2}
ProtocolMappersAPI	PutClientScopeProtocolMappersModel	Put /{realm}/client-scopes/{id1}/protocol-mappers/models/{id2}
ProtocolMappersAPI	PutClientTemplateProtocolMappersModel	Put /{realm}/client-templates/{id1}/protocol-mappers/models/{id2}
RealmsAdminAPI	DeleteAdminEvents	Delete /{realm}/admin-events
RealmsAdminAPI	DeleteByRealm	Delete /{realm}
RealmsAdminAPI	DeleteDefaultDefaultClientScope	Delete /{realm}/default-default-client-scopes/{clientScopeId}
RealmsAdminAPI	DeleteDefaultGroup	Delete /{realm}/default-groups/{groupId}
RealmsAdminAPI	DeleteDefaultOptionalClientScope	Delete /{realm}/default-optional-client-scopes/{clientScopeId}
RealmsAdminAPI	DeleteEvents	Delete /{realm}/events
RealmsAdminAPI	DeleteLocalizationByRealmByLocale	Delete /{realm}/localization/{locale}
RealmsAdminAPI	DeleteLocalizationByRealmByLocaleByKey	Delete /{realm}/localization/{locale}/{key}
RealmsAdminAPI	DeleteSession	Delete /{realm}/sessions/{session}
RealmsAdminAPI	Get	Get /
RealmsAdminAPI	GetAdminEvents	Get /{realm}/admin-events
RealmsAdminAPI	GetByRealm	Get /{realm}
RealmsAdminAPI	GetClientSessionStats	Get /{realm}/client-session-stats
RealmsAdminAPI	GetCredentialRegistrators	Get /{realm}/credential-registrators
RealmsAdminAPI	GetDefaultDefaultClientScopes	Get /{realm}/default-default-client-scopes
RealmsAdminAPI	GetDefaultGroups	Get /{realm}/default-groups
RealmsAdminAPI	GetDefaultOptionalClientScopes	Get /{realm}/default-optional-client-scopes
RealmsAdminAPI	GetEvents	Get /{realm}/events
RealmsAdminAPI	GetEventsConfig	Get /{realm}/events/config
RealmsAdminAPI	GetGroupByPath	Get /{realm}/group-by-path/{path}
RealmsAdminAPI	GetLocalizationByRealm	Get /{realm}/localization
RealmsAdminAPI	GetLocalizationByRealmByLocale	Get /{realm}/localization/{locale}
RealmsAdminAPI	GetLocalizationByRealmByLocaleByKey	Get /{realm}/localization/{locale}/{key}
RealmsAdminAPI	GetPolicies	Get /{realm}/client-policies/policies
RealmsAdminAPI	GetProfiles	Get /{realm}/client-policies/profiles
RealmsAdminAPI	GetUsersManagementPermissions	Get /{realm}/users-management-permissions
RealmsAdminAPI	Post	Post /
RealmsAdminAPI	PostClientDescriptionConverter	Post /{realm}/client-description-converter
RealmsAdminAPI	PostLocalization	Post /{realm}/localization/{locale}
RealmsAdminAPI	PostLogoutAll	Post /{realm}/logout-all
RealmsAdminAPI	PostPartialExport	Post /{realm}/partial-export
RealmsAdminAPI	PostPartialImport	Post /{realm}/partialImport
RealmsAdminAPI	PostPushRevocationByRealm	Post /{realm}/push-revocation
RealmsAdminAPI	PostTestSmtpConnection	Post /{realm}/testSMTPConnection
RealmsAdminAPI	PutByRealm	Put /{realm}
RealmsAdminAPI	PutDefaultDefaultClientScope	Put /{realm}/default-default-client-scopes/{clientScopeId}
RealmsAdminAPI	PutDefaultGroup	Put /{realm}/default-groups/{groupId}
RealmsAdminAPI	PutDefaultOptionalClientScope	Put /{realm}/default-optional-client-scopes/{clientScopeId}
RealmsAdminAPI	PutEventsConfig	Put /{realm}/events/config
RealmsAdminAPI	PutLocalization	Put /{realm}/localization/{locale}/{key}
RealmsAdminAPI	PutPolicies	Put /{realm}/client-policies/policies
RealmsAdminAPI	PutProfiles	Put /{realm}/client-policies/profiles
RealmsAdminAPI	PutUsersManagementPermissions	Put /{realm}/users-management-permissions
RoleMapperAPI	DeleteGroupRoleMappingsRealm	Delete /{realm}/groups/{id}/role-mappings/realm
RoleMapperAPI	DeleteUserRoleMappingsRealm	Delete /{realm}/users/{id}/role-mappings/realm
RoleMapperAPI	GetGroupRoleMappings	Get /{realm}/groups/{id}/role-mappings
RoleMapperAPI	GetGroupRoleMappingsRealm	Get /{realm}/groups/{id}/role-mappings/realm
RoleMapperAPI	GetGroupRoleMappingsRealmAvailable	Get /{realm}/groups/{id}/role-mappings/realm/available
RoleMapperAPI	GetGroupRoleMappingsRealmComposite	Get /{realm}/groups/{id}/role-mappings/realm/composite
RoleMapperAPI	GetUserRoleMappings	Get /{realm}/users/{id}/role-mappings
RoleMapperAPI	GetUserRoleMappingsRealm	Get /{realm}/users/{id}/role-mappings/realm
RoleMapperAPI	GetUserRoleMappingsRealmAvailable	Get /{realm}/users/{id}/role-mappings/realm/available
RoleMapperAPI	GetUserRoleMappingsRealmComposite	Get /{realm}/users/{id}/role-mappings/realm/composite
RoleMapperAPI	PostGroupRoleMappingsRealm	Post /{realm}/groups/{id}/role-mappings/realm
RoleMapperAPI	PostUserRoleMappingsRealm	Post /{realm}/users/{id}/role-mappings/realm
RolesAPI	DeleteClientRole	Delete /{realm}/clients/{id}/roles/{role-name}
RolesAPI	DeleteClientRoleComposites	Delete /{realm}/clients/{id}/roles/{role-name}/composites
RolesAPI	DeleteRoleByRealmByRoleName	Delete /{realm}/roles/{role-name}
RolesAPI	DeleteRoleCompositesByRealmByRoleName	Delete /{realm}/roles/{role-name}/composites
RolesAPI	GetClientRole	Get /{realm}/clients/{id}/roles/{role-name}
RolesAPI	GetClientRoleComposites	Get /{realm}/clients/{id}/roles/{role-name}/composites
RolesAPI	GetClientRoleCompositesClient	Get /{realm}/clients/{id}/roles/{role-name}/composites/clients/{clientUuid}
RolesAPI	GetClientRoleCompositesRealm	Get /{realm}/clients/{id}/roles/{role-name}/composites/realm
RolesAPI	GetClientRoleGroups	Get /{realm}/clients/{id}/roles/{role-name}/groups
RolesAPI	GetClientRoleManagementPermissions	Get /{realm}/clients/{id}/roles/{role-name}/management/permissions
RolesAPI	GetClientRoleUsers	Get /{realm}/clients/{id}/roles/{role-name}/users
RolesAPI	GetClientRoles	Get /{realm}/clients/{id}/roles
RolesAPI	GetRoleByRealmByRoleName	Get /{realm}/roles/{role-name}
RolesAPI	GetRoleCompositesByRealmByRoleName	Get /{realm}/roles/{role-name}/composites
RolesAPI	GetRoleCompositesClientByRealmByRoleNameByClientUuid	Get /{realm}/roles/{role-name}/composites/clients/{clientUuid}
RolesAPI	GetRoleCompositesRealmByRealmByRoleName	Get /{realm}/roles/{role-name}/composites/realm
RolesAPI	GetRoleGroupsByRealmByRoleName	Get /{realm}/roles/{role-name}/groups
RolesAPI	GetRoleManagementPermissionsByRealmByRoleName	Get /{realm}/roles/{role-name}/management/permissions
RolesAPI	GetRoleUsersByRealmByRoleName	Get /{realm}/roles/{role-name}/users
RolesAPI	GetRolesByRealm	Get /{realm}/roles
RolesAPI	PostClientRoleComposites	Post /{realm}/clients/{id}/roles/{role-name}/composites
RolesAPI	PostClientRoles	Post /{realm}/clients/{id}/roles
RolesAPI	PostRoleCompositesByRealmByRoleName	Post /{realm}/roles/{role-name}/composites
RolesAPI	PostRolesByRealm	Post /{realm}/roles
RolesAPI	PutClientRole	Put /{realm}/clients/{id}/roles/{role-name}
RolesAPI	PutClientRoleManagementPermissions	Put /{realm}/clients/{id}/roles/{role-name}/management/permissions
RolesAPI	PutRoleByRealmByRoleName	Put /{realm}/roles/{role-name}
RolesAPI	PutRoleManagementPermissionsByRealmByRoleName	Put /{realm}/roles/{role-name}/management/permissions
RolesByIDAPI	DeleteRolesById	Delete /{realm}/roles-by-id/{role-id}
RolesByIDAPI	DeleteRolesByIdComposites	Delete /{realm}/roles-by-id/{role-id}/composites
RolesByIDAPI	GetRolesById	Get /{realm}/roles-by-id/{role-id}
RolesByIDAPI	GetRolesByIdComposites	Get /{realm}/roles-by-id/{role-id}/composites
RolesByIDAPI	GetRolesByIdCompositesClient	Get /{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}
RolesByIDAPI	GetRolesByIdCompositesRealm	Get /{realm}/roles-by-id/{role-id}/composites/realm
RolesByIDAPI	GetRolesByIdManagementPermissions	Get /{realm}/roles-by-id/{role-id}/management/permissions
RolesByIDAPI	PostRolesByIdComposites	Post /{realm}/roles-by-id/{role-id}/composites
RolesByIDAPI	PutRolesById	Put /{realm}/roles-by-id/{role-id}
RolesByIDAPI	PutRolesByIdManagementPermissions	Put /{realm}/roles-by-id/{role-id}/management/permissions
ScopeMappingsAPI	DeleteClientScopeMappingsClient	Delete /{realm}/clients/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	DeleteClientScopeMappingsRealm	Delete /{realm}/clients/{id}/scope-mappings/realm
ScopeMappingsAPI	DeleteClientScopeScopeMappingsClient	Delete /{realm}/client-scopes/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	DeleteClientScopeScopeMappingsRealm	Delete /{realm}/client-scopes/{id}/scope-mappings/realm
ScopeMappingsAPI	DeleteClientTemplateScopeMappingsClient	Delete /{realm}/client-templates/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	DeleteClientTemplateScopeMappingsRealm	Delete /{realm}/client-templates/{id}/scope-mappings/realm
ScopeMappingsAPI	GetClientScopeMappings	Get /{realm}/clients/{id}/scope-mappings
ScopeMappingsAPI	GetClientScopeMappingsClient	Get /{realm}/clients/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	GetClientScopeMappingsClientAvailable	Get /{realm}/clients/{id}/scope-mappings/clients/{client}/available
ScopeMappingsAPI	GetClientScopeMappingsClientComposite	Get /{realm}/clients/{id}/scope-mappings/clients/{client}/composite
ScopeMappingsAPI	GetClientScopeMappingsRealm	Get /{realm}/clients/{id}/scope-mappings/realm
ScopeMappingsAPI	GetClientScopeMappingsRealmAvailable	Get /{realm}/clients/{id}/scope-mappings/realm/available
ScopeMappingsAPI	GetClientScopeMappingsRealmComposite	Get /{realm}/clients/{id}/scope-mappings/realm/composite
ScopeMappingsAPI	GetClientScopeScopeMappings	Get /{realm}/client-scopes/{id}/scope-mappings
ScopeMappingsAPI	GetClientScopeScopeMappingsClient	Get /{realm}/client-scopes/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	GetClientScopeScopeMappingsClientAvailable	Get /{realm}/client-scopes/{id}/scope-mappings/clients/{client}/available
ScopeMappingsAPI	GetClientScopeScopeMappingsClientComposite	Get /{realm}/client-scopes/{id}/scope-mappings/clients/{client}/composite
ScopeMappingsAPI	GetClientScopeScopeMappingsRealm	Get /{realm}/client-scopes/{id}/scope-mappings/realm
ScopeMappingsAPI	GetClientScopeScopeMappingsRealmAvailable	Get /{realm}/client-scopes/{id}/scope-mappings/realm/available
ScopeMappingsAPI	GetClientScopeScopeMappingsRealmComposite	Get /{realm}/client-scopes/{id}/scope-mappings/realm/composite
ScopeMappingsAPI	GetClientTemplateScopeMappings	Get /{realm}/client-templates/{id}/scope-mappings
ScopeMappingsAPI	GetClientTemplateScopeMappingsClient	Get /{realm}/client-templates/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	GetClientTemplateScopeMappingsClientAvailable	Get /{realm}/client-templates/{id}/scope-mappings/clients/{client}/available
ScopeMappingsAPI	GetClientTemplateScopeMappingsClientComposite	Get /{realm}/client-templates/{id}/scope-mappings/clients/{client}/composite
ScopeMappingsAPI	GetClientTemplateScopeMappingsRealm	Get /{realm}/client-templates/{id}/scope-mappings/realm
ScopeMappingsAPI	GetClientTemplateScopeMappingsRealmAvailable	Get /{realm}/client-templates/{id}/scope-mappings/realm/available
ScopeMappingsAPI	GetClientTemplateScopeMappingsRealmComposite	Get /{realm}/client-templates/{id}/scope-mappings/realm/composite
ScopeMappingsAPI	PostClientScopeMappingsClient	Post /{realm}/clients/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	PostClientScopeMappingsRealm	Post /{realm}/clients/{id}/scope-mappings/realm
ScopeMappingsAPI	PostClientScopeScopeMappingsClient	Post /{realm}/client-scopes/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	PostClientScopeScopeMappingsRealm	Post /{realm}/client-scopes/{id}/scope-mappings/realm
ScopeMappingsAPI	PostClientTemplateScopeMappingsClient	Post /{realm}/client-templates/{id}/scope-mappings/clients/{client}
ScopeMappingsAPI	PostClientTemplateScopeMappingsRealm	Post /{realm}/client-templates/{id}/scope-mappings/realm
UsersAPI	DeleteConsent	Delete /{realm}/users/{id}/consents/{client}
UsersAPI	DeleteCredential	Delete /{realm}/users/{id}/credentials/{credentialId}
UsersAPI	DeleteFederatedIdentity	Delete /{realm}/users/{id}/federated-identity/{provider}
UsersAPI	DeleteUserByRealmById	Delete /{realm}/users/{id}
UsersAPI	DeleteUserGroup	Delete /{realm}/users/{id}/groups/{groupId}
UsersAPI	GetConfiguredUserStorageCredentialTypes	Get /{realm}/users/{id}/configured-user-storage-credential-types
UsersAPI	GetConsents	Get /{realm}/users/{id}/consents
UsersAPI	GetCredentials	Get /{realm}/users/{id}/credentials
UsersAPI	GetFederatedIdentity	Get /{realm}/users/{id}/federated-identity
UsersAPI	GetMetadata	Get /{realm}/users/profile/metadata
UsersAPI	GetOfflineSession	Get /{realm}/users/{id}/offline-sessions/{clientUuid}
UsersAPI	GetProfile	Get /{realm}/users/profile
UsersAPI	GetSessions	Get /{realm}/users/{id}/sessions
UsersAPI	GetUserByRealmById	Get /{realm}/users/{id}
UsersAPI	GetUserGroups	Get /{realm}/users/{id}/groups
UsersAPI	GetUserGroupsCount	Get /{realm}/users/{id}/groups/count
UsersAPI	GetUsersByRealm	Get /{realm}/users
UsersAPI	GetUsersCount	Get /{realm}/users/count
UsersAPI	PostFederatedIdentity	Post /{realm}/users/{id}/federated-identity/{provider}
UsersAPI	PostImpersonation	Post /{realm}/users/{id}/impersonation
UsersAPI	PostLogout	Post /{realm}/users/{id}/logout
UsersAPI	PostMoveAfter	Post /{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}
UsersAPI	PostMoveToFirst	Post /{realm}/users/{id}/credentials/{credentialId}/moveToFirst
UsersAPI	PostUsers	Post /{realm}/users
UsersAPI	PutDisableCredentialTypes	Put /{realm}/users/{id}/disable-credential-types
UsersAPI	PutExecuteActionsEmail	Put /{realm}/users/{id}/execute-actions-email
UsersAPI	PutProfile	Put /{realm}/users/profile
UsersAPI	PutResetPassword	Put /{realm}/users/{id}/reset-password
UsersAPI	PutResetPasswordEmail	Put /{realm}/users/{id}/reset-password-email
UsersAPI	PutSendVerifyEmail	Put /{realm}/users/{id}/send-verify-email
UsersAPI	PutUser	Put /{realm}/users/{id}
UsersAPI	PutUserGroup	Put /{realm}/users/{id}/groups/{groupId}
UsersAPI	PutUserLabel	Put /{realm}/users/{id}/credentials/{credentialId}/userLabel

Documentation For Models

• Access
• AccessToken
• AddressClaimSet
• AdminEventRepresentation
• ApplicationRepresentation
• ApplicationRepresentationClaims
• AuthDetailsRepresentation
• AuthenticationExecutionExportRepresentation
• AuthenticationExecutionInfoRepresentation
• AuthenticationExecutionRepresentation
• AuthenticationFlowRepresentation
• AuthenticatorConfigInfoRepresentation
• AuthenticatorConfigRepresentation
• Authorization
• CertificateRepresentation
• ClaimRepresentation
• ClientInitialAccessCreatePresentation
• ClientInitialAccessPresentation
• ClientMappingsRepresentation
• ClientPoliciesRepresentation
• ClientPolicyConditionRepresentation
• ClientPolicyExecutorRepresentation
• ClientPolicyRepresentation
• ClientProfileRepresentation
• ClientProfilesRepresentation
• ClientRepresentation
• ClientScopeRepresentation
• ClientTemplateRepresentation
• ComponentExportRepresentation
• ComponentRepresentation
• ComponentTypeRepresentation
• Composites
• ConfigPropertyRepresentation
• Confirmation
• CredentialRepresentation
• EventRepresentation
• FederatedIdentityRepresentation
• GlobalRequestResult
• GroupRepresentation
• IDToken
• IdentityProviderMapperRepresentation
• IdentityProviderMapperTypeRepresentation
• IdentityProviderRepresentation
• InstallationAdapterConfig
• KeyMetadataRepresentation
• KeyStoreConfig
• KeysMetadataRepresentation
• ManagementPermissionReference
• MappingsRepresentation
• MethodConfig
• OAuthClientRepresentation
• PathCacheConfig
• PathConfig
• PathSegment
• Permission
• PolicyEnforcerConfig
• PolicyRepresentation
• ProtocolMapperEvaluationRepresentation
• ProtocolMapperRepresentation
• PublishedRealmRepresentation
• RealmEventsConfigRepresentation
• RealmRepresentation
• RequiredActionProviderRepresentation
• ResourceOwnerRepresentation
• ResourceRepresentation
• ResourceRepresentationOwner
• ResourceServerRepresentation
• RoleRepresentation
• RolesRepresentation
• ScopeMappingRepresentation
• ScopeRepresentation
• SocialLinkRepresentation
• UPAttribute
• UPAttributePermissions
• UPAttributeRequired
• UPAttributeSelector
• UPConfig
• UPGroup
• UserConsentRepresentation
• UserFederationMapperRepresentation
• UserFederationProviderRepresentation
• UserProfileAttributeGroupMetadata
• UserProfileAttributeMetadata
• UserProfileMetadata
• UserRepresentation
• UserSessionRepresentation

Documentation For Authorization

Authentication schemes defined for the API:

access_token

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), openapi.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author