Connectors
Identity & Access Management
Keycloak
Open source identity: users, realms, clients, roles, and group management
Keycloak API referenceAPI checked August 17, 2026
- Signs in with
- OAuth 2.0 sign-in
- Runs on
- Cloud or On-Prem Worker
- Operations
- 415
- Ready-made triggers
- 2
Connect Keycloak
- In Neblex open Connect › Connections and click New Connection.
- Search for Keycloak and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
For services offered under Connect a Service you only sign in and approve access. Otherwise use Connect with OAuth2 with your own OAuth app. See Authorize with OAuth.
| Field | What to enter |
|---|---|
| HostRequired | Keycloak host without scheme; include a base path when deployed below one, for example sso.example.com/auth. |
| Token endpointRequired | Realm token endpoint, for example https://sso.example.com/realms/master/protocol/openid-connect/token. |
| Client IDRequired | Confidential service-account client, or a direct-access client for the password grant. |
| Client secretOptionalSecret | Client secret when the selected client authentication method requires one. |
| Admin username (password grant)Optional | Optional resource-owner username; omit for service-account client credentials. |
| Admin password (password grant)OptionalSecret | Optional resource-owner password; omit for service-account client credentials. |
Triggers
Start a flow when something changes in Keycloak: add a Poll for changes trigger, choose Keycloak and pick the event.
| Event | What it does | How |
|---|---|---|
| Admin event | An administrative event was recorded. | Checks for changes by time |
| Login event | A login-related event was recorded. | Checks for changes by time |
Use it in a flow
- Open a flow, open the node library and search for Keycloak.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
415 operations in 22 groups. Each one is a step you can add to a flow.
Admin31
deleteClientsClientUuidAuthzResourceServerResourceResourceIddeleteClientsClientUuidAuthzResourceServerResourceResourceId | DELETE | deleteClientsClientUuidAuthzResourceServerResourceResourceId |
deleteClientsClientUuidAuthzResourceServerScopeScopeIddeleteClientsClientUuidAuthzResourceServerScopeScopeId | DELETE | deleteClientsClientUuidAuthzResourceServerScopeScopeId |
getClientsClientUuidAuthzResourceServergetClientsClientUuidAuthzResourceServer | GET | getClientsClientUuidAuthzResourceServer |
getClientsClientUuidAuthzResourceServerPermissiongetClientsClientUuidAuthzResourceServerPermission | GET | getClientsClientUuidAuthzResourceServerPermission |
getClientsClientUuidAuthzResourceServerPermissionProvidersgetClientsClientUuidAuthzResourceServerPermissionProviders | GET | getClientsClientUuidAuthzResourceServerPermissionProviders |
getClientsClientUuidAuthzResourceServerPermissionSearchgetClientsClientUuidAuthzResourceServerPermissionSearch | GET | getClientsClientUuidAuthzResourceServerPermissionSearch |
getClientsClientUuidAuthzResourceServerPolicygetClientsClientUuidAuthzResourceServerPolicy | GET | getClientsClientUuidAuthzResourceServerPolicy |
getClientsClientUuidAuthzResourceServerPolicyProvidersgetClientsClientUuidAuthzResourceServerPolicyProviders | GET | getClientsClientUuidAuthzResourceServerPolicyProviders |
getClientsClientUuidAuthzResourceServerPolicySearchgetClientsClientUuidAuthzResourceServerPolicySearch | GET | getClientsClientUuidAuthzResourceServerPolicySearch |
getClientsClientUuidAuthzResourceServerResourcegetClientsClientUuidAuthzResourceServerResource | GET | getClientsClientUuidAuthzResourceServerResource |
getClientsClientUuidAuthzResourceServerResourceResourceIdgetClientsClientUuidAuthzResourceServerResourceResourceId | GET | getClientsClientUuidAuthzResourceServerResourceResourceId |
getClientsClientUuidAuthzResourceServerResourceResourceIdAttributesgetClientsClientUuidAuthzResourceServerResourceResourceIdAttributes | GET | getClientsClientUuidAuthzResourceServerResourceResourceIdAttributes |
getClientsClientUuidAuthzResourceServerResourceResourceIdPermissionsgetClientsClientUuidAuthzResourceServerResourceResourceIdPermissions | GET | getClientsClientUuidAuthzResourceServerResourceResourceIdPermissions |
getClientsClientUuidAuthzResourceServerResourceResourceIdScopesgetClientsClientUuidAuthzResourceServerResourceResourceIdScopes | GET | getClientsClientUuidAuthzResourceServerResourceResourceIdScopes |
getClientsClientUuidAuthzResourceServerResourceSearchgetClientsClientUuidAuthzResourceServerResourceSearch | GET | getClientsClientUuidAuthzResourceServerResourceSearch |
getClientsClientUuidAuthzResourceServerScopegetClientsClientUuidAuthzResourceServerScope | GET | getClientsClientUuidAuthzResourceServerScope |
getClientsClientUuidAuthzResourceServerScopeScopeIdgetClientsClientUuidAuthzResourceServerScopeScopeId | GET | getClientsClientUuidAuthzResourceServerScopeScopeId |
getClientsClientUuidAuthzResourceServerScopeScopeIdPermissionsgetClientsClientUuidAuthzResourceServerScopeScopeIdPermissions | GET | getClientsClientUuidAuthzResourceServerScopeScopeIdPermissions |
getClientsClientUuidAuthzResourceServerScopeScopeIdResourcesgetClientsClientUuidAuthzResourceServerScopeScopeIdResources | GET | getClientsClientUuidAuthzResourceServerScopeScopeIdResources |
getClientsClientUuidAuthzResourceServerScopeSearchgetClientsClientUuidAuthzResourceServerScopeSearch | GET | getClientsClientUuidAuthzResourceServerScopeSearch |
getClientsClientUuidAuthzResourceServerSettingsgetClientsClientUuidAuthzResourceServerSettings | GET | getClientsClientUuidAuthzResourceServerSettings |
postClientsClientUuidAuthzResourceServerImportpostClientsClientUuidAuthzResourceServerImport | POST | postClientsClientUuidAuthzResourceServerImport |
postClientsClientUuidAuthzResourceServerPermissionpostClientsClientUuidAuthzResourceServerPermission | POST | postClientsClientUuidAuthzResourceServerPermission |
postClientsClientUuidAuthzResourceServerPermissionEvaluatepostClientsClientUuidAuthzResourceServerPermissionEvaluate | POST | postClientsClientUuidAuthzResourceServerPermissionEvaluate |
postClientsClientUuidAuthzResourceServerPolicypostClientsClientUuidAuthzResourceServerPolicy | POST | postClientsClientUuidAuthzResourceServerPolicy |
postClientsClientUuidAuthzResourceServerPolicyEvaluatepostClientsClientUuidAuthzResourceServerPolicyEvaluate | POST | postClientsClientUuidAuthzResourceServerPolicyEvaluate |
postClientsClientUuidAuthzResourceServerResourcepostClientsClientUuidAuthzResourceServerResource | POST | postClientsClientUuidAuthzResourceServerResource |
postClientsClientUuidAuthzResourceServerScopepostClientsClientUuidAuthzResourceServerScope | POST | postClientsClientUuidAuthzResourceServerScope |
putClientsClientUuidAuthzResourceServerputClientsClientUuidAuthzResourceServer | PUT | putClientsClientUuidAuthzResourceServer |
putClientsClientUuidAuthzResourceServerResourceResourceIdputClientsClientUuidAuthzResourceServerResourceResourceId | PUT | putClientsClientUuidAuthzResourceServerResourceResourceId |
putClientsClientUuidAuthzResourceServerScopeScopeIdputClientsClientUuidAuthzResourceServerScopeScopeId | PUT | putClientsClientUuidAuthzResourceServerScopeScopeId |
Attack Detection3
Clear any user login failures for all users This can release temporary disabled usersclearAllBruteForce | DELETE | Clear any user login failures for all users This can release temporary disabled users |
Clear any user login failures for the user This can release temporary disabled userclearBruteForce | DELETE | Clear any user login failures for the user This can release temporary disabled user |
Get status of a username in brute force detectiongetBruteForceStatus | GET | Get status of a username in brute force detection |
Authentication Management39
Add new authentication executionpostAuthenticationExecutions | POST | Add new authentication execution |
Add new authentication execution to a flowpostAuthenticationFlowsFlowAliasExecutionsExecution | POST | Add new authentication execution to a flow |
Add new flow with new execution to existing flowpostAuthenticationFlowsFlowAliasExecutionsFlow | POST | Add new flow with new execution to existing flow |
Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON objectpostAuthenticationFlowsFlowAliasCopy | POST | Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object |
Create a new authentication flowpostAuthenticationFlows | POST | Create a new authentication flow |
Create new authenticator configurationpostAuthenticationConfig | POST | Create new authenticator configuration |
Delete an authentication flowdeleteAuthenticationFlowsId | DELETE | Delete an authentication flow |
Delete authenticator configurationdeleteAuthenticationConfigId | DELETE | Delete authenticator configuration |
Delete executiondeleteAuthenticationExecutionsExecutionId | DELETE | Delete execution |
Delete required actiondeleteAuthenticationRequiredActionsAlias | DELETE | Delete required action |
Delete RequiredAction configurationdeleteAuthenticationRequiredActionsAliasConfig | DELETE | Delete RequiredAction configuration |
Get authentication executions for a flowgetAuthenticationFlowsFlowAliasExecutions | GET | Get authentication executions for a flow |
Get authentication flow for idgetAuthenticationFlowsId | GET | Get authentication flow for id |
Get authentication flows Returns a stream of authentication flows.getAuthenticationFlows | GET | Get authentication flows Returns a stream of authentication flows. |
Get authenticator configurationgetAuthenticationConfigId | GET | Get authenticator configuration |
Get authenticator provider's configuration descriptiongetAuthenticationConfigDescriptionProviderId | GET | Get authenticator provider's configuration description |
Get authenticator providers Returns a stream of authenticator providers.getAuthenticationAuthenticatorProviders | GET | Get authenticator providers Returns a stream of authenticator providers. |
Get client authenticator providers Returns a stream of client authenticator providers.getAuthenticationClientAuthenticatorProviders | GET | Get client authenticator providers Returns a stream of client authenticator providers. |
Get configuration descriptions for all clientsgetAuthenticationPerClientConfigDescription | GET | Get configuration descriptions for all clients |
Get execution's configurationgetAuthenticationExecutionsExecutionIdConfigId | GET | Get execution's configuration |
Get form action providers Returns a stream of form action providers.getAuthenticationFormActionProviders | GET | Get form action providers Returns a stream of form action providers. |
Get form providers Returns a stream of form providers.getAuthenticationFormProviders | GET | Get form providers Returns a stream of form providers. |
Get required action for aliasgetAuthenticationRequiredActionsAlias | GET | Get required action for alias |
Get required actions Returns a stream of required actions.getAuthenticationRequiredActions | GET | Get required actions Returns a stream of required actions. |
Get RequiredAction configurationgetAuthenticationRequiredActionsAliasConfig | GET | Get RequiredAction configuration |
Get RequiredAction provider configuration descriptiongetAuthenticationRequiredActionsAliasConfigDescription | GET | Get RequiredAction provider configuration description |
Get Single ExecutiongetAuthenticationExecutionsExecutionId | GET | Get Single Execution |
Get unregistered required actions Returns a stream of unregistered required actions.getAuthenticationUnregisteredRequiredActions | GET | Get unregistered required actions Returns a stream of unregistered required actions. |
Lower execution's prioritypostAuthenticationExecutionsExecutionIdLowerPriority | POST | Lower execution's priority |
Lower required action's prioritypostAuthenticationRequiredActionsAliasLowerPriority | POST | Lower required action's priority |
Raise execution's prioritypostAuthenticationExecutionsExecutionIdRaisePriority | POST | Raise execution's priority |
Raise required action's prioritypostAuthenticationRequiredActionsAliasRaisePriority | POST | Raise required action's priority |
Register a new required actionspostAuthenticationRegisterRequiredAction | POST | Register a new required actions |
Update an authentication flowputAuthenticationFlowsId | PUT | Update an authentication flow |
Update authentication executions of a FlowputAuthenticationFlowsFlowAliasExecutions | PUT | Update authentication executions of a Flow |
Update authenticator configurationputAuthenticationConfigId | PUT | Update authenticator configuration |
Update execution with new configurationpostAuthenticationExecutionsExecutionIdConfig | POST | Update execution with new configuration |
Update required actionputAuthenticationRequiredActionsAlias | PUT | Update required action |
Update RequiredAction configurationputAuthenticationRequiredActionsAliasConfig | PUT | Update RequiredAction configuration |
Client Attribute Certificate4
Generate a new certificate with new key pairpostClientsClientUuidCertificatesAttrGenerate | POST | Generate a new certificate with new key pair |
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.postClientsClientUuidCertificatesAttrGenerateAndDownload | POST | 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. |
Get a keystore file for the client, containing private key and public certificatepostClientsClientUuidCertificatesAttrDownload | POST | Get a keystore file for the client, containing private key and public certificate |
Get key infogetClientsClientUuidCertificatesAttr | GET | Get key info |
Client Initial Access3
Create a new initial access token.postClientsInitialAccess | POST | Create a new initial access token. |
deleteClientsInitialAccessIddeleteClientsInitialAccessId | DELETE | deleteClientsInitialAccessId |
getClientsInitialAccessgetClientsInitialAccess | GET | getClientsInitialAccess |
Client Registration Policy1
Base path for retrieve providers with the configProperties properly filledgetClientRegistrationPolicyProviders | GET | Base path for retrieve providers with the configProperties properly filled |
Client Role Mappings15
Add client-level roles to the user or group role mappingaddUserClientRoles | POST | Add client-level roles to the user or group role mapping |
Add client-level roles to the user or group role mappingpostGroupsGroupIdRoleMappingsClientsClientId | POST | Add client-level roles to the user or group role mapping |
Add client-level roles to the user or group role mappingpostOrganizationsOrgIdGroupsGroupIdRoleMappingsClientsClientId | POST | Add client-level roles to the user or group role mapping |
Delete client-level roles from user or group role mappingdeleteGroupsGroupIdRoleMappingsClientsClientId | DELETE | Delete client-level roles from user or group role mapping |
Delete client-level roles from user or group role mappingdeleteOrganizationsOrgIdGroupsGroupIdRoleMappingsClientsClientId | DELETE | Delete client-level roles from user or group role mapping |
Delete client-level roles from user or group role mappingremoveUserClientRoles | DELETE | Delete client-level roles from user or group role mapping |
Get available client-level roles that can be mapped to the user or groupgetGroupsGroupIdRoleMappingsClientsClientIdAvailable | GET | Get available client-level roles that can be mapped to the user or group |
Get available client-level roles that can be mapped to the user or groupgetOrganizationsOrgIdGroupsGroupIdRoleMappingsClientsClientIdAvailable | GET | Get available client-level roles that can be mapped to the user or group |
Get available client-level roles that can be mapped to the user or groupgetUsersUserIdRoleMappingsClientsClientIdAvailable | GET | Get available client-level roles that can be mapped to the user or group |
Get client-level role mappings for the user or group, and the appgetGroupsGroupIdRoleMappingsClientsClientId | GET | Get client-level role mappings for the user or group, and the app |
Get client-level role mappings for the user or group, and the appgetOrganizationsOrgIdGroupsGroupIdRoleMappingsClientsClientId | GET | Get client-level role mappings for the user or group, and the app |
Get client-level role mappings for the user or group, and the appgetUsersUserIdRoleMappingsClientsClientId | GET | Get client-level role mappings for the user or group, and the app |
Get effective client-level role mappings This recurses any composite rolesgetGroupsGroupIdRoleMappingsClientsClientIdComposite | GET | Get effective client-level role mappings This recurses any composite roles |
Get effective client-level role mappings This recurses any composite rolesgetOrganizationsOrgIdGroupsGroupIdRoleMappingsClientsClientIdComposite | GET | Get effective client-level role mappings This recurses any composite roles |
Get effective client-level role mappings This recurses any composite rolesgetUsersUserIdRoleMappingsClientsClientIdComposite | GET | Get effective client-level role mappings This recurses any composite roles |
Client Scopes10
Create a new client scope Client Scope’s name must be unique!postClientScopes | POST | Create a new client scope Client Scope’s name must be unique! |
Create a new client scope Client Scope’s name must be unique!postClientTemplates | POST | Create a new client scope Client Scope’s name must be unique! |
Delete the client scopedeleteClientScopesClientScopeId | DELETE | Delete the client scope |
Delete the client scopedeleteClientTemplatesClientScopeId | DELETE | Delete the client scope |
Get client scopes belonging to the realm Returns a list of client scopes belonging to the realmgetClientScopes | GET | Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm |
Get client scopes belonging to the realm Returns a list of client scopes belonging to the realmgetClientTemplates | GET | Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm |
Get representation of the client scopegetClientScopesClientScopeId | GET | Get representation of the client scope |
Get representation of the client scopegetClientTemplatesClientScopeId | GET | Get representation of the client scope |
Update the client scopeputClientScopesClientScopeId | PUT | Update the client scope |
Update the client scopeputClientTemplatesClientScopeId | PUT | Update the client scope |
Clients35
Create a new client Client’s client_id must be unique!createClient | POST | Create a new client Client’s client id must be unique! |
Create JSON with an example SAML response as payloadgetClientsClientUuidEvaluateScopesGenerateExampleSamlResponse | GET | Create JSON with an example SAML response as payload |
Create JSON with payload of example access tokengetClientsClientUuidEvaluateScopesGenerateExampleAccessToken | GET | Create JSON with payload of example access token |
Create JSON with payload of example id tokengetClientsClientUuidEvaluateScopesGenerateExampleIdToken | GET | Create JSON with payload of example id token |
Create JSON with payload of example user infogetClientsClientUuidEvaluateScopesGenerateExampleUserinfo | GET | Create JSON with payload of example user info |
Delete the clientdeleteClient | DELETE | Delete the client |
deleteClientsClientUuidDefaultClientScopesClientScopeIddeleteClientsClientUuidDefaultClientScopesClientScopeId | DELETE | deleteClientsClientUuidDefaultClientScopesClientScopeId |
deleteClientsClientUuidOptionalClientScopesClientScopeIddeleteClientsClientUuidOptionalClientScopesClientScopeId | DELETE | deleteClientsClientUuidOptionalClientScopesClientScopeId |
Generate a new registration access token for the clientpostClientsClientUuidRegistrationAccessToken | POST | Generate a new registration access token for the client |
Generate a new secret for the clientregenerateClientSecret | POST | Generate a new secret for the client |
Get a user dedicated to the service accountgetServiceAccountUser | GET | Get a user dedicated to the service account |
Get application offline session count Returns a number of offline user sessions associated with this client { "count": number }getClientsClientUuidOfflineSessionCount | GET | Get application offline session count Returns a number of offline user sessions associated with this client { "count": number } |
Get application session count Returns a number of user sessions associated with this client { "count": number }getClientsClientUuidSessionCount | GET | Get application session count Returns a number of user sessions associated with this client { "count": number } |
Get clients belonging to the realm.listClients | GET | If a client can’t be retrieved from the storage due to a problem with the underlying storage, it is silently removed from the returned list. |
Get default client scopes. Only name and ids are returned.getClientsClientUuidDefaultClientScopes | GET | Get default client scopes. |
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.getClientsClientUuidEvaluateScopesScopeMappingsRoleContainerIdGranted | GET | This contains scope mappings, which this client has directly, as well as scope mappings, which are granted to all client scopes, which are linked with this client. |
Get offline sessions for client. Returns a list of offline user sessions associated with this clientgetClientsClientUuidOfflineSessions | GET | Get offline sessions for client. |
Get optional client scopes. Only name and ids are returned.getClientsClientUuidOptionalClientScopes | GET | Get optional client scopes. |
Get representation of the clientgetClient | GET | Get representation of the client |
Get roles, which this client doesn't have scope for and can't have them in the accessToken issued for him.getClientsClientUuidEvaluateScopesScopeMappingsRoleContainerIdNotGranted | GET | Defacto all the other roles of particular role container, which are not in {@link getGrantedScopeMappings()} |
Get the client secretgetClientSecret | GET | Get the client secret |
Get the rotated client secretgetClientsClientUuidClientSecretRotated | GET | Get the rotated client secret |
Get user sessions for client. Returns a list of user sessions associated with this client.listClientUserSessions | GET | Get user sessions for client. |
getClientsClientUuidInstallationProvidersProviderIdgetClientsClientUuidInstallationProvidersProviderId | GET | getClientsClientUuidInstallationProvidersProviderId |
Invalidate the rotated secret for the clientdeleteClientsClientUuidClientSecretRotated | DELETE | Invalidate the rotated secret for the client |
Push the client's revocation policy to its admin URL If the client has an admin URL, push revocation policy to it.postClientsClientUuidPushRevocation | POST | Push the client's revocation policy to its admin URL If the client has an admin URL, push revocation policy to it. |
putClientsClientUuidDefaultClientScopesClientScopeIdputClientsClientUuidDefaultClientScopesClientScopeId | PUT | putClientsClientUuidDefaultClientScopesClientScopeId |
putClientsClientUuidOptionalClientScopesClientScopeIdputClientsClientUuidOptionalClientScopesClientScopeId | PUT | putClientsClientUuidOptionalClientScopesClientScopeId |
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 KeycloakpostClientsClientUuidNodes | POST | 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... |
Return list of all protocol mappers, which will be used when generating tokens issued for particular client.getClientsClientUuidEvaluateScopesProtocolMappers | GET | This means protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client. |
Return object stating whether client Authorization permissions have been initialized or not and a referencegetClientsClientUuidManagementPermissions | GET | Return object stating whether client Authorization permissions have been initialized or not and a reference |
Return object stating whether client Authorization permissions have been initialized or not and a referenceputClientsClientUuidManagementPermissions | PUT | Return object stating whether client Authorization permissions have been initialized or not and a reference |
Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.getClientsClientUuidTestNodesAvailable | GET | Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes. |
Unregister a cluster node from the clientdeleteClientsClientUuidNodesNode | DELETE | Unregister a cluster node from the client |
Update the clientupdateClient | PUT | Update the client |
Component6
deleteComponentsIddeleteComponentsId | DELETE | deleteComponentsId |
getComponentsgetComponents | GET | getComponents |
getComponentsIdgetComponentsId | GET | getComponentsId |
List of subcomponent types that are available to configure for a particular parent component.getComponentsIdSubComponentTypes | GET | List of subcomponent types that are available to configure for a particular parent component. |
postComponentspostComponents | POST | postComponents |
putComponentsIdputComponentsId | PUT | putComponentsId |
Groups11
create or add a top level realm groupSet or create child.createGroup | POST | This will update the group and set the parent if it exists. |
deleteGroupdeleteGroup | DELETE | deleteGroup |
Get group hierarchy. Only `name` and `id` are returned. `subGroups` are only returned when using the `search` or `q` parameter. If none of these parameters is provided, the top-level groups are returned without `subGroups` being filled.listGroups | GET | Get group hierarchy. |
Get users Returns a stream of users, filtered according to query parameterslistGroupMembers | GET | Get users Returns a stream of users, filtered according to query parameters |
getGroupgetGroup | GET | getGroup |
Return a paginated list of subgroups that have a parent group corresponding to the group on the URLgetGroupsGroupIdChildren | GET | Return a paginated list of subgroups that have a parent group corresponding to the group on the URL |
Return object stating whether client Authorization permissions have been initialized or not and a referencegetGroupsGroupIdManagementPermissions | GET | Return object stating whether client Authorization permissions have been initialized or not and a reference |
Return object stating whether client Authorization permissions have been initialized or not and a referenceputGroupsGroupIdManagementPermissions | PUT | Return object stating whether client Authorization permissions have been initialized or not and a reference |
Returns the groups counts.countGroups | GET | Returns the groups counts. |
Set or create child.addChildGroup | POST | This will just set the parent if it exists. |
Update group, ignores subgroups.updateGroup | PUT | Update group, ignores subgroups. |
Identity Providers17
Add a mapper to identity providerpostIdentityProviderInstancesAliasMappers | POST | Add a mapper to identity provider |
Create a new identity providercreateIdentityProvider | POST | Create a new identity provider |
Delete a mapper for the identity providerdeleteIdentityProviderInstancesAliasMappersId | DELETE | Delete a mapper for the identity provider |
Delete the identity providerdeleteIdentityProvider | DELETE | Delete the identity provider |
Export public broker configuration for identity providergetIdentityProviderInstancesAliasExport | GET | Export public broker configuration for identity provider |
Get mapper by id for the identity providergetIdentityProviderInstancesAliasMappersId | GET | Get mapper by id for the identity provider |
Get mapper types for identity providergetIdentityProviderInstancesAliasMapperTypes | GET | Get mapper types for identity provider |
Get mappers for identity providergetIdentityProviderInstancesAliasMappers | GET | Get mappers for identity provider |
Get the identity providergetIdentityProvider | GET | Get the identity provider |
Get the identity provider factory for that provider idgetIdentityProviderProvidersProviderId | GET | Get the identity provider factory for that provider id |
Import identity provider from JSON bodypostIdentityProviderImportConfig | POST | Import identity provider from uploaded JSON file |
List identity providerslistIdentityProviders | GET | List identity providers |
Reaload keys for the identity provider if the provider supports it, "true" is returned if reload was performed, "false" if not.getIdentityProviderInstancesAliasReloadKeys | GET | Reaload keys for the identity provider if the provider supports it, "true" is returned if reload was performed, "false" if not. |
Return object stating whether client Authorization permissions have been initialized or not and a referencegetIdentityProviderInstancesAliasManagementPermissions | GET | Return object stating whether client Authorization permissions have been initialized or not and a reference |
Return object stating whether client Authorization permissions have been initialized or not and a referenceputIdentityProviderInstancesAliasManagementPermissions | PUT | Return object stating whether client Authorization permissions have been initialized or not and a reference |
Update a mapper for the identity providerputIdentityProviderInstancesAliasMappersId | PUT | Update a mapper for the identity provider |
Update the identity providerupdateIdentityProvider | PUT | Update the identity provider |
Key1
getKeysgetKeys | GET | getKeys |
Organizations36
Add a user to this organization groupputOrganizationsOrgIdGroupsGroupIdMembersUserId | PUT | Adds an organization member to this group. |
Adds the identity provider with the specified id to the organizationpostOrganizationsOrgIdIdentityProviders | POST | Adds, or associates, an existing identity provider with the organization. |
Adds the user with the specified id as a member of the organizationpostOrganizationsOrgIdMembers | POST | Adds, or associates, an existing user with the organization. |
Create or move a subgrouppostOrganizationsOrgIdGroupsGroupIdChildren | POST | Creates a new subgroup under this organization group. |
Creates a new organizationpostOrganizations | POST | Creates a new organization |
Creates a new top-level group or moves an existing group to top-levelpostOrganizationsOrgIdGroups | POST | Creates a new top-level group in the organization. |
Delete an invitationdeleteOrganizationsOrgIdInvitationsId | DELETE | Delete an invitation |
Delete the organization groupdeleteOrganizationsOrgIdGroupsGroupId | DELETE | Deletes the organization group and all its subgroups |
Deletes the organizationdeleteOrganizationsOrgId | DELETE | Deletes the organization |
Get invitation by IDgetOrganizationsOrgIdInvitationsId | GET | Get invitation by ID |
Get invitations for the organizationgetOrganizationsOrgIdInvitations | GET | Get invitations for the organization |
Get members of this organization groupgetOrganizationsOrgIdGroupsGroupIdMembers | GET | Returns a paginated list of organization members that belong to this group |
Get organization group by pathgetOrganizationsOrgIdGroupsGroupByPathPath | GET | Returns the organization group with the specified path |
Get organization group representationgetOrganizationsOrgIdGroupsGroupId | GET | Get organization group representation |
Get organization groupsgetOrganizationsOrgIdGroups | GET | Returns organization groups. |
Get subgroups of this organization groupgetOrganizationsOrgIdGroupsGroupIdChildren | GET | Returns a paginated stream of subgroups that belong to this organization group |
Invites an existing user or sends a registration link to a new user, based on the provided e-mail address.postOrganizationsOrgIdMembersInviteUser | POST | If the user with the given e-mail address exists, it sends an invitation link, otherwise it sends a registration link. |
Invites an existing user to the organization, using the specified user idpostOrganizationsOrgIdMembersInviteExistingUser | POST | Invites an existing user to the organization, using the specified user id |
Remove a user from this organization groupdeleteOrganizationsOrgIdGroupsGroupIdMembersUserId | DELETE | Removes a user from this organization group. |
Removes the identity provider with the specified alias from the organizationdeleteOrganizationsOrgIdIdentityProvidersAlias | DELETE | Breaks the association between the identity provider and the organization. |
Removes the user with the specified id from the organizationdeleteOrganizationsOrgIdMembersMemberId | DELETE | Breaks the association between the user and organization. |
Resend an invitationpostOrganizationsOrgIdInvitationsIdResend | POST | Resend an invitation |
Returns a paginated list of organization members filtered according to the specified parametersgetOrganizationsOrgIdMembers | GET | Returns a paginated list of organization members filtered according to the specified parameters |
Returns a paginated list of organizations filtered according to the specified parametersgetOrganizations | GET | Returns a paginated list of organizations filtered according to the specified parameters |
Returns all identity providers associated with the organizationgetOrganizationsOrgIdIdentityProviders | GET | Returns all identity providers associated with the organization |
Returns number of members in the organization.getOrganizationsOrgIdMembersCount | GET | Returns number of members in the organization. |
Returns organization groups for the identity providergetOrganizationsOrgIdIdentityProvidersAliasGroups | GET | Returns organization groups that can be used in identity provider mappers. |
Returns the identity provider associated with the organization that has the specified aliasgetOrganizationsOrgIdIdentityProvidersAlias | GET | Searches for an identity provider with the given alias. |
Returns the member of the organization with the specified idgetOrganizationsOrgIdMembersMemberId | GET | Searches for auser with the given id. |
Returns the organization group memberships for a member with the specified idgetOrganizationsOrgIdMembersMemberIdGroups | GET | Searches for auser with the given id. |
Returns the organization representationgetOrganizationsOrgId | GET | Returns the organization representation |
Returns the organizations associated with the user that has the specified idgetOrganizationsMembersMemberIdOrganizations | GET | Returns the organizations associated with the user that has the specified id |
Returns the organizations associated with the user that has the specified idgetOrganizationsOrgIdMembersMemberIdOrganizations | GET | Returns the organizations associated with the user that has the specified id |
Returns the organizations counts.getOrganizationsCount | GET | Returns the organizations counts. |
Update organization groupputOrganizationsOrgIdGroupsGroupId | PUT | Updates the organization group's name, description, and attributes. |
Updates the organizationputOrganizationsOrgId | PUT | Updates the organization |
Protocol Mappers21
Create a mapperpostClientScopesClientScopeIdProtocolMappersModels | POST | Create a mapper |
Create a mapperpostClientTemplatesClientScopeIdProtocolMappersModels | POST | Create a mapper |
Create a mapperpostClientsClientUuidProtocolMappersModels | POST | Create a mapper |
Create multiple mapperspostClientScopesClientScopeIdProtocolMappersAddModels | POST | Create multiple mappers |
Create multiple mapperspostClientTemplatesClientScopeIdProtocolMappersAddModels | POST | Create multiple mappers |
Create multiple mapperspostClientsClientUuidProtocolMappersAddModels | POST | Create multiple mappers |
Delete the mapperdeleteClientScopesClientScopeIdProtocolMappersModelsId | DELETE | Delete the mapper |
Delete the mapperdeleteClientTemplatesClientScopeIdProtocolMappersModelsId | DELETE | Delete the mapper |
Delete the mapperdeleteClientsClientUuidProtocolMappersModelsId | DELETE | Delete the mapper |
Get mapper by idgetClientScopesClientScopeIdProtocolMappersModelsId | GET | Get mapper by id |
Get mapper by idgetClientTemplatesClientScopeIdProtocolMappersModelsId | GET | Get mapper by id |
Get mapper by idgetClientsClientUuidProtocolMappersModelsId | GET | Get mapper by id |
Get mappersgetClientScopesClientScopeIdProtocolMappersModels | GET | Get mappers |
Get mappersgetClientTemplatesClientScopeIdProtocolMappersModels | GET | Get mappers |
Get mappersgetClientsClientUuidProtocolMappersModels | GET | Get mappers |
Get mappers by name for a specific protocolgetClientScopesClientScopeIdProtocolMappersProtocolProtocol | GET | Get mappers by name for a specific protocol |
Get mappers by name for a specific protocolgetClientTemplatesClientScopeIdProtocolMappersProtocolProtocol | GET | Get mappers by name for a specific protocol |
Get mappers by name for a specific protocolgetClientsClientUuidProtocolMappersProtocolProtocol | GET | Get mappers by name for a specific protocol |
Update the mapperputClientScopesClientScopeIdProtocolMappersModelsId | PUT | Update the mapper |
Update the mapperputClientTemplatesClientScopeIdProtocolMappersModelsId | PUT | Update the mapper |
Update the mapperputClientsClientUuidProtocolMappersModelsId | PUT | Update the mapper |
Realms Admin48
Base path for importing clients under this realm.postClientDescriptionConverter | POST | Base path for importing clients under this realm. |
Base path for importing clients under this realm.postClientDescriptionConverterText | POST | Base path for importing clients under this realm. |
Base path for importing clients under this realm.postClientDescriptionConverterXml | POST | Base path for importing clients under this realm. |
Delete all admin eventsclearAdminEvents | DELETE | Delete all admin events |
Delete all eventsclearEvents | DELETE | Delete all events |
Delete the realmdeleteRealm | DELETE | Delete the realm |
deleteDefaultDefaultClientScopesClientScopeIddeleteDefaultDefaultClientScopesClientScopeId | DELETE | deleteDefaultDefaultClientScopesClientScopeId |
deleteDefaultGroupsGroupIddeleteDefaultGroupsGroupId | DELETE | deleteDefaultGroupsGroupId |
deleteDefaultOptionalClientScopesClientScopeIddeleteDefaultOptionalClientScopesClientScopeId | DELETE | deleteDefaultOptionalClientScopesClientScopeId |
deleteLocalizationLocaledeleteLocalizationLocale | DELETE | deleteLocalizationLocale |
deleteLocalizationLocaleKeydeleteLocalizationLocaleKey | DELETE | deleteLocalizationLocaleKey |
Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.listRealms | GET | Get accessible realms Returns a list of accessible realms. |
Get admin events Returns all admin events, or filters events based on URL query parameters listed herelistAdminEvents | GET | Get admin events Returns all admin events, or filters events based on URL query parameters listed here |
Get client session stats Returns a JSON map.clientSessionStats | GET | The key is the client id, the value is the number of sessions that currently are active with that client. |
Get events Returns all events, or filters them based on URL query parameters listed herelistEvents | GET | Get events Returns all events, or filters them based on URL query parameters listed here |
Get group hierarchy. Only name and ids are returned.getDefaultGroups | GET | Get group hierarchy. |
Get realm default client scopes. Only name and ids are returned.getDefaultDefaultClientScopes | GET | Get realm default client scopes. |
Get realm optional client scopes. Only name and ids are returned.getDefaultOptionalClientScopes | GET | Get realm optional client scopes. |
Get the events provider configuration Returns JSON object with events provider configurationgetEventsConfig | GET | Get the events provider configuration Returns JSON object with events provider configuration |
Get the top-level representation of the realm It will not include nested information like User and Client representations.getRealm | GET | Get the top-level representation of the realm It will not include nested information like User and Client representations. |
getClientPoliciesPoliciesgetClientPoliciesPolicies | GET | getClientPoliciesPolicies |
getClientPoliciesProfilesgetClientPoliciesProfiles | GET | getClientPoliciesProfiles |
getCredentialRegistratorsgetCredentialRegistrators | GET | getCredentialRegistrators |
getGroupByPathPathgetGroupByPathPath | GET | getGroupByPathPath |
getLocalizationgetLocalization | GET | getLocalization |
getLocalizationLocalegetLocalizationLocale | GET | getLocalizationLocale |
getLocalizationLocaleKeygetLocalizationLocaleKey | GET | getLocalizationLocaleKey |
getUsersManagementPermissionsgetUsersManagementPermissions | GET | getUsersManagementPermissions |
Import a realm. Imports a realm from a full representation of that realm.createRealm | POST | Realm name must be unique. |
Import localization from uploaded JSON filepostLocalizationLocale | POST | Import localization from uploaded JSON file |
List all client types available in the current realmgetClientTypes | GET | This endpoint returns a list of both global and realm level client types and the attributes they set |
Partial export of existing realm into a JSON file.postPartialExport | POST | Partial export of existing realm into a JSON file. |
Partial import from a JSON file to an existing realm.postPartialImport | POST | Partial import from a JSON file to an existing realm. |
Push the realm's revocation policy to any client that has an admin url associated with it.postPushRevocation | POST | Push the realm's revocation policy to any client that has an admin url associated with it. |
putClientPoliciesPoliciesputClientPoliciesPolicies | PUT | putClientPoliciesPolicies |
putClientPoliciesProfilesputClientPoliciesProfiles | PUT | putClientPoliciesProfiles |
putDefaultDefaultClientScopesClientScopeIdputDefaultDefaultClientScopesClientScopeId | PUT | putDefaultDefaultClientScopesClientScopeId |
putDefaultGroupsGroupIdputDefaultGroupsGroupId | PUT | putDefaultGroupsGroupId |
putDefaultOptionalClientScopesClientScopeIdputDefaultOptionalClientScopesClientScopeId | PUT | putDefaultOptionalClientScopesClientScopeId |
putEventsConfigputEventsConfig | PUT | Update the events provider Change the events provider and/or its configuration |
putLocalizationLocaleKeyputLocalizationLocaleKey | PUT | putLocalizationLocaleKey |
putUsersManagementPermissionsputUsersManagementPermissions | PUT | putUsersManagementPermissions |
Remove a specific user session.deleteSession | DELETE | Any client that has an admin url will also be told to invalidate this particular session. |
Removes all user sessions.logoutAllUsers | POST | Any client that has an admin url will also be told to invalidate any sessions they have. |
Test SMTP connection with current logged in userpostTestSMTPConnection | POST | Test SMTP connection with current logged in user |
Test SMTP connection with current logged in userpostTestSMTPConnectionForm | POST | Test SMTP connection with current logged in user |
Update a client typeputClientTypes | PUT | This endpoint allows you to update a realm level client type |
Update the top-level information of the realm Any user, roles or client information in the representation will be ignored.updateRealm | PUT | This will only update top-level attributes of the realm. |
Role Mapper18
Add realm-level role mappings to the useraddUserRealmRoles | POST | Add realm-level role mappings to the user |
Add realm-level role mappings to the userpostGroupsGroupIdRoleMappingsRealm | POST | Add realm-level role mappings to the user |
Add realm-level role mappings to the userpostOrganizationsOrgIdGroupsGroupIdRoleMappingsRealm | POST | Add realm-level role mappings to the user |
Delete realm-level role mappingsdeleteGroupsGroupIdRoleMappingsRealm | DELETE | Delete realm-level role mappings |
Delete realm-level role mappingsdeleteOrganizationsOrgIdGroupsGroupIdRoleMappingsRealm | DELETE | Delete realm-level role mappings |
Delete realm-level role mappingsremoveUserRealmRoles | DELETE | Delete realm-level role mappings |
Get effective realm-level role mappings This will recurse all composite roles to get the result.getGroupsGroupIdRoleMappingsRealmComposite | GET | Get effective realm-level role mappings This will recurse all composite roles to get the result. |
Get effective realm-level role mappings This will recurse all composite roles to get the result.getOrganizationsOrgIdGroupsGroupIdRoleMappingsRealmComposite | GET | Get effective realm-level role mappings This will recurse all composite roles to get the result. |
Get effective realm-level role mappings This will recurse all composite roles to get the result.getUsersUserIdRoleMappingsRealmComposite | GET | Get effective realm-level role mappings This will recurse all composite roles to get the result. |
Get realm-level role mappingsgetGroupsGroupIdRoleMappingsRealm | GET | Get realm-level role mappings |
Get realm-level role mappingsgetOrganizationsOrgIdGroupsGroupIdRoleMappingsRealm | GET | Get realm-level role mappings |
Get realm-level role mappingslistUserRealmRoles | GET | Get realm-level role mappings |
Get realm-level roles that can be mappedgetGroupsGroupIdRoleMappingsRealmAvailable | GET | Get realm-level roles that can be mapped |
Get realm-level roles that can be mappedgetOrganizationsOrgIdGroupsGroupIdRoleMappingsRealmAvailable | GET | Get realm-level roles that can be mapped |
Get realm-level roles that can be mappedgetUsersUserIdRoleMappingsRealmAvailable | GET | Get realm-level roles that can be mapped |
Get role mappingsgetGroupsGroupIdRoleMappings | GET | Get role mappings |
Get role mappingsgetOrganizationsOrgIdGroupsGroupIdRoleMappings | GET | Get role mappings |
Get role mappingsgetUsersUserIdRoleMappings | GET | Get role mappings |
Roles28
Add a composite to the rolepostClientsClientUuidRolesRoleNameComposites | POST | Add a composite to the role |
Add a composite to the rolepostRolesRoleNameComposites | POST | Add a composite to the role |
Create a new role for the realm or clientcreateClientRole | POST | Create a new role for the realm or client |
Create a new role for the realm or clientcreateRealmRole | POST | Create a new role for the realm or client |
Delete a role by namedeleteClientsClientUuidRolesRoleName | DELETE | Delete a role by name |
Delete a role by namedeleteRealmRole | DELETE | Delete a role by name |
Get a role by namegetClientsClientUuidRolesRoleName | GET | Get a role by name |
Get a role by namegetRealmRole | GET | Get a role by name |
Get all roles for the realm or clientlistClientRoles | GET | Get all roles for the realm or client |
Get all roles for the realm or clientlistRealmRoles | GET | Get all roles for the realm or client |
Get client-level roles for the client that are in the role's compositegetClientsClientUuidRolesRoleNameCompositesClientsTargetClientUuid | GET | Get client-level roles for the client that are in the role's composite |
Get client-level roles for the client that are in the role's compositegetRolesRoleNameCompositesClientsTargetClientUuid | GET | Get client-level roles for the client that are in the role's composite |
Get composites of the rolegetClientsClientUuidRolesRoleNameComposites | GET | Get composites of the role |
Get composites of the rolegetRolesRoleNameComposites | GET | Get composites of the role |
Get realm-level roles of the role's compositegetClientsClientUuidRolesRoleNameCompositesRealm | GET | Get realm-level roles of the role's composite |
Get realm-level roles of the role's compositegetRolesRoleNameCompositesRealm | GET | Get realm-level roles of the role's composite |
Remove roles from the role's compositedeleteClientsClientUuidRolesRoleNameComposites | DELETE | Remove roles from the role's composite |
Remove roles from the role's compositedeleteRolesRoleNameComposites | DELETE | Remove roles from the role's composite |
Return object stating whether role Authorization permissions have been initialized or not and a referencegetClientsClientUuidRolesRoleNameManagementPermissions | GET | Return object stating whether role Authorization permissions have been initialized or not and a reference |
Return object stating whether role Authorization permissions have been initialized or not and a referencegetRolesRoleNameManagementPermissions | GET | Return object stating whether role Authorization permissions have been initialized or not and a reference |
Return object stating whether role Authorization permissions have been initialized or not and a referenceputClientsClientUuidRolesRoleNameManagementPermissions | PUT | Return object stating whether role Authorization permissions have been initialized or not and a reference |
Return object stating whether role Authorization permissions have been initialized or not and a referenceputRolesRoleNameManagementPermissions | PUT | Return object stating whether role Authorization permissions have been initialized or not and a reference |
Returns a stream of groups that have the specified role namegetClientsClientUuidRolesRoleNameGroups | GET | Returns a stream of groups that have the specified role name |
Returns a stream of groups that have the specified role namegetRolesRoleNameGroups | GET | Returns a stream of groups that have the specified role name |
Returns a stream of users that have the specified role name.getClientsClientUuidRolesRoleNameUsers | GET | Returns a stream of users that have the specified role name. |
Returns a stream of users that have the specified role name.listRoleUsers | GET | Returns a stream of users that have the specified role name. |
Update a role by nameputClientsClientUuidRolesRoleName | PUT | Update a role by name |
Update a role by nameupdateRealmRole | PUT | Update a role by name |
Roles (by ID)10
Delete the roledeleteRolesByIdRoleId | DELETE | Delete the role |
Get a specific role's representationgetRolesByIdRoleId | GET | Get a specific role's representation |
Get client-level roles for the client that are in the role's compositegetRolesByIdRoleIdCompositesClientsClientUuid | GET | Get client-level roles for the client that are in the role's composite |
Get realm-level roles that are in the role's compositegetRolesByIdRoleIdCompositesRealm | GET | Get realm-level roles that are in the role's composite |
Get role's children Returns a set of role's children provided the role is a composite.getRolesByIdRoleIdComposites | GET | Get role's children Returns a set of role's children provided the role is a composite. |
Make the role a composite role by associating some child rolespostRolesByIdRoleIdComposites | POST | Make the role a composite role by associating some child roles |
Remove a set of roles from the role's compositedeleteRolesByIdRoleIdComposites | DELETE | Remove a set of roles from the role's composite |
Return object stating whether role Authorization permissions have been initialized or not and a referencegetRolesByIdRoleIdManagementPermissions | GET | Return object stating whether role Authorization permissions have been initialized or not and a reference |
Return object stating whether role Authorization permissions have been initialized or not and a referenceputRolesByIdRoleIdManagementPermissions | PUT | Return object stating whether role Authorization permissions have been initialized or not and a reference |
Update the roleputRolesByIdRoleId | PUT | Update the role |
Scope Mappings33
Add a set of realm-level roles to the client's scopepostClientScopesClientScopeIdScopeMappingsRealm | POST | Add a set of realm-level roles to the client's scope |
Add a set of realm-level roles to the client's scopepostClientTemplatesClientScopeIdScopeMappingsRealm | POST | Add a set of realm-level roles to the client's scope |
Add a set of realm-level roles to the client's scopepostClientsClientUuidScopeMappingsRealm | POST | Add a set of realm-level roles to the client's scope |
Add client-level roles to the client's scopepostClientScopesClientScopeIdScopeMappingsClientsClient | POST | Add client-level roles to the client's scope |
Add client-level roles to the client's scopepostClientTemplatesClientScopeIdScopeMappingsClientsClient | POST | Add client-level roles to the client's scope |
Add client-level roles to the client's scopepostClientsClientUuidScopeMappingsClientsClient | POST | Add client-level roles to the client's scope |
Get all scope mappings for the clientgetClientScopesClientScopeIdScopeMappings | GET | Get all scope mappings for the client |
Get all scope mappings for the clientgetClientTemplatesClientScopeIdScopeMappings | GET | Get all scope mappings for the client |
Get all scope mappings for the clientgetClientsClientUuidScopeMappings | GET | Get all scope mappings for the client |
Get effective client roles Returns the roles for the client that are associated with the client's scope.getClientScopesClientScopeIdScopeMappingsClientsClientComposite | GET | Get effective client roles Returns the roles for the client that are associated with the client's scope. |
Get effective client roles Returns the roles for the client that are associated with the client's scope.getClientTemplatesClientScopeIdScopeMappingsClientsClientComposite | GET | Get effective client roles Returns the roles for the client that are associated with the client's scope. |
Get effective client roles Returns the roles for the client that are associated with the client's scope.getClientsClientUuidScopeMappingsClientsClientComposite | GET | Get effective client roles Returns the roles for the client that are associated with the client's scope. |
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.getClientScopesClientScopeIdScopeMappingsRealmComposite | GET | |
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.getClientTemplatesClientScopeIdScopeMappingsRealmComposite | GET | |
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.getClientsClientUuidScopeMappingsRealmComposite | GET | |
Get realm-level roles associated with the client's scopegetClientScopesClientScopeIdScopeMappingsRealm | GET | Get realm-level roles associated with the client's scope |
Get realm-level roles associated with the client's scopegetClientTemplatesClientScopeIdScopeMappingsRealm | GET | Get realm-level roles associated with the client's scope |
Get realm-level roles associated with the client's scopegetClientsClientUuidScopeMappingsRealm | GET | Get realm-level roles associated with the client's scope |
Get realm-level roles that are available to attach to this client's scopegetClientScopesClientScopeIdScopeMappingsRealmAvailable | GET | Get realm-level roles that are available to attach to this client's scope |
Get realm-level roles that are available to attach to this client's scopegetClientTemplatesClientScopeIdScopeMappingsRealmAvailable | GET | Get realm-level roles that are available to attach to this client's scope |
Get realm-level roles that are available to attach to this client's scopegetClientsClientUuidScopeMappingsRealmAvailable | GET | Get realm-level roles that are available to attach to this client's scope |
Get the roles associated with a client's scope Returns roles for the client.getClientScopesClientScopeIdScopeMappingsClientsClient | GET | Get the roles associated with a client's scope Returns roles for the client. |
Get the roles associated with a client's scope Returns roles for the client.getClientTemplatesClientScopeIdScopeMappingsClientsClient | GET | Get the roles associated with a client's scope Returns roles for the client. |
Get the roles associated with a client's scope Returns roles for the client.getClientsClientUuidScopeMappingsClientsClient | GET | Get the roles associated with a client's scope Returns roles for the client. |
Remove a set of realm-level roles from the client's scopedeleteClientScopesClientScopeIdScopeMappingsRealm | DELETE | Remove a set of realm-level roles from the client's scope |
Remove a set of realm-level roles from the client's scopedeleteClientTemplatesClientScopeIdScopeMappingsRealm | DELETE | Remove a set of realm-level roles from the client's scope |
Remove a set of realm-level roles from the client's scopedeleteClientsClientUuidScopeMappingsRealm | DELETE | Remove a set of realm-level roles from the client's scope |
Remove client-level roles from the client's scope.deleteClientScopesClientScopeIdScopeMappingsClientsClient | DELETE | Remove client-level roles from the client's scope. |
Remove client-level roles from the client's scope.deleteClientTemplatesClientScopeIdScopeMappingsClientsClient | DELETE | Remove client-level roles from the client's scope. |
Remove client-level roles from the client's scope.deleteClientsClientUuidScopeMappingsClientsClient | DELETE | Remove client-level roles from the client's scope. |
The available client-level roles Returns the roles for the client that can be associated with the client's scopegetClientScopesClientScopeIdScopeMappingsClientsClientAvailable | GET | |
The available client-level roles Returns the roles for the client that can be associated with the client's scopegetClientTemplatesClientScopeIdScopeMappingsClientsClientAvailable | GET | |
The available client-level roles Returns the roles for the client that can be associated with the client's scopegetClientsClientUuidScopeMappingsClientsClientAvailable | GET |
Users34
Add a social login provider to the userpostUsersUserIdFederatedIdentityProvider | POST | Add a social login provider to the user |
addUserToGroupaddUserToGroup | PUT | addUserToGroup |
Create a new user Username must be unique.createUser | POST | Create a new user Username must be unique. |
Delete the userdeleteUser | DELETE | Delete the user |
Disable all credentials for a user of a specific typeputUsersUserIdDisableCredentialTypes | PUT | Disable all credentials for a user of a specific type |
Get consents granted by the usergetUsersUserIdConsents | GET | Get consents granted by the user |
Get offline sessions associated with the user and clientgetUsersUserIdOfflineSessionsClientUuid | GET | Get offline sessions associated with the user and client |
Get representation of the usergetUser | GET | Get representation of the user |
Get sessions associated with the userlistUserSessions | GET | Get sessions associated with the user |
Get social logins associated with the usergetUsersUserIdFederatedIdentity | GET | Get social logins associated with the user |
Get users Returns a stream of users, filtered according to query parameters.listUsers | GET | Returns a stream of users. |
getUsersProfilegetUsersProfile | GET | Get the configuration for the user profile |
getUsersProfileMetadatagetUsersProfileMetadata | GET | Get the UserProfileMetadata from the configuration |
getUsersUserIdGroupsCountgetUsersUserIdGroupsCount | GET | getUsersUserIdGroupsCount |
getUsersUserIdUnmanagedAttributesgetUsersUserIdUnmanagedAttributes | GET | getUsersUserIdUnmanagedAttributes |
Impersonate the userpostUsersUserIdImpersonation | POST | Impersonate the user |
listUserCredentialslistUserCredentials | GET | listUserCredentials |
listUserGroupslistUserGroups | GET | listUserGroups |
Move a credential to a first position in the credentials list of the userpostUsersUserIdCredentialsCredentialIdMoveToFirst | POST | Move a credential to a first position in the credentials list of the user |
Move a credential to a position behind another credentialpostUsersUserIdCredentialsCredentialIdMoveAfterNewPreviousCredentialId | POST | Move a credential to a position behind another credential |
putUsersProfileputUsersProfile | PUT | Set the configuration for the user profile |
Remove a credential for a userdeleteUserCredential | DELETE | Remove a credential for a user |
Remove a social login provider from userdeleteUsersUserIdFederatedIdentityProvider | DELETE | Remove a social login provider from user |
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.logoutUser | POST | 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. |
removeUserFromGroupremoveUserFromGroup | DELETE | removeUserFromGroup |
Return credential types, which are provided by the user storage where user is stored.getUsersUserIdConfiguredUserStorageCredentialTypes | GET | Returned values can contain for example "password", "otp" etc. This will always return empty list for "local" users, which are not backed by any user storage |
Returns the number of users that match the given criteria.countUsers | GET | It can be called in three different ways. |
Revoke consent and offline tokens for particular client from userdeleteUsersUserIdConsentsClient | DELETE | Revoke consent and offline tokens for particular client from user |
Send an email to the user with a link they can click to execute particular actions.executeActionsEmail | PUT | An email contains a link the user can click to perform a set of required actions. |
Send an email to the user with a link they can click to reset their password.putUsersUserIdResetPasswordEmail | PUT | The redirectUri and clientId parameters are optional. |
Send an email-verification email to the user An email contains a link the user can click to verify their email address.sendVerifyEmail | PUT | The redirectUri, clientId and lifespan parameters are optional. |
Set up a new password for the user.resetPassword | PUT | Set up a new password for the user. |
Update a credential label for a userputUsersUserIdCredentialsCredentialIdUserLabel | PUT | Update a credential label for a user |
Update the userupdateUser | PUT | Update the user |
Workflows11
Activate workflow for resourcepostWorkflowsIdActivateTypeResourceId | POST | Activate the workflow for the given resource type and identifier. |
Create workflowpostWorkflows | POST | Create a new workflow from the provided representation. |
Create workflowpostWorkflowsYaml | POST | Create a new workflow from the provided representation. |
Deactivate workflow for resourcepostWorkflowsIdDeactivateTypeResourceId | POST | Deactivate the workflow for the given resource type and identifier. |
Delete workflowdeleteWorkflowsId | DELETE | Delete the workflow and its configuration. |
Get workflowgetWorkflowsId | GET | Get the workflow representation. |
List scheduled workflows for resourcegetWorkflowsScheduledResourceId | GET | Return workflows that have scheduled steps for the given resource identifier. |
List workflowsgetWorkflows | GET | List workflows filtered by name and paginated using first and max parameters. |
Migrate scheduled resources from one step to anotherpostWorkflowsMigrate | POST | Migrate scheduled resources from one step to another step in the same or in a different workflow. |
Update workflowputWorkflowsId | PUT | Update the workflow configuration. |
Update workflowputWorkflowsIdYaml | PUT | Update the workflow configuration. |