{ "opencollection": "1.0.0", "info": { "name": "Keycloak Admin REST API", "version": "1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Root", "type": "folder" }, "items": [ { "info": { "name": "Get themes, social providers, auth providers, and event listeners available on this server", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/" }, "docs": "Get themes, social providers, auth providers, and event listeners available on this server" } ] }, { "info": { "name": "Realms Admin", "type": "folder" }, "items": [ { "info": { "name": "Import a realm Imports a realm from a full representation of that realm.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/", "body": { "type": "json", "data": "{}" } }, "docs": "Import a realm Imports a realm from a full representation of that realm." }, { "info": { "name": "Get the top-level representation of the realm It will not include nested information like User and Client representations.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get the top-level representation of the realm It will not include nested information like User and Client representations." }, { "info": { "name": "Update the top-level information of the realm Any user, roles or client information in the representation will be ignored.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the top-level information of the realm Any user, roles or client information in the representation will be ignored." }, { "info": { "name": "Delete the realm", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Delete the realm" }, { "info": { "name": "Get admin events Returns all admin events, or filters events based on URL query parameters listed here", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/admin-events", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "authClient", "value": "", "type": "query" }, { "name": "authIpAddress", "value": "", "type": "query" }, { "name": "authRealm", "value": "", "type": "query" }, { "name": "authUser", "value": "", "type": "query", "description": "user id" }, { "name": "dateFrom", "value": "", "type": "query" }, { "name": "dateTo", "value": "", "type": "query" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query", "description": "Maximum results size (defaults to 100)" }, { "name": "operationTypes", "value": "", "type": "query" }, { "name": "resourcePath", "value": "", "type": "query" }, { "name": "resourceTypes", "value": "", "type": "query" } ] }, "docs": "Get admin events Returns all admin events, or filters events based on URL query parameters listed here" }, { "info": { "name": "Delete all admin events", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/admin-events", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Delete all admin events" }, { "info": { "name": "Clear cache of external public keys (Public keys of clients or Identity providers)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clear-keys-cache", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Clear cache of external public keys (Public keys of clients or Identity providers)" }, { "info": { "name": "Clear realm cache", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clear-realm-cache", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Clear realm cache" }, { "info": { "name": "Clear user cache", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clear-user-cache", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Clear user cache" }, { "info": { "name": "Base path for importing clients under this realm.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/client-description-converter", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Base path for importing clients under this realm." }, { "info": { "name": "Get client policies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-policies/policies", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "include-global-policies", "value": "", "type": "query" } ] }, "docs": "Get client policies" }, { "info": { "name": "Update client policies", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/client-policies/policies", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update client policies" }, { "info": { "name": "Get client profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-policies/profiles", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "include-global-profiles", "value": "", "type": "query" } ] }, "docs": "Get client profiles" }, { "info": { "name": "Update client profiles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/client-policies/profiles", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update client profiles" }, { "info": { "name": "Get client session stats Returns a JSON map.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-session-stats", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get client session stats Returns a JSON map." }, { "info": { "name": "GET /{realm}/credential-registrators", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/credential-registrators", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] } }, { "info": { "name": "Get realm default client scopes.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/default-default-client-scopes", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get realm default client scopes." }, { "info": { "name": "PUT /{realm}/default-default-client-scopes/{clientScopeId}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/default-default-client-scopes/:clientScopeId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "clientScopeId", "value": "", "type": "path" } ] } }, { "info": { "name": "DELETE /{realm}/default-default-client-scopes/{clientScopeId}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/default-default-client-scopes/:clientScopeId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "clientScopeId", "value": "", "type": "path" } ] } }, { "info": { "name": "Get group hierarchy.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/default-groups", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get group hierarchy." }, { "info": { "name": "PUT /{realm}/default-groups/{groupId}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/default-groups/:groupId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "groupId", "value": "", "type": "path" } ] } }, { "info": { "name": "DELETE /{realm}/default-groups/{groupId}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/default-groups/:groupId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "groupId", "value": "", "type": "path" } ] } }, { "info": { "name": "Get realm optional client scopes.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/default-optional-client-scopes", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get realm optional client scopes." }, { "info": { "name": "PUT /{realm}/default-optional-client-scopes/{clientScopeId}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/default-optional-client-scopes/:clientScopeId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "clientScopeId", "value": "", "type": "path" } ] } }, { "info": { "name": "DELETE /{realm}/default-optional-client-scopes/{clientScopeId}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/default-optional-client-scopes/:clientScopeId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "clientScopeId", "value": "", "type": "path" } ] } }, { "info": { "name": "Get events Returns all events, or filters them based on URL query parameters listed here", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/events", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "client", "value": "", "type": "query", "description": "App or oauth client name" }, { "name": "dateFrom", "value": "", "type": "query", "description": "From date" }, { "name": "dateTo", "value": "", "type": "query", "description": "To date" }, { "name": "first", "value": "", "type": "query", "description": "Paging offset" }, { "name": "ipAddress", "value": "", "type": "query", "description": "IP address" }, { "name": "max", "value": "", "type": "query", "description": "Maximum results size (defaults to 100)" }, { "name": "type", "value": "", "type": "query", "description": "The types of events to return" }, { "name": "user", "value": "", "type": "query", "description": "User id" } ] }, "docs": "Get events Returns all events, or filters them based on URL query parameters listed here" }, { "info": { "name": "Delete all events", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/events", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Delete all events" }, { "info": { "name": "Get the events provider configuration Returns JSON object with events provider configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/events/config", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get the events provider configuration Returns JSON object with events provider configuration" }, { "info": { "name": "Update the events provider Change the events provider and/or its configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/events/config", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the events provider Change the events provider and/or its configuration" }, { "info": { "name": "GET /{realm}/group-by-path/{_path}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/group-by-path/:_path", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "_path", "value": "", "type": "path" } ] } }, { "info": { "name": "Removes all user sessions.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/logout-all", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Removes all user sessions." }, { "info": { "name": "Partial export of existing realm into a JSON file.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/partial-export", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "exportClients", "value": "", "type": "query" }, { "name": "exportGroupsAndRoles", "value": "", "type": "query" } ] }, "docs": "Partial export of existing realm into a JSON file." }, { "info": { "name": "Partial import from a JSON file to an existing realm.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/partialImport", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partial import from a JSON file to an existing realm." }, { "info": { "name": "Push the realm’s revocation policy to any client that has an admin url associated with it.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/push-revocation", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Push the realm’s revocation policy to any client that has an admin url associated with it." }, { "info": { "name": "Remove a specific user session.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/sessions/:session", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "session", "value": "", "type": "path" } ] }, "docs": "Remove a specific user session." }, { "info": { "name": "Test LDAP connection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/testLDAPConnection", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test LDAP connection" }, { "info": { "name": "POST /{realm}/testSMTPConnection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/testSMTPConnection", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /{realm}/users-management-permissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users-management-permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] } }, { "info": { "name": "PUT /{realm}/users-management-permissions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/users-management-permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "User Storage Provider", "type": "folder" }, "items": [ { "info": { "name": "Need this for admin console to display simple name of provider when displaying client detail KEYCLOAK-4328", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:id/name", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Need this for admin console to display simple name of provider when displaying client detail KEYCLOAK-4328" }, { "info": { "name": "Need this for admin console to display simple name of provider when displaying user detail KEYCLOAK-4328", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/user-storage/:id/name", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Need this for admin console to display simple name of provider when displaying user detail KEYCLOAK-4328" }, { "info": { "name": "Remove imported users", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/user-storage/:id/remove-imported-users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Remove imported users" }, { "info": { "name": "Trigger sync of users Action can be \"triggerFullSync\" or \"triggerChangedUsersSync\"", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/user-storage/:id/sync", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "action", "value": "", "type": "query" } ] }, "docs": "Trigger sync of users Action can be \"triggerFullSync\" or \"triggerChangedUsersSync\"" }, { "info": { "name": "Unlink imported users from a storage provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/user-storage/:id/unlink-users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Unlink imported users from a storage provider" }, { "info": { "name": "Trigger sync of mapper data related to ldap mapper (roles, groups, …​) direction is \"fedToKeycloak\" or \"keycloakToFed\"", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/user-storage/:parentId/mappers/:id/sync", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "parentId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "Trigger sync of mapper data related to ldap mapper (roles, groups, …​) direction is \"fedToKeycloak\" or \"keycloakToFed\"" } ] }, { "info": { "name": "Attack Detection", "type": "folder" }, "items": [ { "info": { "name": "Clear any user login failures for all users This can release temporary disabled users", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/attack-detection/brute-force/users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Clear any user login failures for all users This can release temporary disabled users" }, { "info": { "name": "Get status of a username in brute force detection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/attack-detection/brute-force/users/:userId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Get status of a username in brute force detection" }, { "info": { "name": "Clear any user login failures for the user This can release temporary disabled user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/attack-detection/brute-force/users/:userId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Clear any user login failures for the user This can release temporary disabled user" } ] }, { "info": { "name": "Authentication Management", "type": "folder" }, "items": [ { "info": { "name": "Get authenticator providers Returns a list of authenticator providers.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/authenticator-providers", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get authenticator providers Returns a list of authenticator providers." }, { "info": { "name": "Get client authenticator providers Returns a list of client authenticator providers.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/client-authenticator-providers", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get client authenticator providers Returns a list of client authenticator providers." }, { "info": { "name": "Get authenticator provider’s configuration description", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/config-description/:providerId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "providerId", "value": "", "type": "path" } ] }, "docs": "Get authenticator provider’s configuration description" }, { "info": { "name": "Get authenticator configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/config/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "Configuration id" } ] }, "docs": "Get authenticator configuration" }, { "info": { "name": "Update authenticator configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/authentication/config/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "Configuration id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update authenticator configuration" }, { "info": { "name": "Delete authenticator configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/authentication/config/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "Configuration id" } ] }, "docs": "Delete authenticator configuration" }, { "info": { "name": "Add new authentication execution", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/executions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add new authentication execution" }, { "info": { "name": "Get Single Execution", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/executions/:executionId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "executionId", "value": "", "type": "path", "description": "Execution id" } ] }, "docs": "Get Single Execution" }, { "info": { "name": "Delete execution", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/authentication/executions/:executionId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "executionId", "value": "", "type": "path", "description": "Execution id" } ] }, "docs": "Delete execution" }, { "info": { "name": "Update execution with new configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/executions/:executionId/config", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "executionId", "value": "", "type": "path", "description": "Execution id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update execution with new configuration" }, { "info": { "name": "Lower execution’s priority", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/executions/:executionId/lower-priority", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "executionId", "value": "", "type": "path", "description": "Execution id" } ] }, "docs": "Lower execution’s priority" }, { "info": { "name": "Raise execution’s priority", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/executions/:executionId/raise-priority", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "executionId", "value": "", "type": "path", "description": "Execution id" } ] }, "docs": "Raise execution’s priority" }, { "info": { "name": "Get authentication flows Returns a list of authentication flows.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/flows", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get authentication flows Returns a list of authentication flows." }, { "info": { "name": "Create a new authentication flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/flows", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new authentication flow" }, { "info": { "name": "Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/flows/:flowAlias/copy", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "flowAlias", "value": "", "type": "path", "description": "Name of the existing authentication flow" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object" }, { "info": { "name": "Get authentication executions for a flow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/flows/:flowAlias/executions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "flowAlias", "value": "", "type": "path", "description": "Flow alias" } ] }, "docs": "Get authentication executions for a flow" }, { "info": { "name": "Update authentication executions of a flow", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/authentication/flows/:flowAlias/executions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "flowAlias", "value": "", "type": "path", "description": "Flow alias" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update authentication executions of a flow" }, { "info": { "name": "Add new authentication execution to a flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/flows/:flowAlias/executions/execution", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "flowAlias", "value": "", "type": "path", "description": "Alias of parent flow" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add new authentication execution to a flow" }, { "info": { "name": "Add new flow with new execution to existing flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/flows/:flowAlias/executions/flow", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "flowAlias", "value": "", "type": "path", "description": "Alias of parent authentication flow" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add new flow with new execution to existing flow" }, { "info": { "name": "Get authentication flow for id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/flows/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "Flow id" } ] }, "docs": "Get authentication flow for id" }, { "info": { "name": "Update an authentication flow", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/authentication/flows/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "Flow id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an authentication flow" }, { "info": { "name": "Delete an authentication flow", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/authentication/flows/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "Flow id" } ] }, "docs": "Delete an authentication flow" }, { "info": { "name": "Get form action providers Returns a list of form action providers.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/form-action-providers", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get form action providers Returns a list of form action providers." }, { "info": { "name": "Get form providers Returns a list of form providers.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/form-providers", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get form providers Returns a list of form providers." }, { "info": { "name": "Get configuration descriptions for all clients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/per-client-config-description", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get configuration descriptions for all clients" }, { "info": { "name": "Register a new required actions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/register-required-action", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a new required actions" }, { "info": { "name": "Get required actions Returns a list of required actions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/required-actions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get required actions Returns a list of required actions." }, { "info": { "name": "Get required action for alias", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/required-actions/:alias", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path", "description": "Alias of required action" } ] }, "docs": "Get required action for alias" }, { "info": { "name": "Update required action", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/authentication/required-actions/:alias", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path", "description": "Alias of required action" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update required action" }, { "info": { "name": "Delete required action", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/authentication/required-actions/:alias", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path", "description": "Alias of required action" } ] }, "docs": "Delete required action" }, { "info": { "name": "Lower required action’s priority", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/required-actions/:alias/lower-priority", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path", "description": "Alias of required action" } ] }, "docs": "Lower required action’s priority" }, { "info": { "name": "Raise required action’s priority", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/authentication/required-actions/:alias/raise-priority", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path", "description": "Alias of required action" } ] }, "docs": "Raise required action’s priority" }, { "info": { "name": "Get unregistered required actions Returns a list of unregistered required actions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/authentication/unregistered-required-actions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get unregistered required actions Returns a list of unregistered required actions." } ] }, { "info": { "name": "Client Registration Policy", "type": "folder" }, "items": [ { "info": { "name": "Base path for retrieve providers with the configProperties properly filled", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-registration-policy/providers", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Base path for retrieve providers with the configProperties properly filled" } ] }, { "info": { "name": "Client Scopes", "type": "folder" }, "items": [ { "info": { "name": "Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm" }, { "info": { "name": "Create a new client scope Client Scope’s name must be unique!", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/client-scopes", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new client scope Client Scope’s name must be unique!" }, { "info": { "name": "Get representation of the client scope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ] }, "docs": "Get representation of the client scope" }, { "info": { "name": "Update the client scope", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/client-scopes/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the client scope" }, { "info": { "name": "Delete the client scope", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/client-scopes/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ] }, "docs": "Delete the client scope" } ] }, { "info": { "name": "Protocol Mappers", "type": "folder" }, "items": [ { "info": { "name": "Get mapper by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id1/protocol-mappers/models/:id2", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id1", "value": "", "type": "path" }, { "name": "id2", "value": "", "type": "path" } ] }, "docs": "Get mapper by id" }, { "info": { "name": "Update the mapper", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/client-scopes/:id1/protocol-mappers/models/:id2", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id1", "value": "", "type": "path" }, { "name": "id2", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the mapper" }, { "info": { "name": "Delete the mapper", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/client-scopes/:id1/protocol-mappers/models/:id2", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id1", "value": "", "type": "path" }, { "name": "id2", "value": "", "type": "path" } ] }, "docs": "Delete the mapper" }, { "info": { "name": "Create multiple mappers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/client-scopes/:id/protocol-mappers/add-models", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple mappers" }, { "info": { "name": "Get mappers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/protocol-mappers/models", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ] }, "docs": "Get mappers" }, { "info": { "name": "Create a mapper", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/client-scopes/:id/protocol-mappers/models", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a mapper" }, { "info": { "name": "Get mappers by name for a specific protocol", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/protocol-mappers/protocol/:protocol", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" }, { "name": "protocol", "value": "", "type": "path" } ] }, "docs": "Get mappers by name for a specific protocol" }, { "info": { "name": "Get mapper by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id1/protocol-mappers/models/:id2", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id1", "value": "", "type": "path" }, { "name": "id2", "value": "", "type": "path" } ] }, "docs": "Get mapper by id" }, { "info": { "name": "Update the mapper", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/clients/:id1/protocol-mappers/models/:id2", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id1", "value": "", "type": "path" }, { "name": "id2", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the mapper" }, { "info": { "name": "Delete the mapper", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id1/protocol-mappers/models/:id2", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id1", "value": "", "type": "path" }, { "name": "id2", "value": "", "type": "path" } ] }, "docs": "Delete the mapper" }, { "info": { "name": "Create multiple mappers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/protocol-mappers/add-models", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create multiple mappers" }, { "info": { "name": "Get mappers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/protocol-mappers/models", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get mappers" }, { "info": { "name": "Create a mapper", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/protocol-mappers/models", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a mapper" }, { "info": { "name": "Get mappers by name for a specific protocol", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/protocol-mappers/protocol/:protocol", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "protocol", "value": "", "type": "path" } ] }, "docs": "Get mappers by name for a specific protocol" } ] }, { "info": { "name": "Scope Mappings", "type": "folder" }, "items": [ { "info": { "name": "Get all scope mappings for the client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ] }, "docs": "Get all scope mappings for the client" }, { "info": { "name": "Get the roles associated with a client’s scope Returns roles for the client.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get the roles associated with a client’s scope Returns roles for the client." }, { "info": { "name": "Add client-level roles to the client’s scope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" }, { "name": "client", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add client-level roles to the client’s scope" }, { "info": { "name": "Remove client-level roles from the client’s scope.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" }, { "name": "client", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove client-level roles from the client’s scope." }, { "info": { "name": "The available client-level roles Returns the roles for the client that can be associated with the client’s scope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/clients/:client/available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "The available client-level roles Returns the roles for the client that can be associated with the client’s scope" }, { "info": { "name": "Get effective client roles Returns the roles for the client that are associated with the client’s scope.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/clients/:client/composite", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get effective client roles Returns the roles for the client that are associated with the client’s scope." }, { "info": { "name": "Get realm-level roles associated with the client’s scope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ] }, "docs": "Get realm-level roles associated with the client’s scope" }, { "info": { "name": "Add a set of realm-level roles to the client’s scope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a set of realm-level roles to the client’s scope" }, { "info": { "name": "Remove a set of realm-level roles from the client’s scope", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a set of realm-level roles from the client’s scope" }, { "info": { "name": "Get realm-level roles that are available to attach to this client’s scope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/realm/available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ] }, "docs": "Get realm-level roles that are available to attach to this client’s scope" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/client-scopes/:id/scope-mappings/realm/composite", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client scope (not name)" } ] }, "docs": "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." }, { "info": { "name": "Get all scope mappings for the client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get all scope mappings for the client" }, { "info": { "name": "Get the roles associated with a client’s scope Returns roles for the client.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get the roles associated with a client’s scope Returns roles for the client." }, { "info": { "name": "Add client-level roles to the client’s scope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "client", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add client-level roles to the client’s scope" }, { "info": { "name": "Remove client-level roles from the client’s scope.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "client", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove client-level roles from the client’s scope." }, { "info": { "name": "The available client-level roles Returns the roles for the client that can be associated with the client’s scope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/clients/:client/available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "The available client-level roles Returns the roles for the client that can be associated with the client’s scope" }, { "info": { "name": "Get effective client roles Returns the roles for the client that are associated with the client’s scope.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/clients/:client/composite", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get effective client roles Returns the roles for the client that are associated with the client’s scope." }, { "info": { "name": "Get realm-level roles associated with the client’s scope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get realm-level roles associated with the client’s scope" }, { "info": { "name": "Add a set of realm-level roles to the client’s scope", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a set of realm-level roles to the client’s scope" }, { "info": { "name": "Remove a set of realm-level roles from the client’s scope", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a set of realm-level roles from the client’s scope" }, { "info": { "name": "Get realm-level roles that are available to attach to this client’s scope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/realm/available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get realm-level roles that are available to attach to this client’s scope" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/scope-mappings/realm/composite", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "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." } ] }, { "info": { "name": "Clients", "type": "folder" }, "items": [ { "info": { "name": "Get clients belonging to the realm Returns a list of clients belonging to the realm", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "clientId", "value": "", "type": "query", "description": "filter by clientId" }, { "name": "first", "value": "", "type": "query", "description": "the first result" }, { "name": "max", "value": "", "type": "query", "description": "the max results to return" }, { "name": "search", "value": "", "type": "query", "description": "whether this is a search query or a getClientById query" }, { "name": "viewableOnly", "value": "", "type": "query", "description": "filter clients that cannot be viewed in full by admin" } ] }, "docs": "Get clients belonging to the realm Returns a list of clients belonging to the realm" }, { "info": { "name": "Create a new client Client’s client_id must be unique!", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new client Client’s client_id must be unique!" }, { "info": { "name": "Get representation of the client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get representation of the client" }, { "info": { "name": "Update the client", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/clients/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the client" }, { "info": { "name": "Delete the client", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Delete the client" }, { "info": { "name": "Get the client secret", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/client-secret", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get the client secret" }, { "info": { "name": "Generate a new secret for the client", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/client-secret", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Generate a new secret for the client" }, { "info": { "name": "Get the rotated client secret", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/client-secret/rotated", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get the rotated client secret" }, { "info": { "name": "Invalidate the rotated secret for the client", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id/client-secret/rotated", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Invalidate the rotated secret for the client" }, { "info": { "name": "Get default client scopes.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/default-client-scopes", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get default client scopes." }, { "info": { "name": "PUT /{realm}/clients/{id}/default-client-scopes/{clientScopeId}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/clients/:id/default-client-scopes/:clientScopeId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "clientScopeId", "value": "", "type": "path" } ] } }, { "info": { "name": "DELETE /{realm}/clients/{id}/default-client-scopes/{clientScopeId}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id/default-client-scopes/:clientScopeId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "clientScopeId", "value": "", "type": "path" } ] } }, { "info": { "name": "Create JSON with payload of example access token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/evaluate-scopes/generate-example-access-token", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "scope", "value": "", "type": "query" }, { "name": "userId", "value": "", "type": "query" } ] }, "docs": "Create JSON with payload of example access token" }, { "info": { "name": "Return list of all protocol mappers, which will be used when generating tokens issued for particular client.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/evaluate-scopes/protocol-mappers", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "scope", "value": "", "type": "query" } ] }, "docs": "Return list of all protocol mappers, which will be used when generating tokens issued for particular client." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/evaluate-scopes/scope-mappings/:roleContainerId/granted", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "roleContainerId", "value": "", "type": "path", "description": "either realm name OR client UUID" }, { "name": "scope", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Get roles, which this client doesn’t have scope for and can’t have them in the accessToken issued for him.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/evaluate-scopes/scope-mappings/:roleContainerId/not-granted", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "roleContainerId", "value": "", "type": "path", "description": "either realm name OR client UUID" }, { "name": "scope", "value": "", "type": "query" } ] }, "docs": "Get roles, which this client doesn’t have scope for and can’t have them in the accessToken issued for him." }, { "info": { "name": "GET /{realm}/clients/{id}/installation/providers/{providerId}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/installation/providers/:providerId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "providerId", "value": "", "type": "path" } ] } }, { "info": { "name": "Return object stating whether client Authorization permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Return object stating whether client Authorization permissions have been initialized or not and a reference" }, { "info": { "name": "Return object stating whether client Authorization permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/clients/:id/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return object stating whether client Authorization permissions have been initialized or not and a reference" }, { "info": { "name": "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", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/nodes", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Unregister a cluster node from the client", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id/nodes/:node", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "node", "value": "", "type": "path" } ] }, "docs": "Unregister a cluster node from the client" }, { "info": { "name": "Get application offline session count Returns a number of offline user sessions associated with this client { \"count\": number }", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/offline-session-count", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get application offline session count Returns a number of offline user sessions associated with this client { \"count\": number }" }, { "info": { "name": "Get offline sessions for client Returns a list of offline user sessions associated with this client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/offline-sessions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "first", "value": "", "type": "query", "description": "Paging offset" }, { "name": "max", "value": "", "type": "query", "description": "Maximum results size (defaults to 100)" } ] }, "docs": "Get offline sessions for client Returns a list of offline user sessions associated with this client" }, { "info": { "name": "Get optional client scopes.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/optional-client-scopes", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get optional client scopes." }, { "info": { "name": "PUT /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/clients/:id/optional-client-scopes/:clientScopeId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "clientScopeId", "value": "", "type": "path" } ] } }, { "info": { "name": "DELETE /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id/optional-client-scopes/:clientScopeId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "clientScopeId", "value": "", "type": "path" } ] } }, { "info": { "name": "Push the client’s revocation policy to its admin URL If the client has an admin URL, push revocation policy to it.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/push-revocation", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Push the client’s revocation policy to its admin URL If the client has an admin URL, push revocation policy to it." }, { "info": { "name": "Generate a new registration access token for the client", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/registration-access-token", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Generate a new registration access token for the client" }, { "info": { "name": "Get a user dedicated to the service account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/service-account-user", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get a user dedicated to the service account" }, { "info": { "name": "Get application session count Returns a number of user sessions associated with this client { \"count\": number }", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/session-count", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Get application session count Returns a number of user sessions associated with this client { \"count\": number }" }, { "info": { "name": "Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/test-nodes-available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ] }, "docs": "Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes." }, { "info": { "name": "Get user sessions for client Returns a list of user sessions associated with this client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/user-sessions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "first", "value": "", "type": "query", "description": "Paging offset" }, { "name": "max", "value": "", "type": "query", "description": "Maximum results size (defaults to 100)" } ] }, "docs": "Get user sessions for client Returns a list of user sessions associated with this client" } ] }, { "info": { "name": "Client Initial Access", "type": "folder" }, "items": [ { "info": { "name": "GET /{realm}/clients-initial-access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients-initial-access", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] } }, { "info": { "name": "Create a new initial access token.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients-initial-access", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new initial access token." }, { "info": { "name": "DELETE /{realm}/clients-initial-access/{id}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients-initial-access/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Client Attribute Certificate", "type": "folder" }, "items": [ { "info": { "name": "Get key info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/certificates/:attr", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "attr", "value": "", "type": "path" } ] }, "docs": "Get key info" }, { "info": { "name": "Get a keystore file for the client, containing private key and public certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/certificates/:attr/download", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "attr", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get a keystore file for the client, containing private key and public certificate" }, { "info": { "name": "Generate a new certificate with new key pair", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/certificates/:attr/generate", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "attr", "value": "", "type": "path" } ] }, "docs": "Generate a new certificate with new key pair" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/certificates/:attr/generate-and-download", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "attr", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Upload certificate and eventually private key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/certificates/:attr/upload", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "attr", "value": "", "type": "path" } ] }, "docs": "Upload certificate and eventually private key" }, { "info": { "name": "Upload only certificate, not private key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/certificates/:attr/upload-certificate", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "attr", "value": "", "type": "path" } ] }, "docs": "Upload only certificate, not private key" } ] }, { "info": { "name": "Roles", "type": "folder" }, "items": [ { "info": { "name": "Get all roles for the realm or client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/roles", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "briefRepresentation", "value": "", "type": "query" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" } ] }, "docs": "Get all roles for the realm or client" }, { "info": { "name": "Create a new role for the realm or client", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/roles", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new role for the realm or client" }, { "info": { "name": "Get a role by name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ] }, "docs": "Get a role by name" }, { "info": { "name": "Update a role by name", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a role by name" }, { "info": { "name": "Delete a role by name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ] }, "docs": "Delete a role by name" }, { "info": { "name": "Get composites of the role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ] }, "docs": "Get composites of the role" }, { "info": { "name": "Add a composite to the role", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a composite to the role" }, { "info": { "name": "Remove roles from the role’s composite", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove roles from the role’s composite" }, { "info": { "name": "An app-level roles for the specified app for the role’s composite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/composites/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "An app-level roles for the specified app for the role’s composite" }, { "info": { "name": "Get realm-level roles of the role’s composite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/composites/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ] }, "docs": "Get realm-level roles of the role’s composite" }, { "info": { "name": "Return List of Groups that have the specified role name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/groups", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path" }, { "name": "briefRepresentation", "value": "", "type": "query", "description": "if false, return a full representation of the GroupRepresentation objects" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" } ] }, "docs": "Return List of Groups that have the specified role name" }, { "info": { "name": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path" } ] }, "docs": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference" }, { "info": { "name": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference" }, { "info": { "name": "Return List of Users that have the specified role name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/clients/:id/roles/:role-name/users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "id of client (not client-id)" }, { "name": "role-name", "value": "", "type": "path" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" } ] }, "docs": "Return List of Users that have the specified role name" }, { "info": { "name": "Get all roles for the realm or client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "briefRepresentation", "value": "", "type": "query" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" } ] }, "docs": "Get all roles for the realm or client" }, { "info": { "name": "Create a new role for the realm or client", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/roles", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new role for the realm or client" }, { "info": { "name": "Get a role by name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles/:role-name", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ] }, "docs": "Get a role by name" }, { "info": { "name": "Update a role by name", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/roles/:role-name", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a role by name" }, { "info": { "name": "Delete a role by name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/roles/:role-name", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ] }, "docs": "Delete a role by name" }, { "info": { "name": "Get composites of the role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles/:role-name/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ] }, "docs": "Get composites of the role" }, { "info": { "name": "Add a composite to the role", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/roles/:role-name/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a composite to the role" }, { "info": { "name": "Remove roles from the role’s composite", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/roles/:role-name/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove roles from the role’s composite" }, { "info": { "name": "An app-level roles for the specified app for the role’s composite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles/:role-name/composites/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "An app-level roles for the specified app for the role’s composite" }, { "info": { "name": "Get realm-level roles of the role’s composite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles/:role-name/composites/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path", "description": "role’s name (not id!)" } ] }, "docs": "Get realm-level roles of the role’s composite" }, { "info": { "name": "Return List of Groups that have the specified role name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles/:role-name/groups", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path" }, { "name": "briefRepresentation", "value": "", "type": "query", "description": "if false, return a full representation of the GroupRepresentation objects" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" } ] }, "docs": "Return List of Groups that have the specified role name" }, { "info": { "name": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles/:role-name/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path" } ] }, "docs": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference" }, { "info": { "name": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/roles/:role-name/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference" }, { "info": { "name": "Return List of Users that have the specified role name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles/:role-name/users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-name", "value": "", "type": "path" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" } ] }, "docs": "Return List of Users that have the specified role name" } ] }, { "info": { "name": "Component", "type": "folder" }, "items": [ { "info": { "name": "GET /{realm}/components", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/components", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "name", "value": "", "type": "query" }, { "name": "parent", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" } ] } }, { "info": { "name": "POST /{realm}/components", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/components", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "GET /{realm}/components/{id}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/components/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "PUT /{realm}/components/{id}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/components/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "DELETE /{realm}/components/{id}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/components/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "List of subcomponent types that are available to configure for a particular parent component.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/components/:id/sub-component-types", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" } ] }, "docs": "List of subcomponent types that are available to configure for a particular parent component." } ] }, { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "Get group hierarchy.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "briefRepresentation", "value": "", "type": "query" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" } ] }, "docs": "Get group hierarchy." }, { "info": { "name": "create or add a top level realm groupSet or create child.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/groups", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "create or add a top level realm groupSet or create child." }, { "info": { "name": "Returns the groups counts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/count", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "search", "value": "", "type": "query" }, { "name": "top", "value": "", "type": "query" } ] }, "docs": "Returns the groups counts." }, { "info": { "name": "GET /{realm}/groups/{id}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "Update group, ignores subgroups.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/groups/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update group, ignores subgroups." }, { "info": { "name": "DELETE /{realm}/groups/{id}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/groups/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "Set or create child.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/groups/:id/children", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set or create child." }, { "info": { "name": "Return object stating whether client Authorization permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Return object stating whether client Authorization permissions have been initialized or not and a reference" }, { "info": { "name": "Return object stating whether client Authorization permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/groups/:id/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return object stating whether client Authorization permissions have been initialized or not and a reference" }, { "info": { "name": "Get users Returns a list of users, filtered according to query parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/members", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "briefRepresentation", "value": "", "type": "query", "description": "Only return basic information (only guaranteed to return id, username, created, first and last name,\n email, enabled state, email verification state, federation link, and access.\n Note that it means that namely user attributes, required actions, and not before are not returned.)" }, { "name": "first", "value": "", "type": "query", "description": "Pagination offset" }, { "name": "max", "value": "", "type": "query", "description": "Maximum results size (defaults to 100)" } ] }, "docs": "Get users Returns a list of users, filtered according to query parameters" } ] }, { "info": { "name": "Role Mapper", "type": "folder" }, "items": [ { "info": { "name": "Get role mappings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get role mappings" }, { "info": { "name": "Get realm-level role mappings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get realm-level role mappings" }, { "info": { "name": "Add realm-level role mappings to the user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add realm-level role mappings to the user" }, { "info": { "name": "Delete realm-level role mappings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete realm-level role mappings" }, { "info": { "name": "Get realm-level roles that can be mapped", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/realm/available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get realm-level roles that can be mapped" }, { "info": { "name": "Get effective realm-level role mappings This will recurse all composite roles to get the result.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/realm/composite", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get effective realm-level role mappings This will recurse all composite roles to get the result." }, { "info": { "name": "Get role mappings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/role-mappings", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Get role mappings" }, { "info": { "name": "Get realm-level role mappings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Get realm-level role mappings" }, { "info": { "name": "Add realm-level role mappings to the user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add realm-level role mappings to the user" }, { "info": { "name": "Delete realm-level role mappings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete realm-level role mappings" }, { "info": { "name": "Get realm-level roles that can be mapped", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/realm/available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Get realm-level roles that can be mapped" }, { "info": { "name": "Get effective realm-level role mappings This will recurse all composite roles to get the result.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/realm/composite", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Get effective realm-level role mappings This will recurse all composite roles to get the result." } ] }, { "info": { "name": "Client Role Mappings", "type": "folder" }, "items": [ { "info": { "name": "Get client-level role mappings for the user, and the app", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get client-level role mappings for the user, and the app" }, { "info": { "name": "Add client-level roles to the user role mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "client", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add client-level roles to the user role mapping" }, { "info": { "name": "Delete client-level roles from user role mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "client", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete client-level roles from user role mapping" }, { "info": { "name": "Get available client-level roles that can be mapped to the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/clients/:client/available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get available client-level roles that can be mapped to the user" }, { "info": { "name": "Get effective client-level role mappings This recurses any composite roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/groups/:id/role-mappings/clients/:client/composite", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get effective client-level role mappings This recurses any composite roles" }, { "info": { "name": "Get client-level role mappings for the user, and the app", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get client-level role mappings for the user, and the app" }, { "info": { "name": "Add client-level roles to the user role mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "client", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add client-level roles to the user role mapping" }, { "info": { "name": "Delete client-level roles from user role mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "client", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete client-level roles from user role mapping" }, { "info": { "name": "Get available client-level roles that can be mapped to the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/clients/:client/available", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get available client-level roles that can be mapped to the user" }, { "info": { "name": "Get effective client-level role mappings This recurses any composite roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/role-mappings/clients/:client/composite", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get effective client-level role mappings This recurses any composite roles" } ] }, { "info": { "name": "Identity Providers", "type": "folder" }, "items": [ { "info": { "name": "Import identity provider from uploaded JSON file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/identity-provider/import-config", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Import identity provider from uploaded JSON file" }, { "info": { "name": "Get identity providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/identity-provider/instances", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] }, "docs": "Get identity providers" }, { "info": { "name": "Create a new identity provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/identity-provider/instances", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new identity provider" }, { "info": { "name": "Get the identity provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" } ] }, "docs": "Get the identity provider" }, { "info": { "name": "Update the identity provider", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the identity provider" }, { "info": { "name": "Delete the identity provider", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" } ] }, "docs": "Delete the identity provider" }, { "info": { "name": "Export public broker configuration for identity provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/export", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" }, { "name": "format", "value": "", "type": "query", "description": "Format to use" } ] }, "docs": "Export public broker configuration for identity provider" }, { "info": { "name": "Return object stating whether client Authorization permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" } ] }, "docs": "Return object stating whether client Authorization permissions have been initialized or not and a reference" }, { "info": { "name": "Return object stating whether client Authorization permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return object stating whether client Authorization permissions have been initialized or not and a reference" }, { "info": { "name": "Get mapper types for identity provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/mapper-types", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" } ] }, "docs": "Get mapper types for identity provider" }, { "info": { "name": "Get mappers for identity provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/mappers", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" } ] }, "docs": "Get mappers for identity provider" }, { "info": { "name": "Add a mapper to identity provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/mappers", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a mapper to identity provider" }, { "info": { "name": "Get mapper by id for the identity provider", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/mappers/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "Mapper id" } ] }, "docs": "Get mapper by id for the identity provider" }, { "info": { "name": "Update a mapper for the identity provider", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/mappers/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "Mapper id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a mapper for the identity provider" }, { "info": { "name": "Delete a mapper for the identity provider", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/identity-provider/instances/:alias/mappers/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "alias", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "Mapper id" } ] }, "docs": "Delete a mapper for the identity provider" }, { "info": { "name": "Get identity providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/identity-provider/providers/:provider_id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "provider_id", "value": "", "type": "path", "description": "Provider id" } ] }, "docs": "Get identity providers" } ] }, { "info": { "name": "Key", "type": "folder" }, "items": [ { "info": { "name": "GET /{realm}/keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/keys", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ] } } ] }, { "info": { "name": "Roles (by ID)", "type": "folder" }, "items": [ { "info": { "name": "Get a specific role’s representation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path", "description": "id of role" } ] }, "docs": "Get a specific role’s representation" }, { "info": { "name": "Update the role", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path", "description": "id of role" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the role" }, { "info": { "name": "Delete the role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path", "description": "id of role" } ] }, "docs": "Delete the role" }, { "info": { "name": "Get role’s children Returns a set of role’s children provided the role is a composite.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path", "description": "Role id" } ] }, "docs": "Get role’s children Returns a set of role’s children provided the role is a composite." }, { "info": { "name": "Make the role a composite role by associating some child roles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path", "description": "Role id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make the role a composite role by associating some child roles" }, { "info": { "name": "Remove a set of roles from the role’s composite", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id/composites", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path", "description": "Role id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a set of roles from the role’s composite" }, { "info": { "name": "Get client-level roles for the client that are in the role’s composite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id/composites/clients/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path" }, { "name": "client", "value": "", "type": "path" } ] }, "docs": "Get client-level roles for the client that are in the role’s composite" }, { "info": { "name": "Get realm-level roles that are in the role’s composite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id/composites/realm", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path" } ] }, "docs": "Get realm-level roles that are in the role’s composite" }, { "info": { "name": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path" } ] }, "docs": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference" }, { "info": { "name": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/roles-by-id/:role-id/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "role-id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return object stating whether role Authoirzation permissions have been initialized or not and a reference" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Get users Returns a list of users, filtered according to query parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "briefRepresentation", "value": "", "type": "query" }, { "name": "email", "value": "", "type": "query" }, { "name": "first", "value": "", "type": "query" }, { "name": "firstName", "value": "", "type": "query" }, { "name": "lastName", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query", "description": "Maximum results size (defaults to 100)" }, { "name": "search", "value": "", "type": "query", "description": "A String contained in username, first or last name, or email" }, { "name": "username", "value": "", "type": "query" } ] }, "docs": "Get users Returns a list of users, filtered according to query parameters" }, { "info": { "name": "Create a new user Username must be unique.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user Username must be unique." }, { "info": { "name": "Returns the number of users that match the given criteria.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/count", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "email", "value": "", "type": "query", "description": "email filter" }, { "name": "firstName", "value": "", "type": "query", "description": "first name filter" }, { "name": "lastName", "value": "", "type": "query", "description": "last name filter" }, { "name": "search", "value": "", "type": "query", "description": "arbitrary search string for all the fields below" }, { "name": "username", "value": "", "type": "query", "description": "username filter" } ] }, "docs": "Returns the number of users that match the given criteria." }, { "info": { "name": "Get representation of the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Get representation of the user" }, { "info": { "name": "Update the user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/users/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the user" }, { "info": { "name": "Delete the user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/users/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Delete the user" }, { "info": { "name": "Return credential types, which are provided by the user storage where user is stored.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/configured-user-storage-credential-types", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Return credential types, which are provided by the user storage where user is stored." }, { "info": { "name": "Get consents granted by the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/consents", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Get consents granted by the user" }, { "info": { "name": "Revoke consent and offline tokens for particular client from user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/users/:id/consents/:client", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "client", "value": "", "type": "path", "description": "Client id" } ] }, "docs": "Revoke consent and offline tokens for particular client from user" }, { "info": { "name": "GET /{realm}/users/{id}/credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/credentials", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] } }, { "info": { "name": "Remove a credential for a user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/users/:id/credentials/:credentialId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "credentialId", "value": "", "type": "path" } ] }, "docs": "Remove a credential for a user" }, { "info": { "name": "Move a credential to a position behind another credential", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/users/:id/credentials/:credentialId/moveAfter/:newPreviousCredentialId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "credentialId", "value": "", "type": "path", "description": "The credential to move" }, { "name": "newPreviousCredentialId", "value": "", "type": "path", "description": "The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list." } ] }, "docs": "Move a credential to a position behind another credential" }, { "info": { "name": "Move a credential to a first position in the credentials list of the user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/users/:id/credentials/:credentialId/moveToFirst", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "credentialId", "value": "", "type": "path", "description": "The credential to move" } ] }, "docs": "Move a credential to a first position in the credentials list of the user" }, { "info": { "name": "Update a credential label for a user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/users/:id/credentials/:credentialId/userLabel", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "credentialId", "value": "", "type": "path" } ] }, "docs": "Update a credential label for a user" }, { "info": { "name": "Disable all credentials for a user of a specific type", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/users/:id/disable-credential-types", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable all credentials for a user of a specific type" }, { "info": { "name": "Send a update account email to the user An email contains a link the user can click to perform a set of required actions.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/users/:id/execute-actions-email", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "client_id", "value": "", "type": "query", "description": "Client id" }, { "name": "lifespan", "value": "", "type": "query", "description": "Number of seconds after which the generated token expires" }, { "name": "redirect_uri", "value": "", "type": "query", "description": "Redirect uri" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send a update account email to the user An email contains a link the user can click to perform a set of required actions." }, { "info": { "name": "Get social logins associated with the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/federated-identity", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Get social logins associated with the user" }, { "info": { "name": "Add a social login provider to the user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/users/:id/federated-identity/:provider", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "provider", "value": "", "type": "path", "description": "Social login provider id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a social login provider to the user" }, { "info": { "name": "Remove a social login provider from user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/users/:id/federated-identity/:provider", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "provider", "value": "", "type": "path", "description": "Social login provider id" } ] }, "docs": "Remove a social login provider from user" }, { "info": { "name": "GET /{realm}/users/{id}/groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/groups", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "briefRepresentation", "value": "", "type": "query" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" } ] } }, { "info": { "name": "GET /{realm}/users/{id}/groups/count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/groups/count", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "search", "value": "", "type": "query" } ] } }, { "info": { "name": "PUT /{realm}/users/{id}/groups/{groupId}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/users/:id/groups/:groupId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "groupId", "value": "", "type": "path" } ] } }, { "info": { "name": "DELETE /{realm}/users/{id}/groups/{groupId}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/:realm/users/:id/groups/:groupId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "groupId", "value": "", "type": "path" } ] } }, { "info": { "name": "Impersonate the user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/users/:id/impersonation", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Impersonate the user" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/:realm/users/:id/logout", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "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." }, { "info": { "name": "Get offline sessions associated with the user and client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/offline-sessions/:clientId", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "clientId", "value": "", "type": "path" } ] }, "docs": "Get offline sessions associated with the user and client" }, { "info": { "name": "Set up a new password for the user.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/users/:id/reset-password", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set up a new password for the user." }, { "info": { "name": "Send an email-verification email to the user An email contains a link the user can click to verify their email address.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/:realm/users/:id/send-verify-email", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" }, { "name": "client_id", "value": "", "type": "query", "description": "Client id" }, { "name": "redirect_uri", "value": "", "type": "query", "description": "Redirect uri" } ] }, "docs": "Send an email-verification email to the user An email contains a link the user can click to verify their email address." }, { "info": { "name": "Get sessions associated with the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/:realm/users/:id/sessions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path", "description": "User id" } ] }, "docs": "Get sessions associated with the user" } ] } ], "bundled": true }