organizations
Organization management (super-admin)
Get an organization by alias
path Parameters
aliasGet an organization by alias › Responses
Unknown alias
nameDisplay name
idKeycloak identifier, server-assigned
alias[a-z0-9][a-z0-9-]*Immutable technical alias
enabledWhether the organization is active
descriptionOptional description
locale[a-z]{2,3}(-[A-Z]{2}…Default language of its members
membersNumber of members
Update an organization
Updates the name, state and description; the alias is immutable
path Parameters
aliasUpdate an organization › Request Body
nameDisplay name
idKeycloak identifier, server-assigned
alias[a-z0-9][a-z0-9-]*Immutable technical alias
enabledWhether the organization is active
descriptionOptional description
locale[a-z]{2,3}(-[A-Z]{2}…Default language of its members
membersNumber of members
Update an organization › Responses
Unknown alias
nameDisplay name
idKeycloak identifier, server-assigned
alias[a-z0-9][a-z0-9-]*Immutable technical alias
enabledWhether the organization is active
descriptionOptional description
locale[a-z]{2,3}(-[A-Z]{2}…Default language of its members
membersNumber of members
Delete an organization
Deletes the organization and the memberships; the accounts of its members stay. Refused while it still has members, unless force is true.
path Parameters
aliasquery Parameters
forceDelete even if the organization still has members
Delete an organization › Responses
Organization deleted
List organizations
Follow the Link header to page through the collection rather than building page URLs. The search parameter matches the organization name and its domains, never the alias: to reach one organization by alias, use GET /organizations/{alias}.
query Parameters
page0-indexed page number
sizePage size
searchFree-text search. The fields it matches are documented per endpoint.
sortSort field, prefixed with '-' for descending (e.g. -createdAt). Only present on endpoints whose backing store supports sorting.
List organizations › Responses
A page of results
nameDisplay name
idKeycloak identifier, server-assigned
alias[a-z0-9][a-z0-9-]*Immutable technical alias
enabledWhether the organization is active
descriptionOptional description
locale[a-z]{2,3}(-[A-Z]{2}…Default language of its members
membersNumber of members
Create an organization
Creates the organization and its administrators/viewers role groups
Create an organization › Request Body
nameDisplay name
idKeycloak identifier, server-assigned
alias[a-z0-9][a-z0-9-]*Immutable technical alias
enabledWhether the organization is active
descriptionOptional description
locale[a-z]{2,3}(-[A-Z]{2}…Default language of its members
membersNumber of members
Create an organization › Responses
Organization created
nameDisplay name
idKeycloak identifier, server-assigned
alias[a-z0-9][a-z0-9-]*Immutable technical alias
enabledWhether the organization is active
descriptionOptional description
locale[a-z]{2,3}(-[A-Z]{2}…Default language of its members
membersNumber of members