2. If {@code search} is specified other criteria such as {@code last} will be ignored even though you set them. The {@code search} string will be matched against the first and last name, the username and the email of a user.
3. If {@code search} is unspecified but any of {@code last}, {@code first}, {@code email} or {@code username} those criteria are matched against their respective fields on a user entity. Combined with a logical and.", "parameters" : [ { "name" : "email", "in" : "query", "description" : "A String contained in email, or the complete email, if param \"exact\" is true", "schema" : { "type" : "string" } }, { "name" : "emailVerified", "in" : "query", "description" : "whether the email has been verified", "schema" : { "type" : "boolean" } }, { "name" : "enabled", "in" : "query", "description" : "Boolean representing if user is enabled or not", "schema" : { "type" : "boolean" } }, { "name" : "exact", "in" : "query", "description" : "Boolean which defines whether the params \"last\", \"first\", \"email\" and \"username\" must match exactly", "schema" : { "type" : "boolean" } }, { "name" : "firstName", "in" : "query", "description" : "A String contained in firstName, or the complete firstName, if param \"exact\" is true", "schema" : { "type" : "string" } }, { "name" : "idpAlias", "in" : "query", "description" : "The alias of an Identity Provider linked to the user", "schema" : { "type" : "string" } }, { "name" : "idpUserId", "in" : "query", "description" : "The userId at an Identity Provider linked to the user", "schema" : { "type" : "string" } }, { "name" : "lastName", "in" : "query", "description" : "A String contained in lastName, or the complete lastName, if param \"exact\" is true", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "description" : "A query to search for custom attributes, in the format 'key1:value2 key2:value2'", "schema" : { "type" : "string" } }, { "name" : "search", "in" : "query", "description" : "A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use *foo* for infix search and \"foo\" for exact search.", "schema" : { "type" : "string" } }, { "name" : "username", "in" : "query", "description" : "A String contained in username, or the complete username, if param \"exact\" is true", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "format" : "int32", "type" : "integer" } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/profile" : { "get" : { "tags" : [ "Users" ], "description" : "Get the configuration for the user profile", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UPConfig" } } } }, "403" : { "description" : "Forbidden" } } }, "put" : { "tags" : [ "Users" ], "description" : "Set the configuration for the user profile", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UPConfig" } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UPConfig" } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/profile/metadata" : { "get" : { "tags" : [ "Users" ], "description" : "Get the UserProfileMetadata from the configuration", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserProfileMetadata" } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}" : { "get" : { "tags" : [ "Users" ], "summary" : "Get representation of the user", "parameters" : [ { "name" : "userProfileMetadata", "in" : "query", "description" : "Indicates if the user profile metadata should be added to the response", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserRepresentation" } } } }, "403" : { "description" : "Forbidden" } } }, "put" : { "tags" : [ "Users" ], "summary" : "Update the user", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserRepresentation" } } } }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request", "content" : { } }, "403" : { "description" : "Forbidden" }, "409" : { "description" : "Conflict", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } } } }, "delete" : { "tags" : [ "Users" ], "summary" : "Delete the user", "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request", "content" : { } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/configured-user-storage-credential-types" : { "get" : { "tags" : [ "Users" ], "summary" : "Return credential types, which are provided by the user storage where user is stored.", "description" : "Returned values can contain for example \"password\", \"otp\" etc. This will always return empty list for \"local\" users, which are not backed by any user storage", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/consents" : { "get" : { "tags" : [ "Users" ], "summary" : "Get consents granted by the user", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { } } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/consents/{client}" : { "delete" : { "tags" : [ "Users" ], "summary" : "Revoke consent and offline tokens for particular client from user", "parameters" : [ { "name" : "client", "in" : "path", "description" : "Client id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/credentials" : { "get" : { "tags" : [ "Users" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CredentialRepresentation" } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/credentials/{credentialId}" : { "delete" : { "tags" : [ "Users" ], "summary" : "Remove a credential for a user", "parameters" : [ { "name" : "credentialId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}" : { "post" : { "tags" : [ "Users" ], "summary" : "Move a credential to a position behind another credential", "parameters" : [ { "name" : "credentialId", "in" : "path", "description" : "The credential to move", "required" : true, "schema" : { "type" : "string" } }, { "name" : "newPreviousCredentialId", "in" : "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.", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/moveToFirst" : { "post" : { "tags" : [ "Users" ], "summary" : "Move a credential to a first position in the credentials list of the user", "parameters" : [ { "name" : "credentialId", "in" : "path", "description" : "The credential to move", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/credentials/{credentialId}/userLabel" : { "put" : { "tags" : [ "Users" ], "summary" : "Update a credential label for a user", "parameters" : [ { "name" : "credentialId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/disable-credential-types" : { "put" : { "tags" : [ "Users" ], "summary" : "Disable all credentials for a user of a specific type", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/execute-actions-email" : { "put" : { "tags" : [ "Users" ], "summary" : "Send an email to the user with a link they can click to execute particular actions.", "description" : "An email contains a link the user can click to perform a set of required actions. The redirectUri and clientId parameters are optional. If no redirect is given, then there will be no link back to click after actions have completed. Redirect uri must be a valid uri for the particular clientId.", "parameters" : [ { "name" : "client_id", "in" : "query", "description" : "Client id", "schema" : { "type" : "string" } }, { "name" : "lifespan", "in" : "query", "description" : "Number of seconds after which the generated token expires", "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "redirect_uri", "in" : "query", "description" : "Redirect uri", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request", "content" : { } }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" }, "500" : { "description" : "Internal Server Error", "content" : { } } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/federated-identity" : { "get" : { "tags" : [ "Users" ], "summary" : "Get social logins associated with the user", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FederatedIdentityRepresentation" } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/federated-identity/{provider}" : { "post" : { "tags" : [ "Users" ], "summary" : "Add a social login provider to the user", "parameters" : [ { "name" : "provider", "in" : "path", "description" : "Social login provider id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FederatedIdentityRepresentation" } } } }, "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" }, "409" : { "description" : "Conflict", "content" : { } } } }, "delete" : { "tags" : [ "Users" ], "summary" : "Remove a social login provider from user", "parameters" : [ { "name" : "provider", "in" : "path", "description" : "Social login provider id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/groups" : { "get" : { "tags" : [ "Users" ], "parameters" : [ { "name" : "briefRepresentation", "in" : "query", "schema" : { "default" : true, "type" : "boolean" } }, { "name" : "first", "in" : "query", "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "max", "in" : "query", "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "search", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupRepresentation" } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/groups/count" : { "get" : { "tags" : [ "Users" ], "parameters" : [ { "name" : "search", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "format" : "int64", "type" : "integer" } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/groups/{groupId}" : { "put" : { "tags" : [ "Users" ], "parameters" : [ { "name" : "groupId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } } }, "delete" : { "tags" : [ "Users" ], "parameters" : [ { "name" : "groupId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" }, "500" : { "description" : "Internal Server Error", "content" : { } } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/impersonation" : { "post" : { "tags" : [ "Users" ], "summary" : "Impersonate the user", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorRepresentation" } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/logout" : { "post" : { "tags" : [ "Users" ], "summary" : "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.", "responses" : { "204" : { "description" : "No Content" }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/offline-sessions/{clientUuid}" : { "get" : { "tags" : [ "Users" ], "summary" : "Get offline sessions associated with the user and client", "parameters" : [ { "name" : "clientUuid", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserSessionRepresentation" } } } } }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/reset-password" : { "put" : { "tags" : [ "Users" ], "summary" : "Set up a new password for the user.", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CredentialRepresentation" } } } }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "500" : { "description" : "Internal Server Error", "content" : { } } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/reset-password-email" : { "put" : { "tags" : [ "Users" ], "summary" : "Send an email to the user with a link they can click to reset their password.", "description" : "The redirectUri and clientId parameters are optional. The default for the redirect is the account client. This endpoint has been deprecated. Please use the execute-actions-email passing a list with UPDATE_PASSWORD within it.", "parameters" : [ { "name" : "client_id", "in" : "query", "description" : "client id", "schema" : { "type" : "string" } }, { "name" : "redirect_uri", "in" : "query", "description" : "redirect uri", "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request", "content" : { } }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" }, "500" : { "description" : "Internal Server Error", "content" : { } } }, "deprecated" : true }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/role-mappings" : { "get" : { "tags" : [ "Role Mapper" ], "summary" : "Get role mappings", "responses" : { "200" : { "description" : "", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MappingsRepresentation" } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}" : { "get" : { "tags" : [ "Client Role Mappings" ], "summary" : "Get client-level role mappings for the user or group, and the app", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } } } }, "post" : { "tags" : [ "Client Role Mappings" ], "summary" : "Add client-level roles to the user or group role mapping", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } }, "responses" : { "204" : { "description" : "No Content" } } }, "delete" : { "tags" : [ "Client Role Mappings" ], "summary" : "Delete client-level roles from user or group role mapping", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } }, "responses" : { "204" : { "description" : "No Content" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "client-id", "in" : "path", "description" : "client id (not clientId!)", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}/available" : { "get" : { "tags" : [ "Client Role Mappings" ], "summary" : "Get available client-level roles that can be mapped to the user or group", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "client-id", "in" : "path", "description" : "client id (not clientId!)", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/role-mappings/clients/{client-id}/composite" : { "get" : { "tags" : [ "Client Role Mappings" ], "summary" : "Get effective client-level role mappings This recurses any composite roles", "parameters" : [ { "name" : "briefRepresentation", "in" : "query", "description" : "if false, return roles with their attributes", "schema" : { "default" : true, "type" : "boolean" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "client-id", "in" : "path", "description" : "client id (not clientId!)", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/role-mappings/realm" : { "get" : { "tags" : [ "Role Mapper" ], "summary" : "Get realm-level role mappings", "responses" : { "200" : { "description" : "", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } }, "403" : { "description" : "Forbidden" } } }, "post" : { "tags" : [ "Role Mapper" ], "summary" : "Add realm-level role mappings to the user", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" }, "500" : { "description" : "Internal Server Error" } } }, "delete" : { "tags" : [ "Role Mapper" ], "summary" : "Delete realm-level role mappings", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" }, "500" : { "description" : "Internal Server Error" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/role-mappings/realm/available" : { "get" : { "tags" : [ "Role Mapper" ], "summary" : "Get realm-level roles that can be mapped", "responses" : { "200" : { "description" : "", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/role-mappings/realm/composite" : { "get" : { "tags" : [ "Role Mapper" ], "summary" : "Get effective realm-level role mappings This will recurse all composite roles to get the result.", "parameters" : [ { "name" : "briefRepresentation", "in" : "query", "description" : "if false, return roles with their attributes", "schema" : { "default" : true, "type" : "boolean" } } ], "responses" : { "200" : { "description" : "", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/send-verify-email" : { "put" : { "tags" : [ "Users" ], "summary" : "Send an email-verification email to the user An email contains a link the user can click to verify their email address.", "description" : "The redirectUri, clientId and lifespan parameters are optional. The default for the redirect is the account client. The default for the lifespan is 12 hours", "parameters" : [ { "name" : "client_id", "in" : "query", "description" : "Client id", "schema" : { "type" : "string" } }, { "name" : "lifespan", "in" : "query", "description" : "Number of seconds after which the generated token expires", "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "redirect_uri", "in" : "query", "description" : "Redirect uri", "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request", "content" : { } }, "403" : { "description" : "Forbidden" }, "500" : { "description" : "Internal Server Error", "content" : { } } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/sessions" : { "get" : { "tags" : [ "Users" ], "summary" : "Get sessions associated with the user", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserSessionRepresentation" } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/users/{user-id}/unmanagedAttributes" : { "get" : { "tags" : [ "Users" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } } } } }, "403" : { "description" : "Forbidden" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "user-id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/workflows" : { "get" : { "tags" : [ "Workflows" ], "summary" : "List workflows", "description" : "List workflows filtered by name and paginated using first and max parameters.", "parameters" : [ { "name" : "exact", "in" : "query", "description" : "Boolean which defines whether the param 'search' must match exactly or not", "schema" : { "type" : "boolean" } }, { "name" : "first", "in" : "query", "description" : "The position of the first result to be processed (pagination offset)", "schema" : { "format" : "int32", "default" : "0", "type" : "integer" } }, { "name" : "max", "in" : "query", "description" : "The maximum number of results to be returned - defaults to 10", "schema" : { "format" : "int32", "default" : "10", "type" : "integer" } }, { "name" : "search", "in" : "query", "description" : "A String representing the workflow name - either partial or exact", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/yaml" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } } } }, "400" : { "description" : "Bad Request" } } }, "post" : { "tags" : [ "Workflows" ], "summary" : "Create workflow", "description" : "Create a new workflow from the provided representation.", "requestBody" : { "content" : { "application/yaml" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } } } }, "responses" : { "201" : { "description" : "Created" }, "400" : { "description" : "Bad Request" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/workflows/scheduled/{resource-id}" : { "get" : { "tags" : [ "Workflows" ], "summary" : "List scheduled workflows for resource", "description" : "Return workflows that have scheduled steps for the given resource identifier.", "parameters" : [ { "name" : "resource-id", "in" : "path", "description" : "Identifier of the resource associated with the scheduled workflows", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } } } }, "400" : { "description" : "Bad Request" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/workflows/{id}" : { "get" : { "tags" : [ "Workflows" ], "summary" : "Get workflow", "description" : "Get the workflow representation. Optionally exclude the workflow id from the response.", "parameters" : [ { "name" : "includeId", "in" : "query", "description" : "Indicates whether the workflow id should be included in the representation or not - defaults to true", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/yaml" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } } } }, "400" : { "description" : "Bad Request" } } }, "put" : { "tags" : [ "Workflows" ], "summary" : "Update workflow", "description" : "Update the workflow configuration. This method does not update the workflow steps.", "requestBody" : { "content" : { "application/yaml" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowRepresentation" } } } }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" } } }, "delete" : { "tags" : [ "Workflows" ], "summary" : "Delete workflow", "description" : "Delete the workflow and its configuration.", "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "description" : "Workflow identifier", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/workflows/{id}/activate/{type}/{resourceId}" : { "post" : { "tags" : [ "Workflows" ], "summary" : "Activate workflow for resource", "description" : "Activate the workflow for the given resource type and identifier. Optionally schedule the first step using the notBefore parameter.", "parameters" : [ { "name" : "resourceId", "in" : "path", "description" : "Resource identifier", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "description" : "Resource type", "required" : true, "schema" : { "type" : "object" } }, { "name" : "notBefore", "in" : "query", "description" : "Optional value representing the time to schedule the first workflow step. The value is either an integer representing the seconds from now, an integer followed by 'ms' representing milliseconds from now, or an ISO-8601 date string.", "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "description" : "Workflow identifier", "required" : true, "schema" : { "type" : "string" } } ] }, "/admin/realms/{realm}/workflows/{id}/deactivate/{type}/{resourceId}" : { "post" : { "tags" : [ "Workflows" ], "summary" : "Deactivate workflow for resource", "description" : "Deactivate the workflow for the given resource type and identifier.", "parameters" : [ { "name" : "resourceId", "in" : "path", "description" : "Resource identifier", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "description" : "Resource type", "required" : true, "schema" : { "type" : "object" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "description" : "Bad Request" } } }, "parameters" : [ { "name" : "realm", "in" : "path", "description" : "realm name (not id!)", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "description" : "Workflow identifier", "required" : true, "schema" : { "type" : "string" } } ] } }, "components" : { "schemas" : { "AbstractPolicyRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "type" : { "type" : "string" }, "policies" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "resources" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "logic" : { "$ref" : "#/components/schemas/Logic" }, "decisionStrategy" : { "$ref" : "#/components/schemas/DecisionStrategy" }, "owner" : { "type" : "string" }, "resourceType" : { "type" : "string" }, "resourcesData" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceRepresentation" } }, "scopesData" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeRepresentation" } } } }, "Access" : { "type" : "object", "properties" : { "roles" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "verify_caller" : { "type" : "boolean" } } }, "AccessToken" : { "type" : "object", "properties" : { "jti" : { "type" : "string" }, "exp" : { "format" : "int64", "type" : "integer" }, "nbf" : { "format" : "int64", "type" : "integer" }, "iat" : { "format" : "int64", "type" : "integer" }, "iss" : { "type" : "string" }, "sub" : { "type" : "string" }, "typ" : { "type" : "string" }, "azp" : { "type" : "string" }, "otherClaims" : { "type" : "object", "additionalProperties" : { } }, "nonce" : { "type" : "string" }, "auth_time" : { "format" : "int64", "type" : "integer" }, "sid" : { "type" : "string" }, "at_hash" : { "type" : "string" }, "c_hash" : { "type" : "string" }, "name" : { "type" : "string" }, "given_name" : { "type" : "string" }, "family_name" : { "type" : "string" }, "middle_name" : { "type" : "string" }, "nickname" : { "type" : "string" }, "preferred_username" : { "type" : "string" }, "profile" : { "type" : "string" }, "picture" : { "type" : "string" }, "website" : { "type" : "string" }, "email" : { "type" : "string" }, "email_verified" : { "type" : "boolean" }, "gender" : { "type" : "string" }, "birthdate" : { "type" : "string" }, "zoneinfo" : { "type" : "string" }, "locale" : { "type" : "string" }, "phone_number" : { "type" : "string" }, "phone_number_verified" : { "type" : "boolean" }, "updated_at" : { "format" : "int64", "type" : "integer" }, "claims_locales" : { "type" : "string" }, "acr" : { "type" : "string" }, "s_hash" : { "type" : "string" }, "trusted-certs" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "allowed-origins" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "realm_access" : { "$ref" : "#/components/schemas/Access" }, "resource_access" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Access" }, "writeOnly" : true }, "authorization" : { "$ref" : "#/components/schemas/Authorization" }, "cnf" : { "$ref" : "#/components/schemas/Confirmation" }, "scope" : { "type" : "string" } } }, "AdminEventRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "time" : { "format" : "int64", "type" : "integer" }, "realmId" : { "type" : "string" }, "authDetails" : { "$ref" : "#/components/schemas/AuthDetailsRepresentation" }, "operationType" : { "type" : "string" }, "resourceType" : { "type" : "string" }, "resourcePath" : { "type" : "string" }, "representation" : { "type" : "string" }, "error" : { "type" : "string" }, "details" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "ApplicationRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "clientId" : { "type" : "string" }, "description" : { "type" : "string" }, "type" : { "type" : "string" }, "rootUrl" : { "type" : "string" }, "adminUrl" : { "type" : "string" }, "baseUrl" : { "type" : "string" }, "surrogateAuthRequired" : { "type" : "boolean" }, "enabled" : { "type" : "boolean" }, "alwaysDisplayInConsole" : { "type" : "boolean" }, "clientAuthenticatorType" : { "type" : "string" }, "secret" : { "type" : "string" }, "registrationAccessToken" : { "type" : "string" }, "defaultRoles" : { "type" : "array", "items" : { "type" : "string" }, "deprecated" : true }, "redirectUris" : { "type" : "array", "items" : { "type" : "string" } }, "webOrigins" : { "type" : "array", "items" : { "type" : "string" } }, "notBefore" : { "format" : "int32", "type" : "integer" }, "bearerOnly" : { "type" : "boolean" }, "consentRequired" : { "type" : "boolean" }, "standardFlowEnabled" : { "type" : "boolean" }, "implicitFlowEnabled" : { "type" : "boolean" }, "directAccessGrantsEnabled" : { "type" : "boolean" }, "serviceAccountsEnabled" : { "type" : "boolean" }, "authorizationServicesEnabled" : { "type" : "boolean" }, "directGrantsOnly" : { "type" : "boolean", "deprecated" : true }, "publicClient" : { "type" : "boolean" }, "frontchannelLogout" : { "type" : "boolean" }, "protocol" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "authenticationFlowBindingOverrides" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "fullScopeAllowed" : { "type" : "boolean" }, "nodeReRegistrationTimeout" : { "format" : "int32", "type" : "integer" }, "registeredNodes" : { "type" : "object", "additionalProperties" : { "format" : "int32", "type" : "integer" } }, "protocolMappers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtocolMapperRepresentation" } }, "clientTemplate" : { "type" : "string", "deprecated" : true }, "useTemplateConfig" : { "type" : "boolean", "deprecated" : true }, "useTemplateScope" : { "type" : "boolean", "deprecated" : true }, "useTemplateMappers" : { "type" : "boolean", "deprecated" : true }, "defaultClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "optionalClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "authorizationSettings" : { "$ref" : "#/components/schemas/ResourceServerRepresentation" }, "access" : { "type" : "object", "additionalProperties" : { "type" : "boolean" } }, "origin" : { "type" : "string" }, "name" : { "type" : "string" }, "claims" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ClaimRepresentation" } ], "deprecated" : true } }, "deprecated" : true }, "AuthDetailsRepresentation" : { "type" : "object", "properties" : { "realmId" : { "type" : "string" }, "clientId" : { "type" : "string" }, "userId" : { "type" : "string" }, "ipAddress" : { "type" : "string" } } }, "AuthenticationExecutionExportRepresentation" : { "type" : "object", "properties" : { "authenticatorConfig" : { "type" : "string" }, "authenticator" : { "type" : "string" }, "authenticatorFlow" : { "type" : "boolean" }, "requirement" : { "type" : "string" }, "priority" : { "format" : "int32", "type" : "integer" }, "autheticatorFlow" : { "type" : "boolean", "deprecated" : true }, "flowAlias" : { "type" : "string" }, "userSetupAllowed" : { "type" : "boolean" } } }, "AuthenticationExecutionInfoRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "requirement" : { "type" : "string" }, "displayName" : { "type" : "string" }, "alias" : { "type" : "string" }, "description" : { "type" : "string" }, "requirementChoices" : { "type" : "array", "items" : { "type" : "string" } }, "configurable" : { "type" : "boolean" }, "authenticationFlow" : { "type" : "boolean" }, "providerId" : { "type" : "string" }, "authenticationConfig" : { "type" : "string" }, "flowId" : { "type" : "string" }, "level" : { "format" : "int32", "type" : "integer" }, "index" : { "format" : "int32", "type" : "integer" }, "priority" : { "format" : "int32", "type" : "integer" } } }, "AuthenticationExecutionRepresentation" : { "type" : "object", "properties" : { "authenticatorConfig" : { "type" : "string" }, "authenticator" : { "type" : "string" }, "authenticatorFlow" : { "type" : "boolean" }, "requirement" : { "type" : "string" }, "priority" : { "format" : "int32", "type" : "integer" }, "autheticatorFlow" : { "type" : "boolean", "deprecated" : true }, "id" : { "type" : "string" }, "flowId" : { "type" : "string" }, "parentFlow" : { "type" : "string" } } }, "AuthenticationFlowRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "alias" : { "type" : "string" }, "description" : { "type" : "string" }, "providerId" : { "type" : "string" }, "topLevel" : { "type" : "boolean" }, "builtIn" : { "type" : "boolean" }, "authenticationExecutions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AuthenticationExecutionExportRepresentation" } } } }, "AuthenticatorConfigInfoRepresentation" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "providerId" : { "type" : "string" }, "helpText" : { "type" : "string" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigPropertyRepresentation" } } } }, "AuthenticatorConfigRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "alias" : { "type" : "string" }, "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "Authorization" : { "type" : "object", "properties" : { "permissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Permission" } } } }, "AuthorizationSchema" : { "type" : "object", "properties" : { "resourceTypes" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ResourceType" } } } }, "BruteForceStrategy" : { "enum" : [ "LINEAR", "MULTIPLE" ], "type" : "string" }, "CertificateRepresentation" : { "type" : "object", "properties" : { "privateKey" : { "type" : "string" }, "publicKey" : { "type" : "string" }, "certificate" : { "type" : "string" }, "kid" : { "type" : "string" }, "jwks" : { "type" : "string" } } }, "ClaimRepresentation" : { "type" : "object", "properties" : { "name" : { "type" : "boolean" }, "username" : { "type" : "boolean" }, "profile" : { "type" : "boolean" }, "picture" : { "type" : "boolean" }, "website" : { "type" : "boolean" }, "email" : { "type" : "boolean" }, "gender" : { "type" : "boolean" }, "locale" : { "type" : "boolean" }, "address" : { "type" : "boolean" }, "phone" : { "type" : "boolean" } } }, "ClientInitialAccessCreatePresentation" : { "type" : "object", "properties" : { "expiration" : { "format" : "int32", "type" : "integer" }, "count" : { "format" : "int32", "type" : "integer" }, "webOrigins" : { "type" : "array", "items" : { "type" : "string" } } } }, "ClientInitialAccessPresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "token" : { "type" : "string" }, "timestamp" : { "format" : "int32", "type" : "integer" }, "expiration" : { "format" : "int32", "type" : "integer" }, "count" : { "format" : "int32", "type" : "integer" }, "remainingCount" : { "format" : "int32", "type" : "integer" } } }, "ClientMappingsRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "client" : { "type" : "string" }, "mappings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } } }, "ClientPoliciesRepresentation" : { "type" : "object", "properties" : { "policies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientPolicyRepresentation" } }, "globalPolicies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientPolicyRepresentation" } } } }, "ClientPolicyConditionRepresentation" : { "type" : "object", "properties" : { "condition" : { "type" : "string" }, "configuration" : { "description" : "Configuration settings as a JSON object", "type" : "object", "additionalProperties" : true } } }, "ClientPolicyExecutorRepresentation" : { "type" : "object", "properties" : { "executor" : { "type" : "string" }, "configuration" : { "description" : "Configuration settings as a JSON object", "type" : "object", "additionalProperties" : true } } }, "ClientPolicyRepresentation" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "conditions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientPolicyConditionRepresentation" } }, "profiles" : { "type" : "array", "items" : { "type" : "string" } } } }, "ClientProfileRepresentation" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "executors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientPolicyExecutorRepresentation" } } } }, "ClientProfilesRepresentation" : { "type" : "object", "properties" : { "profiles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientProfileRepresentation" } }, "globalProfiles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientProfileRepresentation" } } } }, "ClientRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "clientId" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "type" : { "type" : "string" }, "rootUrl" : { "type" : "string" }, "adminUrl" : { "type" : "string" }, "baseUrl" : { "type" : "string" }, "surrogateAuthRequired" : { "type" : "boolean" }, "enabled" : { "type" : "boolean" }, "alwaysDisplayInConsole" : { "type" : "boolean" }, "clientAuthenticatorType" : { "type" : "string" }, "secret" : { "type" : "string" }, "registrationAccessToken" : { "type" : "string" }, "defaultRoles" : { "type" : "array", "items" : { "type" : "string" }, "deprecated" : true }, "redirectUris" : { "type" : "array", "items" : { "type" : "string" } }, "webOrigins" : { "type" : "array", "items" : { "type" : "string" } }, "notBefore" : { "format" : "int32", "type" : "integer" }, "bearerOnly" : { "type" : "boolean" }, "consentRequired" : { "type" : "boolean" }, "standardFlowEnabled" : { "type" : "boolean" }, "implicitFlowEnabled" : { "type" : "boolean" }, "directAccessGrantsEnabled" : { "type" : "boolean" }, "serviceAccountsEnabled" : { "type" : "boolean" }, "authorizationServicesEnabled" : { "type" : "boolean" }, "directGrantsOnly" : { "type" : "boolean", "deprecated" : true }, "publicClient" : { "type" : "boolean" }, "frontchannelLogout" : { "type" : "boolean" }, "protocol" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "authenticationFlowBindingOverrides" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "fullScopeAllowed" : { "type" : "boolean" }, "nodeReRegistrationTimeout" : { "format" : "int32", "type" : "integer" }, "registeredNodes" : { "type" : "object", "additionalProperties" : { "format" : "int32", "type" : "integer" } }, "protocolMappers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtocolMapperRepresentation" } }, "clientTemplate" : { "type" : "string", "deprecated" : true }, "useTemplateConfig" : { "type" : "boolean", "deprecated" : true }, "useTemplateScope" : { "type" : "boolean", "deprecated" : true }, "useTemplateMappers" : { "type" : "boolean", "deprecated" : true }, "defaultClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "optionalClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "authorizationSettings" : { "$ref" : "#/components/schemas/ResourceServerRepresentation" }, "access" : { "type" : "object", "additionalProperties" : { "type" : "boolean" } }, "origin" : { "type" : "string" } } }, "ClientScopeRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "protocol" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "protocolMappers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtocolMapperRepresentation" } } } }, "ClientTemplateRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "protocol" : { "type" : "string" }, "fullScopeAllowed" : { "type" : "boolean" }, "bearerOnly" : { "type" : "boolean" }, "consentRequired" : { "type" : "boolean" }, "standardFlowEnabled" : { "type" : "boolean" }, "implicitFlowEnabled" : { "type" : "boolean" }, "directAccessGrantsEnabled" : { "type" : "boolean" }, "serviceAccountsEnabled" : { "type" : "boolean" }, "publicClient" : { "type" : "boolean" }, "frontchannelLogout" : { "type" : "boolean" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "protocolMappers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtocolMapperRepresentation" } } }, "deprecated" : true }, "ClientTypeRepresentation" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "provider" : { "type" : "string" }, "parent" : { "type" : "string" }, "config" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PropertyConfig" } } } }, "ClientTypesRepresentation" : { "type" : "object", "properties" : { "client-types" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientTypeRepresentation" } }, "global-client-types" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientTypeRepresentation" } } } }, "ComponentExportRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "providerId" : { "type" : "string" }, "subType" : { "type" : "string" }, "subComponents" : { "$ref" : "#/components/schemas/MultivaluedHashMapStringComponentExportRepresentation" }, "config" : { "$ref" : "#/components/schemas/MultivaluedHashMapStringString" } } }, "ComponentRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "providerId" : { "type" : "string" }, "providerType" : { "type" : "string" }, "parentId" : { "type" : "string" }, "subType" : { "type" : "string" }, "config" : { "$ref" : "#/components/schemas/MultivaluedHashMapStringString" } } }, "ComponentTypeRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "helpText" : { "type" : "string" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigPropertyRepresentation" } }, "clientProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigPropertyRepresentation" } }, "metadata" : { "type" : "object", "additionalProperties" : { } } } }, "Composites" : { "type" : "object", "properties" : { "realm" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "client" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "application" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "deprecated" : true } } }, "ConfigPropertyRepresentation" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "label" : { "type" : "string" }, "helpText" : { "type" : "string" }, "type" : { "type" : "string" }, "defaultValue" : { }, "options" : { "type" : "array", "items" : { "type" : "string" } }, "secret" : { "type" : "boolean" }, "required" : { "type" : "boolean" }, "readOnly" : { "type" : "boolean" } } }, "Confirmation" : { "type" : "object", "properties" : { "x5t#S256" : { "type" : "string" }, "jkt" : { "type" : "string" } } }, "CredentialRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string" }, "userLabel" : { "type" : "string" }, "createdDate" : { "format" : "int64", "type" : "integer" }, "secretData" : { "type" : "string" }, "credentialData" : { "type" : "string" }, "priority" : { "format" : "int32", "type" : "integer" }, "value" : { "type" : "string" }, "temporary" : { "type" : "boolean" }, "device" : { "type" : "string", "deprecated" : true }, "hashedSaltedValue" : { "type" : "string", "deprecated" : true }, "salt" : { "type" : "string", "deprecated" : true }, "hashIterations" : { "format" : "int32", "type" : "integer", "deprecated" : true }, "counter" : { "format" : "int32", "type" : "integer", "deprecated" : true }, "algorithm" : { "type" : "string", "deprecated" : true }, "digits" : { "format" : "int32", "type" : "integer", "deprecated" : true }, "period" : { "format" : "int32", "type" : "integer", "deprecated" : true }, "config" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/MultivaluedHashMapStringString" } ], "deprecated" : true }, "federationLink" : { "type" : "string" } } }, "DecisionEffect" : { "enum" : [ "PERMIT", "DENY" ], "type" : "string" }, "DecisionStrategy" : { "enum" : [ "AFFIRMATIVE", "UNANIMOUS", "CONSENSUS" ], "type" : "string" }, "ErrorRepresentation" : { "type" : "object", "properties" : { "field" : { "type" : "string" }, "errorMessage" : { "type" : "string" }, "params" : { "type" : "array", "items" : { } }, "errors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ErrorRepresentation" } } } }, "EvaluationResultRepresentation" : { "type" : "object", "properties" : { "resource" : { "$ref" : "#/components/schemas/ResourceRepresentation" }, "scopes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeRepresentation" } }, "policies" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyResultRepresentation" } }, "status" : { "$ref" : "#/components/schemas/DecisionEffect" }, "allowedScopes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeRepresentation" } }, "deniedScopes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeRepresentation" } } } }, "EventRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "time" : { "format" : "int64", "type" : "integer" }, "type" : { "type" : "string" }, "realmId" : { "type" : "string" }, "clientId" : { "type" : "string" }, "userId" : { "type" : "string" }, "sessionId" : { "type" : "string" }, "ipAddress" : { "type" : "string" }, "error" : { "type" : "string" }, "details" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "FederatedIdentityRepresentation" : { "type" : "object", "properties" : { "identityProvider" : { "type" : "string" }, "userId" : { "type" : "string" }, "userName" : { "type" : "string" } } }, "GlobalRequestResult" : { "type" : "object", "properties" : { "successRequests" : { "type" : "array", "items" : { "type" : "string" } }, "failedRequests" : { "type" : "array", "items" : { "type" : "string" } } } }, "GroupRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "path" : { "type" : "string" }, "parentId" : { "type" : "string" }, "subGroupCount" : { "format" : "int64", "type" : "integer" }, "subGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupRepresentation" } }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "realmRoles" : { "type" : "array", "items" : { "type" : "string" } }, "clientRoles" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "access" : { "type" : "object", "additionalProperties" : { "type" : "boolean" } } } }, "IDToken" : { "type" : "object", "properties" : { "jti" : { "type" : "string" }, "exp" : { "format" : "int64", "type" : "integer" }, "nbf" : { "format" : "int64", "type" : "integer" }, "iat" : { "format" : "int64", "type" : "integer" }, "iss" : { "type" : "string" }, "sub" : { "type" : "string" }, "typ" : { "type" : "string" }, "azp" : { "type" : "string" }, "otherClaims" : { "type" : "object", "additionalProperties" : { } }, "nonce" : { "type" : "string" }, "auth_time" : { "format" : "int64", "type" : "integer" }, "sid" : { "type" : "string" }, "at_hash" : { "type" : "string" }, "c_hash" : { "type" : "string" }, "name" : { "type" : "string" }, "given_name" : { "type" : "string" }, "family_name" : { "type" : "string" }, "middle_name" : { "type" : "string" }, "nickname" : { "type" : "string" }, "preferred_username" : { "type" : "string" }, "profile" : { "type" : "string" }, "picture" : { "type" : "string" }, "website" : { "type" : "string" }, "email" : { "type" : "string" }, "email_verified" : { "type" : "boolean" }, "gender" : { "type" : "string" }, "birthdate" : { "type" : "string" }, "zoneinfo" : { "type" : "string" }, "locale" : { "type" : "string" }, "phone_number" : { "type" : "string" }, "phone_number_verified" : { "type" : "boolean" }, "updated_at" : { "format" : "int64", "type" : "integer" }, "claims_locales" : { "type" : "string" }, "acr" : { "type" : "string" }, "s_hash" : { "type" : "string" } } }, "IdentityProviderMapperRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "identityProviderAlias" : { "type" : "string" }, "identityProviderMapper" : { "type" : "string" }, "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "IdentityProviderMapperTypeRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "category" : { "type" : "string" }, "helpText" : { "type" : "string" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigPropertyRepresentation" } } } }, "IdentityProviderRepresentation" : { "type" : "object", "properties" : { "alias" : { "type" : "string" }, "displayName" : { "type" : "string" }, "internalId" : { "type" : "string" }, "providerId" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "updateProfileFirstLoginMode" : { "type" : "string", "deprecated" : true }, "trustEmail" : { "type" : "boolean" }, "storeToken" : { "type" : "boolean" }, "addReadTokenRoleOnCreate" : { "type" : "boolean" }, "authenticateByDefault" : { "type" : "boolean" }, "linkOnly" : { "type" : "boolean" }, "hideOnLogin" : { "type" : "boolean" }, "firstBrokerLoginFlowAlias" : { "type" : "string" }, "postBrokerLoginFlowAlias" : { "type" : "string" }, "organizationId" : { "type" : "string" }, "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "types" : { "type" : "array", "items" : { "type" : "string" } }, "updateProfileFirstLogin" : { "type" : "boolean", "deprecated" : true } } }, "KeyMetadataRepresentation" : { "type" : "object", "properties" : { "providerId" : { "type" : "string" }, "providerPriority" : { "format" : "int64", "type" : "integer" }, "kid" : { "type" : "string" }, "status" : { "type" : "string" }, "type" : { "type" : "string" }, "algorithm" : { "type" : "string" }, "publicKey" : { "type" : "string" }, "certificate" : { "type" : "string" }, "use" : { "$ref" : "#/components/schemas/KeyUse" }, "validTo" : { "format" : "int64", "type" : "integer" } } }, "KeyStoreConfig" : { "type" : "object", "properties" : { "realmCertificate" : { "type" : "boolean" }, "storePassword" : { "type" : "string" }, "keyPassword" : { "type" : "string" }, "keyAlias" : { "type" : "string" }, "realmAlias" : { "type" : "string" }, "format" : { "type" : "string" }, "keySize" : { "format" : "int32", "type" : "integer" }, "validity" : { "format" : "int32", "type" : "integer" } } }, "KeyUse" : { "enum" : [ "SIG", "ENC", "JWT_SVID" ], "type" : "string" }, "KeysMetadataRepresentation" : { "type" : "object", "properties" : { "active" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "keys" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeyMetadataRepresentation" } } } }, "Logic" : { "enum" : [ "POSITIVE", "NEGATIVE" ], "type" : "string" }, "ManagementPermissionReference" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "resource" : { "type" : "string" }, "scopePermissions" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "MappingsRepresentation" : { "type" : "object", "properties" : { "realmMappings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } }, "clientMappings" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ClientMappingsRepresentation" } } } }, "MemberRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "username" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "email" : { "type" : "string" }, "emailVerified" : { "type" : "boolean" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "userProfileMetadata" : { "$ref" : "#/components/schemas/UserProfileMetadata" }, "enabled" : { "type" : "boolean" }, "self" : { "type" : "string" }, "origin" : { "type" : "string" }, "createdTimestamp" : { "format" : "int64", "type" : "integer" }, "totp" : { "type" : "boolean" }, "federationLink" : { "type" : "string" }, "serviceAccountClientId" : { "type" : "string" }, "credentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CredentialRepresentation" } }, "disableableCredentialTypes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "requiredActions" : { "type" : "array", "items" : { "type" : "string" } }, "federatedIdentities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FederatedIdentityRepresentation" } }, "realmRoles" : { "type" : "array", "items" : { "type" : "string" } }, "clientRoles" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "clientConsents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserConsentRepresentation" } }, "notBefore" : { "format" : "int32", "type" : "integer" }, "applicationRoles" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "deprecated" : true }, "socialLinks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SocialLinkRepresentation" }, "deprecated" : true }, "groups" : { "type" : "array", "items" : { "type" : "string" } }, "access" : { "type" : "object", "additionalProperties" : { "type" : "boolean" } }, "membershipType" : { "$ref" : "#/components/schemas/MembershipType" } } }, "MembershipType" : { "enum" : [ "UNMANAGED", "MANAGED" ], "type" : "string" }, "MultivaluedHashMapStringComponentExportRepresentation" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ComponentExportRepresentation" } } }, "MultivaluedHashMapStringString" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "OAuthClientRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "clientId" : { "type" : "string" }, "description" : { "type" : "string" }, "type" : { "type" : "string" }, "rootUrl" : { "type" : "string" }, "adminUrl" : { "type" : "string" }, "baseUrl" : { "type" : "string" }, "surrogateAuthRequired" : { "type" : "boolean" }, "enabled" : { "type" : "boolean" }, "alwaysDisplayInConsole" : { "type" : "boolean" }, "clientAuthenticatorType" : { "type" : "string" }, "secret" : { "type" : "string" }, "registrationAccessToken" : { "type" : "string" }, "defaultRoles" : { "type" : "array", "items" : { "type" : "string" }, "deprecated" : true }, "redirectUris" : { "type" : "array", "items" : { "type" : "string" } }, "webOrigins" : { "type" : "array", "items" : { "type" : "string" } }, "notBefore" : { "format" : "int32", "type" : "integer" }, "bearerOnly" : { "type" : "boolean" }, "consentRequired" : { "type" : "boolean" }, "standardFlowEnabled" : { "type" : "boolean" }, "implicitFlowEnabled" : { "type" : "boolean" }, "directAccessGrantsEnabled" : { "type" : "boolean" }, "serviceAccountsEnabled" : { "type" : "boolean" }, "authorizationServicesEnabled" : { "type" : "boolean" }, "directGrantsOnly" : { "type" : "boolean", "deprecated" : true }, "publicClient" : { "type" : "boolean" }, "frontchannelLogout" : { "type" : "boolean" }, "protocol" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "authenticationFlowBindingOverrides" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "fullScopeAllowed" : { "type" : "boolean" }, "nodeReRegistrationTimeout" : { "format" : "int32", "type" : "integer" }, "registeredNodes" : { "type" : "object", "additionalProperties" : { "format" : "int32", "type" : "integer" } }, "protocolMappers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtocolMapperRepresentation" } }, "clientTemplate" : { "type" : "string", "deprecated" : true }, "useTemplateConfig" : { "type" : "boolean", "deprecated" : true }, "useTemplateScope" : { "type" : "boolean", "deprecated" : true }, "useTemplateMappers" : { "type" : "boolean", "deprecated" : true }, "defaultClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "optionalClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "authorizationSettings" : { "$ref" : "#/components/schemas/ResourceServerRepresentation" }, "access" : { "type" : "object", "additionalProperties" : { "type" : "boolean" } }, "origin" : { "type" : "string" }, "name" : { "type" : "string" }, "claims" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ClaimRepresentation" } ], "deprecated" : true } }, "deprecated" : true }, "OrganizationDomainRepresentation" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "verified" : { "type" : "boolean" } } }, "OrganizationInvitationRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "organizationId" : { "type" : "string" }, "email" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "sentDate" : { "format" : "int32", "type" : "integer" }, "expiresAt" : { "format" : "int32", "type" : "integer" }, "status" : { "$ref" : "#/components/schemas/Status" }, "inviteLink" : { "type" : "string" } } }, "OrganizationRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "alias" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "description" : { "type" : "string" }, "redirectUrl" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "domains" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/OrganizationDomainRepresentation" } }, "members" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MemberRepresentation" } }, "identityProviders" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdentityProviderRepresentation" } } } }, "Permission" : { "type" : "object", "properties" : { "rsid" : { "type" : "string" }, "rsname" : { "type" : "string" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "claims" : { "type" : "object", "additionalProperties" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } } }, "PolicyEnforcementMode" : { "enum" : [ "ENFORCING", "PERMISSIVE", "DISABLED" ], "type" : "string" }, "PolicyEvaluationRequest" : { "type" : "object", "properties" : { "context" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "resources" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceRepresentation" } }, "resourceType" : { "type" : "string" }, "clientId" : { "type" : "string" }, "userId" : { "type" : "string" }, "roleIds" : { "type" : "array", "items" : { "type" : "string" } }, "entitlements" : { "type" : "boolean" } } }, "PolicyEvaluationResponse" : { "type" : "object", "properties" : { "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EvaluationResultRepresentation" } }, "entitlements" : { "type" : "boolean" }, "status" : { "$ref" : "#/components/schemas/DecisionEffect" }, "rpt" : { "$ref" : "#/components/schemas/AccessToken" } } }, "PolicyProviderRepresentation" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "name" : { "type" : "string" }, "group" : { "type" : "string" } } }, "PolicyRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "type" : { "type" : "string" }, "policies" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "resources" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "logic" : { "$ref" : "#/components/schemas/Logic" }, "decisionStrategy" : { "$ref" : "#/components/schemas/DecisionStrategy" }, "owner" : { "type" : "string" }, "resourceType" : { "type" : "string" }, "resourcesData" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceRepresentation" } }, "scopesData" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeRepresentation" } }, "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "PolicyResultRepresentation" : { "type" : "object", "properties" : { "policy" : { "$ref" : "#/components/schemas/PolicyRepresentation" }, "status" : { "$ref" : "#/components/schemas/DecisionEffect" }, "associatedPolicies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyResultRepresentation" } }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "resourceType" : { "type" : "string" } } }, "PropertyConfig" : { "type" : "object", "properties" : { "applicable" : { "type" : "boolean" }, "value" : { } } }, "ProtocolMapperEvaluationRepresentation" : { "type" : "object", "properties" : { "mapperId" : { "type" : "string" }, "mapperName" : { "type" : "string" }, "containerId" : { "type" : "string" }, "containerName" : { "type" : "string" }, "containerType" : { "type" : "string" }, "protocolMapper" : { "type" : "string" } } }, "ProtocolMapperRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "protocol" : { "type" : "string" }, "protocolMapper" : { "type" : "string" }, "consentRequired" : { "type" : "boolean", "deprecated" : true }, "consentText" : { "type" : "string", "deprecated" : true }, "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "PublishedRealmRepresentation" : { "type" : "object", "properties" : { "realm" : { "type" : "string" }, "public_key" : { "type" : "string" }, "token-service" : { "type" : "string" }, "account-service" : { "type" : "string" }, "tokens-not-before" : { "format" : "int32", "type" : "integer" } } }, "RealmEventsConfigRepresentation" : { "type" : "object", "properties" : { "eventsEnabled" : { "type" : "boolean" }, "eventsExpiration" : { "format" : "int64", "type" : "integer" }, "eventsListeners" : { "type" : "array", "items" : { "type" : "string" } }, "enabledEventTypes" : { "type" : "array", "items" : { "type" : "string" } }, "adminEventsEnabled" : { "type" : "boolean" }, "adminEventsDetailsEnabled" : { "type" : "boolean" } } }, "RealmRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "realm" : { "type" : "string" }, "displayName" : { "type" : "string" }, "displayNameHtml" : { "type" : "string" }, "notBefore" : { "format" : "int32", "type" : "integer" }, "defaultSignatureAlgorithm" : { "type" : "string" }, "revokeRefreshToken" : { "type" : "boolean" }, "refreshTokenMaxReuse" : { "format" : "int32", "type" : "integer" }, "accessTokenLifespan" : { "format" : "int32", "type" : "integer" }, "accessTokenLifespanForImplicitFlow" : { "format" : "int32", "type" : "integer" }, "ssoSessionIdleTimeout" : { "format" : "int32", "type" : "integer" }, "ssoSessionMaxLifespan" : { "format" : "int32", "type" : "integer" }, "ssoSessionIdleTimeoutRememberMe" : { "format" : "int32", "type" : "integer" }, "ssoSessionMaxLifespanRememberMe" : { "format" : "int32", "type" : "integer" }, "offlineSessionIdleTimeout" : { "format" : "int32", "type" : "integer" }, "offlineSessionMaxLifespanEnabled" : { "type" : "boolean" }, "offlineSessionMaxLifespan" : { "format" : "int32", "type" : "integer" }, "clientSessionIdleTimeout" : { "format" : "int32", "type" : "integer" }, "clientSessionMaxLifespan" : { "format" : "int32", "type" : "integer" }, "clientOfflineSessionIdleTimeout" : { "format" : "int32", "type" : "integer" }, "clientOfflineSessionMaxLifespan" : { "format" : "int32", "type" : "integer" }, "accessCodeLifespan" : { "format" : "int32", "type" : "integer" }, "accessCodeLifespanUserAction" : { "format" : "int32", "type" : "integer" }, "accessCodeLifespanLogin" : { "format" : "int32", "type" : "integer" }, "actionTokenGeneratedByAdminLifespan" : { "format" : "int32", "type" : "integer" }, "actionTokenGeneratedByUserLifespan" : { "format" : "int32", "type" : "integer" }, "oauth2DeviceCodeLifespan" : { "format" : "int32", "type" : "integer" }, "oauth2DevicePollingInterval" : { "format" : "int32", "type" : "integer" }, "enabled" : { "type" : "boolean" }, "sslRequired" : { "type" : "string" }, "passwordCredentialGrantAllowed" : { "type" : "boolean", "deprecated" : true }, "registrationAllowed" : { "type" : "boolean" }, "registrationEmailAsUsername" : { "type" : "boolean" }, "rememberMe" : { "type" : "boolean" }, "verifyEmail" : { "type" : "boolean" }, "loginWithEmailAllowed" : { "type" : "boolean" }, "duplicateEmailsAllowed" : { "type" : "boolean" }, "resetPasswordAllowed" : { "type" : "boolean" }, "editUsernameAllowed" : { "type" : "boolean" }, "userCacheEnabled" : { "type" : "boolean", "deprecated" : true }, "realmCacheEnabled" : { "type" : "boolean", "deprecated" : true }, "bruteForceProtected" : { "type" : "boolean" }, "permanentLockout" : { "type" : "boolean" }, "maxTemporaryLockouts" : { "format" : "int32", "type" : "integer" }, "bruteForceStrategy" : { "$ref" : "#/components/schemas/BruteForceStrategy" }, "maxFailureWaitSeconds" : { "format" : "int32", "type" : "integer" }, "minimumQuickLoginWaitSeconds" : { "format" : "int32", "type" : "integer" }, "waitIncrementSeconds" : { "format" : "int32", "type" : "integer" }, "quickLoginCheckMilliSeconds" : { "format" : "int64", "type" : "integer" }, "maxDeltaTimeSeconds" : { "format" : "int32", "type" : "integer" }, "failureFactor" : { "format" : "int32", "type" : "integer" }, "privateKey" : { "type" : "string", "deprecated" : true }, "publicKey" : { "type" : "string", "deprecated" : true }, "certificate" : { "type" : "string", "deprecated" : true }, "codeSecret" : { "type" : "string", "deprecated" : true }, "roles" : { "$ref" : "#/components/schemas/RolesRepresentation" }, "groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupRepresentation" } }, "defaultRoles" : { "type" : "array", "items" : { "type" : "string" }, "deprecated" : true }, "defaultRole" : { "$ref" : "#/components/schemas/RoleRepresentation" }, "adminPermissionsClient" : { "$ref" : "#/components/schemas/ClientRepresentation" }, "defaultGroups" : { "type" : "array", "items" : { "type" : "string" } }, "requiredCredentials" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" }, "deprecated" : true }, "passwordPolicy" : { "type" : "string" }, "otpPolicyType" : { "type" : "string" }, "otpPolicyAlgorithm" : { "type" : "string" }, "otpPolicyInitialCounter" : { "format" : "int32", "type" : "integer" }, "otpPolicyDigits" : { "format" : "int32", "type" : "integer" }, "otpPolicyLookAheadWindow" : { "format" : "int32", "type" : "integer" }, "otpPolicyPeriod" : { "format" : "int32", "type" : "integer" }, "otpPolicyCodeReusable" : { "type" : "boolean" }, "otpSupportedApplications" : { "type" : "array", "items" : { "type" : "string" } }, "localizationTexts" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "webAuthnPolicyRpEntityName" : { "type" : "string" }, "webAuthnPolicySignatureAlgorithms" : { "type" : "array", "items" : { "type" : "string" } }, "webAuthnPolicyRpId" : { "type" : "string" }, "webAuthnPolicyAttestationConveyancePreference" : { "type" : "string" }, "webAuthnPolicyAuthenticatorAttachment" : { "type" : "string" }, "webAuthnPolicyRequireResidentKey" : { "type" : "string" }, "webAuthnPolicyUserVerificationRequirement" : { "type" : "string" }, "webAuthnPolicyCreateTimeout" : { "format" : "int32", "type" : "integer" }, "webAuthnPolicyAvoidSameAuthenticatorRegister" : { "type" : "boolean" }, "webAuthnPolicyAcceptableAaguids" : { "type" : "array", "items" : { "type" : "string" } }, "webAuthnPolicyExtraOrigins" : { "type" : "array", "items" : { "type" : "string" } }, "webAuthnPolicyPasswordlessRpEntityName" : { "type" : "string" }, "webAuthnPolicyPasswordlessSignatureAlgorithms" : { "type" : "array", "items" : { "type" : "string" } }, "webAuthnPolicyPasswordlessRpId" : { "type" : "string" }, "webAuthnPolicyPasswordlessAttestationConveyancePreference" : { "type" : "string" }, "webAuthnPolicyPasswordlessAuthenticatorAttachment" : { "type" : "string" }, "webAuthnPolicyPasswordlessRequireResidentKey" : { "type" : "string" }, "webAuthnPolicyPasswordlessUserVerificationRequirement" : { "type" : "string" }, "webAuthnPolicyPasswordlessCreateTimeout" : { "format" : "int32", "type" : "integer" }, "webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister" : { "type" : "boolean" }, "webAuthnPolicyPasswordlessAcceptableAaguids" : { "type" : "array", "items" : { "type" : "string" } }, "webAuthnPolicyPasswordlessExtraOrigins" : { "type" : "array", "items" : { "type" : "string" } }, "webAuthnPolicyPasswordlessPasskeysEnabled" : { "type" : "boolean" }, "clientProfiles" : { "$ref" : "#/components/schemas/ClientProfilesRepresentation" }, "clientPolicies" : { "$ref" : "#/components/schemas/ClientPoliciesRepresentation" }, "users" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserRepresentation" } }, "federatedUsers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserRepresentation" } }, "scopeMappings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeMappingRepresentation" } }, "clientScopeMappings" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeMappingRepresentation" } } }, "clients" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientRepresentation" } }, "clientScopes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientScopeRepresentation" } }, "defaultDefaultClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "defaultOptionalClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "browserSecurityHeaders" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "smtpServer" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "userFederationProviders" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserFederationProviderRepresentation" } }, "userFederationMappers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserFederationMapperRepresentation" } }, "loginTheme" : { "type" : "string" }, "accountTheme" : { "type" : "string" }, "adminTheme" : { "type" : "string" }, "emailTheme" : { "type" : "string" }, "eventsEnabled" : { "type" : "boolean" }, "eventsExpiration" : { "format" : "int64", "type" : "integer" }, "eventsListeners" : { "type" : "array", "items" : { "type" : "string" } }, "enabledEventTypes" : { "type" : "array", "items" : { "type" : "string" } }, "adminEventsEnabled" : { "type" : "boolean" }, "adminEventsDetailsEnabled" : { "type" : "boolean" }, "identityProviders" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdentityProviderRepresentation" } }, "identityProviderMappers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdentityProviderMapperRepresentation" } }, "protocolMappers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProtocolMapperRepresentation" } }, "components" : { "$ref" : "#/components/schemas/MultivaluedHashMapStringComponentExportRepresentation" }, "internationalizationEnabled" : { "type" : "boolean" }, "supportedLocales" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "defaultLocale" : { "type" : "string" }, "authenticationFlows" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AuthenticationFlowRepresentation" } }, "authenticatorConfig" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AuthenticatorConfigRepresentation" } }, "requiredActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RequiredActionProviderRepresentation" } }, "browserFlow" : { "type" : "string" }, "registrationFlow" : { "type" : "string" }, "directGrantFlow" : { "type" : "string" }, "resetCredentialsFlow" : { "type" : "string" }, "clientAuthenticationFlow" : { "type" : "string" }, "dockerAuthenticationFlow" : { "type" : "string" }, "firstBrokerLoginFlow" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "keycloakVersion" : { "type" : "string" }, "userManagedAccessAllowed" : { "type" : "boolean" }, "organizationsEnabled" : { "type" : "boolean" }, "organizations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OrganizationRepresentation" } }, "verifiableCredentialsEnabled" : { "type" : "boolean" }, "adminPermissionsEnabled" : { "type" : "boolean" }, "social" : { "type" : "boolean", "deprecated" : true }, "updateProfileOnInitialSocialLogin" : { "type" : "boolean", "deprecated" : true }, "socialProviders" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "deprecated" : true }, "applicationScopeMappings" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeMappingRepresentation" } }, "deprecated" : true }, "applications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationRepresentation" }, "deprecated" : true }, "oauthClients" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OAuthClientRepresentation" }, "deprecated" : true }, "clientTemplates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClientTemplateRepresentation" }, "deprecated" : true } } }, "RequiredActionConfigInfoRepresentation" : { "type" : "object", "properties" : { "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConfigPropertyRepresentation" } } } }, "RequiredActionConfigRepresentation" : { "type" : "object", "properties" : { "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "RequiredActionProviderRepresentation" : { "type" : "object", "properties" : { "alias" : { "type" : "string" }, "name" : { "type" : "string" }, "providerId" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "defaultAction" : { "type" : "boolean" }, "priority" : { "format" : "int32", "type" : "integer" }, "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "ResourceOwnerRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "ResourceRepresentation" : { "type" : "object", "properties" : { "_id" : { "type" : "string" }, "name" : { "type" : "string" }, "uris" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "type" : { "type" : "string" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeRepresentation" } }, "icon_uri" : { "type" : "string" }, "owner" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ResourceOwnerRepresentation" } ], "readOnly" : true }, "ownerManagedAccess" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "uri" : { "type" : "string", "writeOnly" : true, "deprecated" : true }, "scopesUma" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeRepresentation" } } } }, "ResourceServerRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "clientId" : { "type" : "string" }, "name" : { "type" : "string" }, "allowRemoteResourceManagement" : { "type" : "boolean" }, "policyEnforcementMode" : { "$ref" : "#/components/schemas/PolicyEnforcementMode" }, "resources" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceRepresentation" } }, "policies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyRepresentation" } }, "scopes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeRepresentation" } }, "decisionStrategy" : { "$ref" : "#/components/schemas/DecisionStrategy" }, "authorizationSchema" : { "$ref" : "#/components/schemas/AuthorizationSchema" } } }, "ResourceType" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "scopeAliases" : { "type" : "object", "additionalProperties" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } }, "groupType" : { "type" : "string" } } }, "RoleRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "scopeParamRequired" : { "type" : "boolean", "deprecated" : true }, "composite" : { "type" : "boolean" }, "composites" : { "$ref" : "#/components/schemas/Composites" }, "clientRole" : { "type" : "boolean" }, "containerId" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } } } }, "RolesRepresentation" : { "type" : "object", "properties" : { "realm" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } }, "client" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } } }, "application" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleRepresentation" } }, "deprecated" : true } } }, "ScopeMappingRepresentation" : { "type" : "object", "properties" : { "self" : { "type" : "string" }, "client" : { "type" : "string" }, "clientTemplate" : { "type" : "string", "deprecated" : true }, "clientScope" : { "type" : "string" }, "roles" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "ScopeRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "iconUri" : { "type" : "string" }, "policies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyRepresentation" } }, "resources" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResourceRepresentation" } }, "displayName" : { "type" : "string" } } }, "SocialLinkRepresentation" : { "type" : "object", "properties" : { "socialProvider" : { "type" : "string" }, "socialUserId" : { "type" : "string" }, "socialUsername" : { "type" : "string" } } }, "Status" : { "enum" : [ "PENDING", "EXPIRED" ], "type" : "string" }, "UPAttribute" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "displayName" : { "type" : "string" }, "validations" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { } } }, "annotations" : { "type" : "object", "additionalProperties" : { } }, "required" : { "$ref" : "#/components/schemas/UPAttributeRequired" }, "permissions" : { "$ref" : "#/components/schemas/UPAttributePermissions" }, "selector" : { "$ref" : "#/components/schemas/UPAttributeSelector" }, "group" : { "type" : "string" }, "multivalued" : { "type" : "boolean" }, "defaultValue" : { "type" : "string" } } }, "UPAttributePermissions" : { "type" : "object", "properties" : { "view" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "edit" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "UPAttributeRequired" : { "type" : "object", "properties" : { "roles" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "UPAttributeSelector" : { "type" : "object", "properties" : { "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "UPConfig" : { "type" : "object", "properties" : { "attributes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UPAttribute" } }, "groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UPGroup" } }, "unmanagedAttributePolicy" : { "$ref" : "#/components/schemas/UnmanagedAttributePolicy" } } }, "UPGroup" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "displayHeader" : { "type" : "string" }, "displayDescription" : { "type" : "string" }, "annotations" : { "type" : "object", "additionalProperties" : { } } } }, "UnmanagedAttributePolicy" : { "enum" : [ "ENABLED", "ADMIN_VIEW", "ADMIN_EDIT" ], "type" : "string" }, "UserConsentRepresentation" : { "type" : "object", "properties" : { "clientId" : { "type" : "string" }, "grantedClientScopes" : { "type" : "array", "items" : { "type" : "string" } }, "createdDate" : { "format" : "int64", "type" : "integer" }, "lastUpdatedDate" : { "format" : "int64", "type" : "integer" }, "grantedRealmRoles" : { "type" : "array", "items" : { "type" : "string" }, "deprecated" : true } } }, "UserFederationMapperRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "federationProviderDisplayName" : { "type" : "string" }, "federationMapperType" : { "type" : "string" }, "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "UserFederationProviderRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "displayName" : { "type" : "string" }, "providerName" : { "type" : "string" }, "config" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "priority" : { "format" : "int32", "type" : "integer" }, "fullSyncPeriod" : { "format" : "int32", "type" : "integer" }, "changedSyncPeriod" : { "format" : "int32", "type" : "integer" }, "lastSync" : { "format" : "int32", "type" : "integer" } } }, "UserProfileAttributeGroupMetadata" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "displayHeader" : { "type" : "string" }, "displayDescription" : { "type" : "string" }, "annotations" : { "type" : "object", "additionalProperties" : { } } } }, "UserProfileAttributeMetadata" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "displayName" : { "type" : "string" }, "required" : { "type" : "boolean" }, "readOnly" : { "type" : "boolean" }, "annotations" : { "type" : "object", "additionalProperties" : { } }, "validators" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { } } }, "group" : { "type" : "string" }, "multivalued" : { "type" : "boolean" }, "defaultValue" : { "type" : "string" } } }, "UserProfileMetadata" : { "type" : "object", "properties" : { "attributes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserProfileAttributeMetadata" } }, "groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserProfileAttributeGroupMetadata" } } } }, "UserRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "username" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "email" : { "type" : "string" }, "emailVerified" : { "type" : "boolean" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "userProfileMetadata" : { "$ref" : "#/components/schemas/UserProfileMetadata" }, "enabled" : { "type" : "boolean" }, "self" : { "type" : "string" }, "origin" : { "type" : "string" }, "createdTimestamp" : { "format" : "int64", "type" : "integer" }, "totp" : { "type" : "boolean" }, "federationLink" : { "type" : "string" }, "serviceAccountClientId" : { "type" : "string" }, "credentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CredentialRepresentation" } }, "disableableCredentialTypes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "requiredActions" : { "type" : "array", "items" : { "type" : "string" } }, "federatedIdentities" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FederatedIdentityRepresentation" } }, "realmRoles" : { "type" : "array", "items" : { "type" : "string" } }, "clientRoles" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "clientConsents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserConsentRepresentation" } }, "notBefore" : { "format" : "int32", "type" : "integer" }, "applicationRoles" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "deprecated" : true }, "socialLinks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SocialLinkRepresentation" }, "deprecated" : true }, "groups" : { "type" : "array", "items" : { "type" : "string" } }, "access" : { "type" : "object", "additionalProperties" : { "type" : "boolean" } } } }, "UserSessionRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "username" : { "type" : "string" }, "userId" : { "type" : "string" }, "ipAddress" : { "type" : "string" }, "start" : { "format" : "int64", "type" : "integer" }, "lastAccess" : { "format" : "int64", "type" : "integer" }, "rememberMe" : { "type" : "boolean" }, "clients" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "transientUser" : { "type" : "boolean" } } }, "WorkflowConcurrencyRepresentation" : { "type" : "object", "properties" : { "cancel-in-progress" : { "type" : "string" }, "restart-in-progress" : { "type" : "string" } } }, "WorkflowRepresentation" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "on" : { "type" : "string" }, "schedule" : { "$ref" : "#/components/schemas/WorkflowScheduleRepresentation" }, "concurrency" : { "$ref" : "#/components/schemas/WorkflowConcurrencyRepresentation" }, "if" : { "type" : "string" }, "steps" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowStepRepresentation" } }, "state" : { "$ref" : "#/components/schemas/WorkflowStateRepresentation" }, "with" : { "$ref" : "#/components/schemas/MultivaluedHashMapStringString" }, "cancelInProgress" : { "type" : "string" }, "restartInProgress" : { "type" : "string" } } }, "WorkflowScheduleRepresentation" : { "type" : "object", "properties" : { "after" : { "type" : "string" }, "batch-size" : { "format" : "int32", "type" : "integer" } } }, "WorkflowStateRepresentation" : { "type" : "object", "properties" : { "errors" : { "type" : "array", "items" : { "type" : "string" } } } }, "WorkflowStepRepresentation" : { "type" : "object", "properties" : { "uses" : { "type" : "string" }, "after" : { "type" : "string" }, "scheduled-at" : { "format" : "int64", "type" : "integer" }, "id" : { "type" : "string", "writeOnly" : true }, "config" : { "$ref" : "#/components/schemas/MultivaluedHashMapStringString" } } } } } }