This is a REST API reference for the Keycloak Admin REST API.
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.9.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
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 keycloak_admin_client "github.com/daytonaio/daytona-ee-draft/pkg/keycloak-admin-client"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
For using other server than the one defined on index 0 set context value keycloak_admin_client.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), keycloak_admin_client.ContextServerIndex, 1)
Templated server URL is formatted using default variables from configuration or from context value keycloak_admin_client.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), keycloak_admin_client.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
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 keycloak_admin_client.ContextOperationServerIndices
and keycloak_admin_client.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), keycloak_admin_client.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), keycloak_admin_client.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
AttackDetectionAPI | AdminRealmsRealmAttackDetectionBruteForceUsersDelete | Delete /admin/realms/{realm}/attack-detection/brute-force/users | Clear any user login failures for all users This can release temporary disabled users |
AttackDetectionAPI | AdminRealmsRealmAttackDetectionBruteForceUsersUserIdDelete | Delete /admin/realms/{realm}/attack-detection/brute-force/users/{userId} | Clear any user login failures for the user This can release temporary disabled user |
AttackDetectionAPI | AdminRealmsRealmAttackDetectionBruteForceUsersUserIdGet | Get /admin/realms/{realm}/attack-detection/brute-force/users/{userId} | Get status of a username in brute force detection |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationAuthenticatorProvidersGet | Get /admin/realms/{realm}/authentication/authenticator-providers | Get authenticator providers Returns a stream of authenticator providers. |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationClientAuthenticatorProvidersGet | Get /admin/realms/{realm}/authentication/client-authenticator-providers | Get client authenticator providers Returns a stream of client authenticator providers. |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationConfigDescriptionProviderIdGet | Get /admin/realms/{realm}/authentication/config-description/{providerId} | Get authenticator provider's configuration description |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationConfigIdDelete | Delete /admin/realms/{realm}/authentication/config/{id} | Delete authenticator configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationConfigIdGet | Get /admin/realms/{realm}/authentication/config/{id} | Get authenticator configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationConfigIdPut | Put /admin/realms/{realm}/authentication/config/{id} | Update authenticator configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationConfigPost | Post /admin/realms/{realm}/authentication/config | Create new authenticator configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationExecutionsExecutionIdConfigIdGet | Get /admin/realms/{realm}/authentication/executions/{executionId}/config/{id} | Get execution's configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationExecutionsExecutionIdConfigPost | Post /admin/realms/{realm}/authentication/executions/{executionId}/config | Update execution with new configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationExecutionsExecutionIdDelete | Delete /admin/realms/{realm}/authentication/executions/{executionId} | Delete execution |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationExecutionsExecutionIdGet | Get /admin/realms/{realm}/authentication/executions/{executionId} | Get Single Execution |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationExecutionsExecutionIdLowerPriorityPost | Post /admin/realms/{realm}/authentication/executions/{executionId}/lower-priority | Lower execution's priority |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationExecutionsExecutionIdRaisePriorityPost | Post /admin/realms/{realm}/authentication/executions/{executionId}/raise-priority | Raise execution's priority |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationExecutionsPost | Post /admin/realms/{realm}/authentication/executions | Add new authentication execution |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsFlowAliasCopyPost | Post /admin/realms/{realm}/authentication/flows/{flowAlias}/copy | Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsFlowAliasExecutionsExecutionPost | Post /admin/realms/{realm}/authentication/flows/{flowAlias}/executions/execution | Add new authentication execution to a flow |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsFlowAliasExecutionsFlowPost | Post /admin/realms/{realm}/authentication/flows/{flowAlias}/executions/flow | Add new flow with new execution to existing flow |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsFlowAliasExecutionsGet | Get /admin/realms/{realm}/authentication/flows/{flowAlias}/executions | Get authentication executions for a flow |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsFlowAliasExecutionsPut | Put /admin/realms/{realm}/authentication/flows/{flowAlias}/executions | Update authentication executions of a Flow |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsGet | Get /admin/realms/{realm}/authentication/flows | Get authentication flows Returns a stream of authentication flows. |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsIdDelete | Delete /admin/realms/{realm}/authentication/flows/{id} | Delete an authentication flow |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsIdGet | Get /admin/realms/{realm}/authentication/flows/{id} | Get authentication flow for id |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsIdPut | Put /admin/realms/{realm}/authentication/flows/{id} | Update an authentication flow |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFlowsPost | Post /admin/realms/{realm}/authentication/flows | Create a new authentication flow |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFormActionProvidersGet | Get /admin/realms/{realm}/authentication/form-action-providers | Get form action providers Returns a stream of form action providers. |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationFormProvidersGet | Get /admin/realms/{realm}/authentication/form-providers | Get form providers Returns a stream of form providers. |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationPerClientConfigDescriptionGet | Get /admin/realms/{realm}/authentication/per-client-config-description | Get configuration descriptions for all clients |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRegisterRequiredActionPost | Post /admin/realms/{realm}/authentication/register-required-action | Register a new required actions |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasConfigDelete | Delete /admin/realms/{realm}/authentication/required-actions/{alias}/config | Delete RequiredAction configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasConfigDescriptionGet | Get /admin/realms/{realm}/authentication/required-actions/{alias}/config-description | Get RequiredAction provider configuration description |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasConfigGet | Get /admin/realms/{realm}/authentication/required-actions/{alias}/config | Get RequiredAction configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasConfigPut | Put /admin/realms/{realm}/authentication/required-actions/{alias}/config | Update RequiredAction configuration |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasDelete | Delete /admin/realms/{realm}/authentication/required-actions/{alias} | Delete required action |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasGet | Get /admin/realms/{realm}/authentication/required-actions/{alias} | Get required action for alias |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasLowerPriorityPost | Post /admin/realms/{realm}/authentication/required-actions/{alias}/lower-priority | Lower required action's priority |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasPut | Put /admin/realms/{realm}/authentication/required-actions/{alias} | Update required action |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsAliasRaisePriorityPost | Post /admin/realms/{realm}/authentication/required-actions/{alias}/raise-priority | Raise required action's priority |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationRequiredActionsGet | Get /admin/realms/{realm}/authentication/required-actions | Get required actions Returns a stream of required actions. |
AuthenticationManagementAPI | AdminRealmsRealmAuthenticationUnregisteredRequiredActionsGet | Get /admin/realms/{realm}/authentication/unregistered-required-actions | Get unregistered required actions Returns a stream of unregistered required actions. |
ClientAttributeCertificateAPI | AdminRealmsRealmClientsClientUuidCertificatesAttrDownloadPost | Post /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/download | Get a keystore file for the client, containing private key and public certificate |
ClientAttributeCertificateAPI | AdminRealmsRealmClientsClientUuidCertificatesAttrGenerateAndDownloadPost | Post /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/generate-and-download | Generate a new keypair and certificate, and get the private key file Generates a keypair and certificate and serves the private key in a specified keystore format. Only generated public certificate is saved in Keycloak DB - the private key is not. |
ClientAttributeCertificateAPI | AdminRealmsRealmClientsClientUuidCertificatesAttrGeneratePost | Post /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/generate | Generate a new certificate with new key pair |
ClientAttributeCertificateAPI | AdminRealmsRealmClientsClientUuidCertificatesAttrGet | Get /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr} | Get key info |
ClientAttributeCertificateAPI | AdminRealmsRealmClientsClientUuidCertificatesAttrUploadCertificatePost | Post /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/upload-certificate | Upload only certificate, not private key |
ClientAttributeCertificateAPI | AdminRealmsRealmClientsClientUuidCertificatesAttrUploadPost | Post /admin/realms/{realm}/clients/{client-uuid}/certificates/{attr}/upload | Upload certificate and eventually private key |
ClientInitialAccessAPI | AdminRealmsRealmClientsInitialAccessGet | Get /admin/realms/{realm}/clients-initial-access | |
ClientInitialAccessAPI | AdminRealmsRealmClientsInitialAccessIdDelete | Delete /admin/realms/{realm}/clients-initial-access/{id} | |
ClientInitialAccessAPI | AdminRealmsRealmClientsInitialAccessPost | Post /admin/realms/{realm}/clients-initial-access | Create a new initial access token. |
ClientRegistrationPolicyAPI | AdminRealmsRealmClientRegistrationPolicyProvidersGet | Get /admin/realms/{realm}/client-registration-policy/providers | Base path for retrieve providers with the configProperties properly filled |
ClientRoleMappingsAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsClientsClientIdAvailableGet | Get /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id}/available | Get available client-level roles that can be mapped to the user or group |
ClientRoleMappingsAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsClientsClientIdCompositeGet | Get /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id}/composite | Get effective client-level role mappings This recurses any composite roles |
ClientRoleMappingsAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsClientsClientIdDelete | Delete /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id} | Delete client-level roles from user or group role mapping |
ClientRoleMappingsAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsClientsClientIdGet | Get /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id} | Get client-level role mappings for the user or group, and the app |
ClientRoleMappingsAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsClientsClientIdPost | Post /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client-id} | Add client-level roles to the user or group role mapping |
ClientRoleMappingsAPI | AdminRealmsRealmUsersUserIdRoleMappingsClientsClientIdAvailableGet | Get /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}/available | Get available client-level roles that can be mapped to the user or group |
ClientRoleMappingsAPI | AdminRealmsRealmUsersUserIdRoleMappingsClientsClientIdCompositeGet | Get /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}/composite | Get effective client-level role mappings This recurses any composite roles |
ClientRoleMappingsAPI | AdminRealmsRealmUsersUserIdRoleMappingsClientsClientIdDelete | Delete /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id} | Delete client-level roles from user or group role mapping |
ClientRoleMappingsAPI | AdminRealmsRealmUsersUserIdRoleMappingsClientsClientIdGet | Get /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id} | Get client-level role mappings for the user or group, and the app |
ClientRoleMappingsAPI | AdminRealmsRealmUsersUserIdRoleMappingsClientsClientIdPost | Post /admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id} | Add client-level roles to the user or group role mapping |
ClientScopesAPI | AdminRealmsRealmClientScopesClientScopeIdDelete | Delete /admin/realms/{realm}/client-scopes/{client-scope-id} | Delete the client scope |
ClientScopesAPI | AdminRealmsRealmClientScopesClientScopeIdGet | Get /admin/realms/{realm}/client-scopes/{client-scope-id} | Get representation of the client scope |
ClientScopesAPI | AdminRealmsRealmClientScopesClientScopeIdPut | Put /admin/realms/{realm}/client-scopes/{client-scope-id} | Update the client scope |
ClientScopesAPI | AdminRealmsRealmClientScopesGet | Get /admin/realms/{realm}/client-scopes | Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm |
ClientScopesAPI | AdminRealmsRealmClientScopesPost | Post /admin/realms/{realm}/client-scopes | Create a new client scope Client Scope’s name must be unique! |
ClientScopesAPI | AdminRealmsRealmClientTemplatesClientScopeIdDelete | Delete /admin/realms/{realm}/client-templates/{client-scope-id} | Delete the client scope |
ClientScopesAPI | AdminRealmsRealmClientTemplatesClientScopeIdGet | Get /admin/realms/{realm}/client-templates/{client-scope-id} | Get representation of the client scope |
ClientScopesAPI | AdminRealmsRealmClientTemplatesClientScopeIdPut | Put /admin/realms/{realm}/client-templates/{client-scope-id} | Update the client scope |
ClientScopesAPI | AdminRealmsRealmClientTemplatesGet | Get /admin/realms/{realm}/client-templates | Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm |
ClientScopesAPI | AdminRealmsRealmClientTemplatesPost | Post /admin/realms/{realm}/client-templates | Create a new client scope Client Scope’s name must be unique! |
ClientsAPI | AdminRealmsRealmClientsClientUuidClientSecretGet | Get /admin/realms/{realm}/clients/{client-uuid}/client-secret | Get the client secret |
ClientsAPI | AdminRealmsRealmClientsClientUuidClientSecretPost | Post /admin/realms/{realm}/clients/{client-uuid}/client-secret | Generate a new secret for the client |
ClientsAPI | AdminRealmsRealmClientsClientUuidClientSecretRotatedDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/client-secret/rotated | Invalidate the rotated secret for the client |
ClientsAPI | AdminRealmsRealmClientsClientUuidClientSecretRotatedGet | Get /admin/realms/{realm}/clients/{client-uuid}/client-secret/rotated | Get the rotated client secret |
ClientsAPI | AdminRealmsRealmClientsClientUuidDefaultClientScopesClientScopeIdDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/default-client-scopes/{clientScopeId} | |
ClientsAPI | AdminRealmsRealmClientsClientUuidDefaultClientScopesClientScopeIdPut | Put /admin/realms/{realm}/clients/{client-uuid}/default-client-scopes/{clientScopeId} | |
ClientsAPI | AdminRealmsRealmClientsClientUuidDefaultClientScopesGet | Get /admin/realms/{realm}/clients/{client-uuid}/default-client-scopes | Get default client scopes. Only name and ids are returned. |
ClientsAPI | AdminRealmsRealmClientsClientUuidDelete | Delete /admin/realms/{realm}/clients/{client-uuid} | Delete the client |
ClientsAPI | AdminRealmsRealmClientsClientUuidEvaluateScopesGenerateExampleAccessTokenGet | Get /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-access-token | Create JSON with payload of example access token |
ClientsAPI | AdminRealmsRealmClientsClientUuidEvaluateScopesGenerateExampleIdTokenGet | Get /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-id-token | Create JSON with payload of example id token |
ClientsAPI | AdminRealmsRealmClientsClientUuidEvaluateScopesGenerateExampleUserinfoGet | Get /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/generate-example-userinfo | Create JSON with payload of example user info |
ClientsAPI | AdminRealmsRealmClientsClientUuidEvaluateScopesProtocolMappersGet | Get /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/protocol-mappers | Return list of all protocol mappers, which will be used when generating tokens issued for particular client. |
ClientsAPI | AdminRealmsRealmClientsClientUuidEvaluateScopesScopeMappingsRoleContainerIdGrantedGet | Get /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/scope-mappings/{roleContainerId}/granted | Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him. |
ClientsAPI | AdminRealmsRealmClientsClientUuidEvaluateScopesScopeMappingsRoleContainerIdNotGrantedGet | Get /admin/realms/{realm}/clients/{client-uuid}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted | Get roles, which this client doesn't have scope for and can't have them in the accessToken issued for him. |
ClientsAPI | AdminRealmsRealmClientsClientUuidGet | Get /admin/realms/{realm}/clients/{client-uuid} | Get representation of the client |
ClientsAPI | AdminRealmsRealmClientsClientUuidInstallationProvidersProviderIdGet | Get /admin/realms/{realm}/clients/{client-uuid}/installation/providers/{providerId} | |
ClientsAPI | AdminRealmsRealmClientsClientUuidManagementPermissionsGet | Get /admin/realms/{realm}/clients/{client-uuid}/management/permissions | Return object stating whether client Authorization permissions have been initialized or not and a reference |
ClientsAPI | AdminRealmsRealmClientsClientUuidManagementPermissionsPut | Put /admin/realms/{realm}/clients/{client-uuid}/management/permissions | Return object stating whether client Authorization permissions have been initialized or not and a reference |
ClientsAPI | AdminRealmsRealmClientsClientUuidNodesNodeDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/nodes/{node} | Unregister a cluster node from the client |
ClientsAPI | AdminRealmsRealmClientsClientUuidNodesPost | Post /admin/realms/{realm}/clients/{client-uuid}/nodes | Register a cluster node with the client Manually register cluster node to this client - usually it’s not needed to call this directly as adapter should handle by sending registration request to Keycloak |
ClientsAPI | AdminRealmsRealmClientsClientUuidOfflineSessionCountGet | Get /admin/realms/{realm}/clients/{client-uuid}/offline-session-count | Get application offline session count Returns a number of offline user sessions associated with this client { "count": number } |
ClientsAPI | AdminRealmsRealmClientsClientUuidOfflineSessionsGet | Get /admin/realms/{realm}/clients/{client-uuid}/offline-sessions | Get offline sessions for client Returns a list of offline user sessions associated with this client |
ClientsAPI | AdminRealmsRealmClientsClientUuidOptionalClientScopesClientScopeIdDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/optional-client-scopes/{clientScopeId} | |
ClientsAPI | AdminRealmsRealmClientsClientUuidOptionalClientScopesClientScopeIdPut | Put /admin/realms/{realm}/clients/{client-uuid}/optional-client-scopes/{clientScopeId} | |
ClientsAPI | AdminRealmsRealmClientsClientUuidOptionalClientScopesGet | Get /admin/realms/{realm}/clients/{client-uuid}/optional-client-scopes | Get optional client scopes. Only name and ids are returned. |
ClientsAPI | AdminRealmsRealmClientsClientUuidPushRevocationPost | Post /admin/realms/{realm}/clients/{client-uuid}/push-revocation | Push the client's revocation policy to its admin URL If the client has an admin URL, push revocation policy to it. |
ClientsAPI | AdminRealmsRealmClientsClientUuidPut | Put /admin/realms/{realm}/clients/{client-uuid} | Update the client |
ClientsAPI | AdminRealmsRealmClientsClientUuidRegistrationAccessTokenPost | Post /admin/realms/{realm}/clients/{client-uuid}/registration-access-token | Generate a new registration access token for the client |
ClientsAPI | AdminRealmsRealmClientsClientUuidServiceAccountUserGet | Get /admin/realms/{realm}/clients/{client-uuid}/service-account-user | Get a user dedicated to the service account |
ClientsAPI | AdminRealmsRealmClientsClientUuidSessionCountGet | Get /admin/realms/{realm}/clients/{client-uuid}/session-count | Get application session count Returns a number of user sessions associated with this client { "count": number } |
ClientsAPI | AdminRealmsRealmClientsClientUuidTestNodesAvailableGet | Get /admin/realms/{realm}/clients/{client-uuid}/test-nodes-available | Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes. |
ClientsAPI | AdminRealmsRealmClientsClientUuidUserSessionsGet | Get /admin/realms/{realm}/clients/{client-uuid}/user-sessions | Get user sessions for client Returns a list of user sessions associated with this client |
ClientsAPI | AdminRealmsRealmClientsGet | Get /admin/realms/{realm}/clients | Get clients belonging to the realm. |
ClientsAPI | AdminRealmsRealmClientsPost | Post /admin/realms/{realm}/clients | Create a new client Client’s client_id must be unique! |
ComponentAPI | AdminRealmsRealmComponentsGet | Get /admin/realms/{realm}/components | |
ComponentAPI | AdminRealmsRealmComponentsIdDelete | Delete /admin/realms/{realm}/components/{id} | |
ComponentAPI | AdminRealmsRealmComponentsIdGet | Get /admin/realms/{realm}/components/{id} | |
ComponentAPI | AdminRealmsRealmComponentsIdPut | Put /admin/realms/{realm}/components/{id} | |
ComponentAPI | AdminRealmsRealmComponentsIdSubComponentTypesGet | Get /admin/realms/{realm}/components/{id}/sub-component-types | List of subcomponent types that are available to configure for a particular parent component. |
ComponentAPI | AdminRealmsRealmComponentsPost | Post /admin/realms/{realm}/components | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerImportPost | Post /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/import | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPermissionEvaluatePost | Post /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission/evaluate | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPermissionGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPermissionPost | Post /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPermissionProvidersGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission/providers | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPermissionSearchGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/permission/search | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPolicyEvaluatePost | Post /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy/evaluate | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPolicyGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPolicyPost | Post /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPolicyProvidersGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy/providers | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPolicySearchGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/policy/search | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerPut | Put /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourceGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourcePost | Post /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourceResourceIdAttributesGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/attributes | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourceResourceIdDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id} | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourceResourceIdGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id} | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourceResourceIdPermissionsGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/permissions | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourceResourceIdPut | Put /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id} | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourceResourceIdScopesGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/{resource-id}/scopes | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerResourceSearchGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/resource/search | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerScopeGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerScopePost | Post /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerScopeScopeIdDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id} | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerScopeScopeIdGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id} | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerScopeScopeIdPermissionsGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}/permissions | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerScopeScopeIdPut | Put /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id} | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerScopeScopeIdResourcesGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/{scope-id}/resources | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerScopeSearchGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/scope/search | |
DefaultAPI | AdminRealmsRealmClientsClientUuidAuthzResourceServerSettingsGet | Get /admin/realms/{realm}/clients/{client-uuid}/authz/resource-server/settings | |
GroupsAPI | AdminRealmsRealmGroupsCountGet | Get /admin/realms/{realm}/groups/count | Returns the groups counts. |
GroupsAPI | AdminRealmsRealmGroupsGet | Get /admin/realms/{realm}/groups | Get group hierarchy. Only name and ids are returned. |
GroupsAPI | AdminRealmsRealmGroupsGroupIdChildrenGet | Get /admin/realms/{realm}/groups/{group-id}/children | Return a paginated list of subgroups that have a parent group corresponding to the group on the URL |
GroupsAPI | AdminRealmsRealmGroupsGroupIdChildrenPost | Post /admin/realms/{realm}/groups/{group-id}/children | Set or create child. |
GroupsAPI | AdminRealmsRealmGroupsGroupIdDelete | Delete /admin/realms/{realm}/groups/{group-id} | |
GroupsAPI | AdminRealmsRealmGroupsGroupIdGet | Get /admin/realms/{realm}/groups/{group-id} | |
GroupsAPI | AdminRealmsRealmGroupsGroupIdManagementPermissionsGet | Get /admin/realms/{realm}/groups/{group-id}/management/permissions | Return object stating whether client Authorization permissions have been initialized or not and a reference |
GroupsAPI | AdminRealmsRealmGroupsGroupIdManagementPermissionsPut | Put /admin/realms/{realm}/groups/{group-id}/management/permissions | Return object stating whether client Authorization permissions have been initialized or not and a reference |
GroupsAPI | AdminRealmsRealmGroupsGroupIdMembersGet | Get /admin/realms/{realm}/groups/{group-id}/members | Get users Returns a stream of users, filtered according to query parameters |
GroupsAPI | AdminRealmsRealmGroupsGroupIdPut | Put /admin/realms/{realm}/groups/{group-id} | Update group, ignores subgroups. |
GroupsAPI | AdminRealmsRealmGroupsPost | Post /admin/realms/{realm}/groups | create or add a top level realm groupSet or create child. |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderImportConfigPost | Post /admin/realms/{realm}/identity-provider/import-config | Import identity provider from JSON body |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasDelete | Delete /admin/realms/{realm}/identity-provider/instances/{alias} | Delete the identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasExportGet | Get /admin/realms/{realm}/identity-provider/instances/{alias}/export | Export public broker configuration for identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasGet | Get /admin/realms/{realm}/identity-provider/instances/{alias} | Get the identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasManagementPermissionsGet | Get /admin/realms/{realm}/identity-provider/instances/{alias}/management/permissions | Return object stating whether client Authorization permissions have been initialized or not and a reference |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasManagementPermissionsPut | Put /admin/realms/{realm}/identity-provider/instances/{alias}/management/permissions | Return object stating whether client Authorization permissions have been initialized or not and a reference |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasMapperTypesGet | Get /admin/realms/{realm}/identity-provider/instances/{alias}/mapper-types | Get mapper types for identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasMappersGet | Get /admin/realms/{realm}/identity-provider/instances/{alias}/mappers | Get mappers for identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasMappersIdDelete | Delete /admin/realms/{realm}/identity-provider/instances/{alias}/mappers/{id} | Delete a mapper for the identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasMappersIdGet | Get /admin/realms/{realm}/identity-provider/instances/{alias}/mappers/{id} | Get mapper by id for the identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasMappersIdPut | Put /admin/realms/{realm}/identity-provider/instances/{alias}/mappers/{id} | Update a mapper for the identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasMappersPost | Post /admin/realms/{realm}/identity-provider/instances/{alias}/mappers | Add a mapper to identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasPut | Put /admin/realms/{realm}/identity-provider/instances/{alias} | Update the identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesAliasReloadKeysGet | Get /admin/realms/{realm}/identity-provider/instances/{alias}/reload-keys | Reaload keys for the identity provider if the provider supports it, "true" is returned if reload was performed, "false" if not. |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesGet | Get /admin/realms/{realm}/identity-provider/instances | List identity providers |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderInstancesPost | Post /admin/realms/{realm}/identity-provider/instances | Create a new identity provider |
IdentityProvidersAPI | AdminRealmsRealmIdentityProviderProvidersProviderIdGet | Get /admin/realms/{realm}/identity-provider/providers/{provider_id} | Get the identity provider factory for that provider id |
KeyAPI | AdminRealmsRealmKeysGet | Get /admin/realms/{realm}/keys | |
OrganizationsAPI | AdminRealmsRealmOrganizationsGet | Get /admin/realms/{realm}/organizations | Returns a paginated list of organizations filtered according to the specified parameters |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdDelete | Delete /admin/realms/{realm}/organizations/{id} | Deletes the organization |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdGet | Get /admin/realms/{realm}/organizations/{id} | Returns the organization representation |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdIdentityProvidersAliasDelete | Delete /admin/realms/{realm}/organizations/{id}/identity-providers/{alias} | Removes the identity provider with the specified alias from the organization |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdIdentityProvidersAliasGet | Get /admin/realms/{realm}/organizations/{id}/identity-providers/{alias} | Returns the identity provider associated with the organization that has the specified alias |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdIdentityProvidersGet | Get /admin/realms/{realm}/organizations/{id}/identity-providers | Returns all identity providers associated with the organization |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdIdentityProvidersPost | Post /admin/realms/{realm}/organizations/{id}/identity-providers | Adds the identity provider with the specified id to the organization |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdMembersCountGet | Get /admin/realms/{realm}/organizations/{id}/members/count | Returns number of members in the organization. |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdMembersGet | Get /admin/realms/{realm}/organizations/{id}/members | Returns a paginated list of organization members filtered according to the specified parameters |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdMembersInviteExistingUserPost | Post /admin/realms/{realm}/organizations/{id}/members/invite-existing-user | Invites an existing user to the organization, using the specified user id |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdMembersInviteUserPost | Post /admin/realms/{realm}/organizations/{id}/members/invite-user | Invites an existing user or sends a registration link to a new user, based on the provided e-mail address. |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdMembersPost | Post /admin/realms/{realm}/organizations/{id}/members | Adds the user with the specified id as a member of the organization |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdMembersUserIdDelete | Delete /admin/realms/{realm}/organizations/{id}/members/{userId} | Removes the user with the specified id from the organization |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdMembersUserIdGet | Get /admin/realms/{realm}/organizations/{id}/members/{userId} | Returns the member of the organization with the specified id |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdMembersUserIdOrganizationsGet | Get /admin/realms/{realm}/organizations/{id}/members/{userId}/organizations | Returns the organizations associated with the user that has the specified id |
OrganizationsAPI | AdminRealmsRealmOrganizationsIdPut | Put /admin/realms/{realm}/organizations/{id} | Updates the organization |
OrganizationsAPI | AdminRealmsRealmOrganizationsMembersIdOrganizationsGet | Get /admin/realms/{realm}/organizations/members/{id}/organizations | Returns the organizations associated with the user that has the specified id |
OrganizationsAPI | AdminRealmsRealmOrganizationsPost | Post /admin/realms/{realm}/organizations | Creates a new organization |
ProtocolMappersAPI | AdminRealmsRealmClientScopesClientScopeIdProtocolMappersAddModelsPost | Post /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/add-models | Create multiple mappers |
ProtocolMappersAPI | AdminRealmsRealmClientScopesClientScopeIdProtocolMappersModelsGet | Get /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models | Get mappers |
ProtocolMappersAPI | AdminRealmsRealmClientScopesClientScopeIdProtocolMappersModelsIdDelete | Delete /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id} | Delete the mapper |
ProtocolMappersAPI | AdminRealmsRealmClientScopesClientScopeIdProtocolMappersModelsIdGet | Get /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id} | Get mapper by id |
ProtocolMappersAPI | AdminRealmsRealmClientScopesClientScopeIdProtocolMappersModelsIdPut | Put /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id} | Update the mapper |
ProtocolMappersAPI | AdminRealmsRealmClientScopesClientScopeIdProtocolMappersModelsPost | Post /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models | Create a mapper |
ProtocolMappersAPI | AdminRealmsRealmClientScopesClientScopeIdProtocolMappersProtocolProtocolGet | Get /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/protocol/{protocol} | Get mappers by name for a specific protocol |
ProtocolMappersAPI | AdminRealmsRealmClientTemplatesClientScopeIdProtocolMappersAddModelsPost | Post /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/add-models | Create multiple mappers |
ProtocolMappersAPI | AdminRealmsRealmClientTemplatesClientScopeIdProtocolMappersModelsGet | Get /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models | Get mappers |
ProtocolMappersAPI | AdminRealmsRealmClientTemplatesClientScopeIdProtocolMappersModelsIdDelete | Delete /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id} | Delete the mapper |
ProtocolMappersAPI | AdminRealmsRealmClientTemplatesClientScopeIdProtocolMappersModelsIdGet | Get /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id} | Get mapper by id |
ProtocolMappersAPI | AdminRealmsRealmClientTemplatesClientScopeIdProtocolMappersModelsIdPut | Put /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id} | Update the mapper |
ProtocolMappersAPI | AdminRealmsRealmClientTemplatesClientScopeIdProtocolMappersModelsPost | Post /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models | Create a mapper |
ProtocolMappersAPI | AdminRealmsRealmClientTemplatesClientScopeIdProtocolMappersProtocolProtocolGet | Get /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/protocol/{protocol} | Get mappers by name for a specific protocol |
ProtocolMappersAPI | AdminRealmsRealmClientsClientUuidProtocolMappersAddModelsPost | Post /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/add-models | Create multiple mappers |
ProtocolMappersAPI | AdminRealmsRealmClientsClientUuidProtocolMappersModelsGet | Get /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models | Get mappers |
ProtocolMappersAPI | AdminRealmsRealmClientsClientUuidProtocolMappersModelsIdDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id} | Delete the mapper |
ProtocolMappersAPI | AdminRealmsRealmClientsClientUuidProtocolMappersModelsIdGet | Get /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id} | Get mapper by id |
ProtocolMappersAPI | AdminRealmsRealmClientsClientUuidProtocolMappersModelsIdPut | Put /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id} | Update the mapper |
ProtocolMappersAPI | AdminRealmsRealmClientsClientUuidProtocolMappersModelsPost | Post /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models | Create a mapper |
ProtocolMappersAPI | AdminRealmsRealmClientsClientUuidProtocolMappersProtocolProtocolGet | Get /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/protocol/{protocol} | Get mappers by name for a specific protocol |
RealmsAdminAPI | AdminRealmsGet | Get /admin/realms | Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view. |
RealmsAdminAPI | AdminRealmsPost | Post /admin/realms | Import a realm. Imports a realm from a full representation of that realm. |
RealmsAdminAPI | AdminRealmsRealmAdminEventsDelete | Delete /admin/realms/{realm}/admin-events | Delete all admin events |
RealmsAdminAPI | AdminRealmsRealmAdminEventsGet | Get /admin/realms/{realm}/admin-events | Get admin events Returns all admin events, or filters events based on URL query parameters listed here |
RealmsAdminAPI | AdminRealmsRealmClientDescriptionConverterPost | Post /admin/realms/{realm}/client-description-converter | Base path for importing clients under this realm. |
RealmsAdminAPI | AdminRealmsRealmClientPoliciesPoliciesGet | Get /admin/realms/{realm}/client-policies/policies | |
RealmsAdminAPI | AdminRealmsRealmClientPoliciesPoliciesPut | Put /admin/realms/{realm}/client-policies/policies | |
RealmsAdminAPI | AdminRealmsRealmClientPoliciesProfilesGet | Get /admin/realms/{realm}/client-policies/profiles | |
RealmsAdminAPI | AdminRealmsRealmClientPoliciesProfilesPut | Put /admin/realms/{realm}/client-policies/profiles | |
RealmsAdminAPI | AdminRealmsRealmClientSessionStatsGet | Get /admin/realms/{realm}/client-session-stats | Get client session stats Returns a JSON map. |
RealmsAdminAPI | AdminRealmsRealmClientTypesGet | Get /admin/realms/{realm}/client-types | List all client types available in the current realm |
RealmsAdminAPI | AdminRealmsRealmClientTypesPut | Put /admin/realms/{realm}/client-types | Update a client type |
RealmsAdminAPI | AdminRealmsRealmCredentialRegistratorsGet | Get /admin/realms/{realm}/credential-registrators | |
RealmsAdminAPI | AdminRealmsRealmDefaultDefaultClientScopesClientScopeIdDelete | Delete /admin/realms/{realm}/default-default-client-scopes/{clientScopeId} | |
RealmsAdminAPI | AdminRealmsRealmDefaultDefaultClientScopesClientScopeIdPut | Put /admin/realms/{realm}/default-default-client-scopes/{clientScopeId} | |
RealmsAdminAPI | AdminRealmsRealmDefaultDefaultClientScopesGet | Get /admin/realms/{realm}/default-default-client-scopes | Get realm default client scopes. Only name and ids are returned. |
RealmsAdminAPI | AdminRealmsRealmDefaultGroupsGet | Get /admin/realms/{realm}/default-groups | Get group hierarchy. Only name and ids are returned. |
RealmsAdminAPI | AdminRealmsRealmDefaultGroupsGroupIdDelete | Delete /admin/realms/{realm}/default-groups/{groupId} | |
RealmsAdminAPI | AdminRealmsRealmDefaultGroupsGroupIdPut | Put /admin/realms/{realm}/default-groups/{groupId} | |
RealmsAdminAPI | AdminRealmsRealmDefaultOptionalClientScopesClientScopeIdDelete | Delete /admin/realms/{realm}/default-optional-client-scopes/{clientScopeId} | |
RealmsAdminAPI | AdminRealmsRealmDefaultOptionalClientScopesClientScopeIdPut | Put /admin/realms/{realm}/default-optional-client-scopes/{clientScopeId} | |
RealmsAdminAPI | AdminRealmsRealmDefaultOptionalClientScopesGet | Get /admin/realms/{realm}/default-optional-client-scopes | Get realm optional client scopes. Only name and ids are returned. |
RealmsAdminAPI | AdminRealmsRealmDelete | Delete /admin/realms/{realm} | Delete the realm |
RealmsAdminAPI | AdminRealmsRealmEventsConfigGet | Get /admin/realms/{realm}/events/config | Get the events provider configuration Returns JSON object with events provider configuration |
RealmsAdminAPI | AdminRealmsRealmEventsConfigPut | Put /admin/realms/{realm}/events/config | |
RealmsAdminAPI | AdminRealmsRealmEventsDelete | Delete /admin/realms/{realm}/events | Delete all events |
RealmsAdminAPI | AdminRealmsRealmEventsGet | Get /admin/realms/{realm}/events | Get events Returns all events, or filters them based on URL query parameters listed here |
RealmsAdminAPI | AdminRealmsRealmGet | Get /admin/realms/{realm} | Get the top-level representation of the realm It will not include nested information like User and Client representations. |
RealmsAdminAPI | AdminRealmsRealmGroupByPathPathGet | Get /admin/realms/{realm}/group-by-path/{path} | |
RealmsAdminAPI | AdminRealmsRealmLocalizationGet | Get /admin/realms/{realm}/localization | |
RealmsAdminAPI | AdminRealmsRealmLocalizationLocaleDelete | Delete /admin/realms/{realm}/localization/{locale} | |
RealmsAdminAPI | AdminRealmsRealmLocalizationLocaleGet | Get /admin/realms/{realm}/localization/{locale} | |
RealmsAdminAPI | AdminRealmsRealmLocalizationLocaleKeyDelete | Delete /admin/realms/{realm}/localization/{locale}/{key} | |
RealmsAdminAPI | AdminRealmsRealmLocalizationLocaleKeyGet | Get /admin/realms/{realm}/localization/{locale}/{key} | |
RealmsAdminAPI | AdminRealmsRealmLocalizationLocaleKeyPut | Put /admin/realms/{realm}/localization/{locale}/{key} | |
RealmsAdminAPI | AdminRealmsRealmLocalizationLocalePost | Post /admin/realms/{realm}/localization/{locale} | Import localization from uploaded JSON file |
RealmsAdminAPI | AdminRealmsRealmLogoutAllPost | Post /admin/realms/{realm}/logout-all | Removes all user sessions. |
RealmsAdminAPI | AdminRealmsRealmPartialExportPost | Post /admin/realms/{realm}/partial-export | Partial export of existing realm into a JSON file. |
RealmsAdminAPI | AdminRealmsRealmPartialImportPost | Post /admin/realms/{realm}/partialImport | Partial import from a JSON file to an existing realm. |
RealmsAdminAPI | AdminRealmsRealmPushRevocationPost | Post /admin/realms/{realm}/push-revocation | Push the realm's revocation policy to any client that has an admin url associated with it. |
RealmsAdminAPI | AdminRealmsRealmPut | Put /admin/realms/{realm} | Update the top-level information of the realm Any user, roles or client information in the representation will be ignored. |
RealmsAdminAPI | AdminRealmsRealmSessionsSessionDelete | Delete /admin/realms/{realm}/sessions/{session} | Remove a specific user session. |
RealmsAdminAPI | AdminRealmsRealmTestSMTPConnectionPost | Post /admin/realms/{realm}/testSMTPConnection | Test SMTP connection with current logged in user |
RealmsAdminAPI | AdminRealmsRealmUsersManagementPermissionsGet | Get /admin/realms/{realm}/users-management-permissions | |
RealmsAdminAPI | AdminRealmsRealmUsersManagementPermissionsPut | Put /admin/realms/{realm}/users-management-permissions | |
RoleMapperAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsGet | Get /admin/realms/{realm}/groups/{group-id}/role-mappings | Get role mappings |
RoleMapperAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsRealmAvailableGet | Get /admin/realms/{realm}/groups/{group-id}/role-mappings/realm/available | Get realm-level roles that can be mapped |
RoleMapperAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsRealmCompositeGet | Get /admin/realms/{realm}/groups/{group-id}/role-mappings/realm/composite | Get effective realm-level role mappings This will recurse all composite roles to get the result. |
RoleMapperAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsRealmDelete | Delete /admin/realms/{realm}/groups/{group-id}/role-mappings/realm | Delete realm-level role mappings |
RoleMapperAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsRealmGet | Get /admin/realms/{realm}/groups/{group-id}/role-mappings/realm | Get realm-level role mappings |
RoleMapperAPI | AdminRealmsRealmGroupsGroupIdRoleMappingsRealmPost | Post /admin/realms/{realm}/groups/{group-id}/role-mappings/realm | Add realm-level role mappings to the user |
RoleMapperAPI | AdminRealmsRealmUsersUserIdRoleMappingsGet | Get /admin/realms/{realm}/users/{user-id}/role-mappings | Get role mappings |
RoleMapperAPI | AdminRealmsRealmUsersUserIdRoleMappingsRealmAvailableGet | Get /admin/realms/{realm}/users/{user-id}/role-mappings/realm/available | Get realm-level roles that can be mapped |
RoleMapperAPI | AdminRealmsRealmUsersUserIdRoleMappingsRealmCompositeGet | Get /admin/realms/{realm}/users/{user-id}/role-mappings/realm/composite | Get effective realm-level role mappings This will recurse all composite roles to get the result. |
RoleMapperAPI | AdminRealmsRealmUsersUserIdRoleMappingsRealmDelete | Delete /admin/realms/{realm}/users/{user-id}/role-mappings/realm | Delete realm-level role mappings |
RoleMapperAPI | AdminRealmsRealmUsersUserIdRoleMappingsRealmGet | Get /admin/realms/{realm}/users/{user-id}/role-mappings/realm | Get realm-level role mappings |
RoleMapperAPI | AdminRealmsRealmUsersUserIdRoleMappingsRealmPost | Post /admin/realms/{realm}/users/{user-id}/role-mappings/realm | Add realm-level role mappings to the user |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesGet | Get /admin/realms/{realm}/clients/{client-uuid}/roles | Get all roles for the realm or client |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesPost | Post /admin/realms/{realm}/clients/{client-uuid}/roles | Create a new role for the realm or client |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesClientsClientInCompositeUuidGet | Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/clients/{client-in-composite-uuid} | Get client-level roles for the client that are in the role's composite |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites | Remove roles from the role's composite |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesGet | Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites | Get composites of the role |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesPost | Post /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites | Add a composite to the role |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameCompositesRealmGet | Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/realm | Get realm-level roles of the role's composite |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name} | Delete a role by name |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameGet | Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name} | Get a role by name |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameGroupsGet | Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/groups | Returns a stream of groups that have the specified role name |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsGet | Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/management/permissions | Return object stating whether role Authorization permissions have been initialized or not and a reference |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameManagementPermissionsPut | Put /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/management/permissions | Return object stating whether role Authorization permissions have been initialized or not and a reference |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNamePut | Put /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name} | Update a role by name |
RolesAPI | AdminRealmsRealmClientsClientUuidRolesRoleNameUsersGet | Get /admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/users | Returns a stream of users that have the specified role name. |
RolesAPI | AdminRealmsRealmRolesGet | Get /admin/realms/{realm}/roles | Get all roles for the realm or client |
RolesAPI | AdminRealmsRealmRolesPost | Post /admin/realms/{realm}/roles | Create a new role for the realm or client |
RolesAPI | AdminRealmsRealmRolesRoleNameCompositesClientsClientUuidGet | Get /admin/realms/{realm}/roles/{role-name}/composites/clients/{client-uuid} | Get client-level roles for the client that are in the role's composite |
RolesAPI | AdminRealmsRealmRolesRoleNameCompositesDelete | Delete /admin/realms/{realm}/roles/{role-name}/composites | Remove roles from the role's composite |
RolesAPI | AdminRealmsRealmRolesRoleNameCompositesGet | Get /admin/realms/{realm}/roles/{role-name}/composites | Get composites of the role |
RolesAPI | AdminRealmsRealmRolesRoleNameCompositesPost | Post /admin/realms/{realm}/roles/{role-name}/composites | Add a composite to the role |
RolesAPI | AdminRealmsRealmRolesRoleNameCompositesRealmGet | Get /admin/realms/{realm}/roles/{role-name}/composites/realm | Get realm-level roles of the role's composite |
RolesAPI | AdminRealmsRealmRolesRoleNameDelete | Delete /admin/realms/{realm}/roles/{role-name} | Delete a role by name |
RolesAPI | AdminRealmsRealmRolesRoleNameGet | Get /admin/realms/{realm}/roles/{role-name} | Get a role by name |
RolesAPI | AdminRealmsRealmRolesRoleNameGroupsGet | Get /admin/realms/{realm}/roles/{role-name}/groups | Returns a stream of groups that have the specified role name |
RolesAPI | AdminRealmsRealmRolesRoleNameManagementPermissionsGet | Get /admin/realms/{realm}/roles/{role-name}/management/permissions | Return object stating whether role Authorization permissions have been initialized or not and a reference |
RolesAPI | AdminRealmsRealmRolesRoleNameManagementPermissionsPut | Put /admin/realms/{realm}/roles/{role-name}/management/permissions | Return object stating whether role Authorization permissions have been initialized or not and a reference |
RolesAPI | AdminRealmsRealmRolesRoleNamePut | Put /admin/realms/{realm}/roles/{role-name} | Update a role by name |
RolesAPI | AdminRealmsRealmRolesRoleNameUsersGet | Get /admin/realms/{realm}/roles/{role-name}/users | Returns a stream of users that have the specified role name. |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdCompositesClientsClientUuidGet | Get /admin/realms/{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid} | Get client-level roles for the client that are in the role's composite |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdCompositesDelete | Delete /admin/realms/{realm}/roles-by-id/{role-id}/composites | Remove a set of roles from the role's composite |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdCompositesGet | Get /admin/realms/{realm}/roles-by-id/{role-id}/composites | Get role's children Returns a set of role's children provided the role is a composite. |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdCompositesPost | Post /admin/realms/{realm}/roles-by-id/{role-id}/composites | Make the role a composite role by associating some child roles |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdCompositesRealmGet | Get /admin/realms/{realm}/roles-by-id/{role-id}/composites/realm | Get realm-level roles that are in the role's composite |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdDelete | Delete /admin/realms/{realm}/roles-by-id/{role-id} | Delete the role |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdGet | Get /admin/realms/{realm}/roles-by-id/{role-id} | Get a specific role's representation |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdManagementPermissionsGet | Get /admin/realms/{realm}/roles-by-id/{role-id}/management/permissions | Return object stating whether role Authorization permissions have been initialized or not and a reference |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdManagementPermissionsPut | Put /admin/realms/{realm}/roles-by-id/{role-id}/management/permissions | Return object stating whether role Authorization permissions have been initialized or not and a reference |
RolesByIDAPI | AdminRealmsRealmRolesByIdRoleIdPut | Put /admin/realms/{realm}/roles-by-id/{role-id} | Update the role |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientDelete | Delete /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client} | Remove client-level roles from the client's scope. |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | AdminRealmsRealmClientScopesClientScopeIdScopeMappingsClientsClientPost | Post /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client} | Add client-level roles to the client's scope |
ScopeMappingsAPI | AdminRealmsRealmClientScopesClientScopeIdScopeMappingsGet | Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings | Get all scope mappings for the client |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | AdminRealmsRealmClientScopesClientScopeIdScopeMappingsRealmGet | Get /admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm | Get realm-level roles associated with the client's scope |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientDelete | Delete /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client} | Remove client-level roles from the client's scope. |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsClientsClientPost | Post /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client} | Add client-level roles to the client's scope |
ScopeMappingsAPI | AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsGet | Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings | Get all scope mappings for the client |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | AdminRealmsRealmClientTemplatesClientScopeIdScopeMappingsRealmGet | Get /admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm | Get realm-level roles associated with the client's scope |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client} | Remove client-level roles from the client's scope. |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | AdminRealmsRealmClientsClientUuidScopeMappingsClientsClientPost | Post /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client} | Add client-level roles to the client's scope |
ScopeMappingsAPI | AdminRealmsRealmClientsClientUuidScopeMappingsGet | Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings | Get all scope mappings for the client |
ScopeMappingsAPI | 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 |
ScopeMappingsAPI | 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. |
ScopeMappingsAPI | AdminRealmsRealmClientsClientUuidScopeMappingsRealmDelete | Delete /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm | Remove a set of realm-level roles from the client's scope |
ScopeMappingsAPI | AdminRealmsRealmClientsClientUuidScopeMappingsRealmGet | Get /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm | Get realm-level roles associated with the client's scope |
ScopeMappingsAPI | AdminRealmsRealmClientsClientUuidScopeMappingsRealmPost | Post /admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm | Add a set of realm-level roles to the client's scope |
UsersAPI | AdminRealmsRealmUsersCountGet | Get /admin/realms/{realm}/users/count | Returns the number of users that match the given criteria. |
UsersAPI | AdminRealmsRealmUsersGet | Get /admin/realms/{realm}/users | Get users Returns a stream of users, filtered according to query parameters. |
UsersAPI | AdminRealmsRealmUsersPost | Post /admin/realms/{realm}/users | Create a new user Username must be unique. |
UsersAPI | AdminRealmsRealmUsersProfileGet | Get /admin/realms/{realm}/users/profile | |
UsersAPI | AdminRealmsRealmUsersProfileMetadataGet | Get /admin/realms/{realm}/users/profile/metadata | |
UsersAPI | AdminRealmsRealmUsersProfilePut | Put /admin/realms/{realm}/users/profile | |
UsersAPI | AdminRealmsRealmUsersUserIdConfiguredUserStorageCredentialTypesGet | Get /admin/realms/{realm}/users/{user-id}/configured-user-storage-credential-types | Return credential types, which are provided by the user storage where user is stored. |
UsersAPI | AdminRealmsRealmUsersUserIdConsentsClientDelete | Delete /admin/realms/{realm}/users/{user-id}/consents/{client} | Revoke consent and offline tokens for particular client from user |
UsersAPI | AdminRealmsRealmUsersUserIdConsentsGet | Get /admin/realms/{realm}/users/{user-id}/consents | Get consents granted by the user |
UsersAPI | AdminRealmsRealmUsersUserIdCredentialsCredentialIdDelete | Delete /admin/realms/{realm}/users/{user-id}/credentials/{credentialId} | Remove a credential for a user |
UsersAPI | AdminRealmsRealmUsersUserIdCredentialsCredentialIdMoveAfterNewPreviousCredentialIdPost | Post /admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId} | Move a credential to a position behind another credential |
UsersAPI | AdminRealmsRealmUsersUserIdCredentialsCredentialIdMoveToFirstPost | Post /admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/moveToFirst | Move a credential to a first position in the credentials list of the user |
UsersAPI | AdminRealmsRealmUsersUserIdCredentialsCredentialIdUserLabelPut | Put /admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/userLabel | Update a credential label for a user |
UsersAPI | AdminRealmsRealmUsersUserIdCredentialsGet | Get /admin/realms/{realm}/users/{user-id}/credentials | |
UsersAPI | AdminRealmsRealmUsersUserIdDelete | Delete /admin/realms/{realm}/users/{user-id} | Delete the user |
UsersAPI | AdminRealmsRealmUsersUserIdDisableCredentialTypesPut | Put /admin/realms/{realm}/users/{user-id}/disable-credential-types | Disable all credentials for a user of a specific type |
UsersAPI | AdminRealmsRealmUsersUserIdExecuteActionsEmailPut | Put /admin/realms/{realm}/users/{user-id}/execute-actions-email | Send an email to the user with a link they can click to execute particular actions. |
UsersAPI | AdminRealmsRealmUsersUserIdFederatedIdentityGet | Get /admin/realms/{realm}/users/{user-id}/federated-identity | Get social logins associated with the user |
UsersAPI | AdminRealmsRealmUsersUserIdFederatedIdentityProviderDelete | Delete /admin/realms/{realm}/users/{user-id}/federated-identity/{provider} | Remove a social login provider from user |
UsersAPI | AdminRealmsRealmUsersUserIdFederatedIdentityProviderPost | Post /admin/realms/{realm}/users/{user-id}/federated-identity/{provider} | Add a social login provider to the user |
UsersAPI | AdminRealmsRealmUsersUserIdGet | Get /admin/realms/{realm}/users/{user-id} | Get representation of the user |
UsersAPI | AdminRealmsRealmUsersUserIdGroupsCountGet | Get /admin/realms/{realm}/users/{user-id}/groups/count | |
UsersAPI | AdminRealmsRealmUsersUserIdGroupsGet | Get /admin/realms/{realm}/users/{user-id}/groups | |
UsersAPI | AdminRealmsRealmUsersUserIdGroupsGroupIdDelete | Delete /admin/realms/{realm}/users/{user-id}/groups/{groupId} | |
UsersAPI | AdminRealmsRealmUsersUserIdGroupsGroupIdPut | Put /admin/realms/{realm}/users/{user-id}/groups/{groupId} | |
UsersAPI | AdminRealmsRealmUsersUserIdImpersonationPost | Post /admin/realms/{realm}/users/{user-id}/impersonation | Impersonate the user |
UsersAPI | AdminRealmsRealmUsersUserIdLogoutPost | Post /admin/realms/{realm}/users/{user-id}/logout | Remove all user sessions associated with the user Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user. |
UsersAPI | AdminRealmsRealmUsersUserIdOfflineSessionsClientUuidGet | Get /admin/realms/{realm}/users/{user-id}/offline-sessions/{clientUuid} | Get offline sessions associated with the user and client |
UsersAPI | AdminRealmsRealmUsersUserIdPut | Put /admin/realms/{realm}/users/{user-id} | Update the user |
UsersAPI | AdminRealmsRealmUsersUserIdResetPasswordEmailPut | Put /admin/realms/{realm}/users/{user-id}/reset-password-email | Send an email to the user with a link they can click to reset their password. |
UsersAPI | AdminRealmsRealmUsersUserIdResetPasswordPut | Put /admin/realms/{realm}/users/{user-id}/reset-password | Set up a new password for the user. |
UsersAPI | AdminRealmsRealmUsersUserIdSendVerifyEmailPut | Put /admin/realms/{realm}/users/{user-id}/send-verify-email | Send an email-verification email to the user An email contains a link the user can click to verify their email address. |
UsersAPI | AdminRealmsRealmUsersUserIdSessionsGet | Get /admin/realms/{realm}/users/{user-id}/sessions | Get sessions associated with the user |
UsersAPI | AdminRealmsRealmUsersUserIdUnmanagedAttributesGet | Get /admin/realms/{realm}/users/{user-id}/unmanagedAttributes |
- AbstractPolicyRepresentation
- Access
- AccessToken
- AddressClaimSet
- AdminEventRepresentation
- ApplicationRepresentation
- AuthDetailsRepresentation
- AuthenticationExecutionExportRepresentation
- AuthenticationExecutionInfoRepresentation
- AuthenticationExecutionRepresentation
- AuthenticationFlowRepresentation
- AuthenticatorConfigInfoRepresentation
- AuthenticatorConfigRepresentation
- Authorization
- BruteForceStrategy
- CertificateRepresentation
- ClaimRepresentation
- ClientInitialAccessCreatePresentation
- ClientInitialAccessPresentation
- ClientMappingsRepresentation
- ClientPoliciesRepresentation
- ClientPolicyConditionRepresentation
- ClientPolicyExecutorRepresentation
- ClientPolicyRepresentation
- ClientProfileRepresentation
- ClientProfilesRepresentation
- ClientRepresentation
- ClientScopeRepresentation
- ClientTemplateRepresentation
- ClientTypeRepresentation
- ClientTypesRepresentation
- ComponentExportRepresentation
- ComponentRepresentation
- ComponentTypeRepresentation
- Composites
- ConfigPropertyRepresentation
- Confirmation
- CredentialRepresentation
- DecisionEffect
- DecisionStrategy
- EnforcementMode
- EvaluationResultRepresentation
- EventRepresentation
- FederatedIdentityRepresentation
- GlobalRequestResult
- GroupRepresentation
- IDToken
- IdentityProviderMapperRepresentation
- IdentityProviderMapperTypeRepresentation
- IdentityProviderRepresentation
- InstallationAdapterConfig
- KeyMetadataRepresentation
- KeyStoreConfig
- KeyUse
- KeysMetadataRepresentation
- Logic
- ManagementPermissionReference
- MappingsRepresentation
- MemberRepresentation
- MembershipType
- MethodConfig
- OAuthClientRepresentation
- OrganizationDomainRepresentation
- OrganizationRepresentation
- PathCacheConfig
- PathConfig
- Permission
- PolicyEnforcementMode
- PolicyEnforcerConfig
- PolicyEvaluationRequest
- PolicyEvaluationResponse
- PolicyProviderRepresentation
- PolicyRepresentation
- PolicyResultRepresentation
- PropertyConfig
- ProtocolMapperEvaluationRepresentation
- ProtocolMapperRepresentation
- PublishedRealmRepresentation
- RealmEventsConfigRepresentation
- RealmRepresentation
- RequiredActionConfigInfoRepresentation
- RequiredActionConfigRepresentation
- RequiredActionProviderRepresentation
- ResourceOwnerRepresentation
- ResourceRepresentation
- ResourceServerRepresentation
- RoleRepresentation
- RolesRepresentation
- ScopeEnforcementMode
- ScopeMappingRepresentation
- ScopeRepresentation
- SocialLinkRepresentation
- UPAttribute
- UPAttributePermissions
- UPAttributeRequired
- UPAttributeSelector
- UPConfig
- UPGroup
- UnmanagedAttributePolicy
- UserConsentRepresentation
- UserFederationMapperRepresentation
- UserFederationProviderRepresentation
- UserProfileAttributeGroupMetadata
- UserProfileAttributeMetadata
- UserProfileMetadata
- UserRepresentation
- UserSessionRepresentation
Endpoints do not require authorization.
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