Page Comparison

...

/tenant-management/api/system/tenants/{tenant}TXTHTTP status codeexcerpt-include/tenant-management/api/system/tenants/{tenant}/roles/tenant-management/api/system/tenants/{tenant}/rolesJSON/tenant-management/api/system/tenants/{tenant}/groups/{id}/tenant-management/api/system/tenants/{tenant}/groups/{id}

HTTP Method
as of product version Purpose Response Format Description

Manage Tenant Creation Profile

GET
2020 Winter

Retrieve the Keycloak System Settings

JSON

Insert excerpt

	GET /tenant-management/api/system/info
	GET /tenant-management/api/system/info
nopanel	true

/tenant-management/api/system/info

POST
2020 Winter

Update the Profile

HTTP status code

Insert excerpt

	POST /tenant-management/api/system/profile
	POST /tenant-management/api/system/profile
nopanel	true

/tenant-management/api/system/profile

GET
2020 Winter

Retrieve the Profile

JSON

Insert excerpt

	GET /tenant-management/api/system/profile
	GET /tenant-management/api/system/profile
nopanel	true

/tenant-management/api/system/profile

Manage Tenants

POST
2020 Winter

Create a Tenant

HTTP status code

Insert excerpt

	POST /tenant-management/api/system/tenants
	POST /tenant-management/api/system/tenants
nopanel	true

/tenant-management/api/system/tenants

PUT
2020 Winter

Update the Data of a Tenant

HTTP status code

Update the data of the tenant specified by tenant.
/tenant-management/api/system/tenants/{tenant}

GET
2020 Winter Retrieve the Tenant data JSON

Insert excerpt

GET /tenant-management/api/system/tenants/{tenant} GET /tenant-management/api/system/tenants/{tenant}

nopanel true

GET
2020 Winter

Retrieve the Data of all Tenants

JSON

Insert excerpt

	GET /tenant-management/api/system/tenants
	GET /tenant-management/api/system/tenants
nopanel	true

/tenant-management/api/system/tenants

DELETEGET
2020 Winter

Delete a Retrieve the Tenant data

JSON

Insert excerpt

	DELETE GET /tenant-management/api/system/tenants/{tenant}DELETE
	GET /tenant-management/api/system/tenants/{tenant}
nopanel	true

/tenant-management/api/system/tenants/{tenant}

PATCHDELETE
2021 Summer2020 Winter

Update Delete a Tenant

HTTP status codeJSON

Insert excerpt

	PATCH DELETE /tenant-management/api/system/tenants/{tenant}PATCH
	DELETE /tenant-management/api/system/tenants/{tenant}
nopanel	true

/tenant-management/api/system/tenants/{tenant}

GET
2020 Winter

Retrieve the Number of Users

Metrics of a Tenant

JSON

Insert excerpt

	GET /tenant-management/api/system/tenants/{tenant}/users/countmetrics
	GET /tenant-management/api/system/tenants/{tenant}/users/countmetrics
nopanel	true

/tenant-management/api/system/tenants/{tenant}/users/countmetrics

POST

GET
2020 Winter

Create a UserRequest a List of Roles

JSON

Insert excerpt

	POST GET /tenant-management/api/system/tenants/{tenant}/usersrolesPOST
	GET /tenant-management/api/system/tenants/{tenant}/usersroles
nopanel	true

/tenant-management/api/system/tenants/{tenant}/usersroles

PUT

GET
2020 Winter

Update the Data of a User

Request a List of Users

JSON

Insert excerpt

	PUT GET /tenant-management/api/system/tenants/{tenant}/users/{id}PUT
	GET /tenant-management/api/system/tenants/{tenant}/users/{id}
nopanel	true

/tenant-management/api/system/tenants/{tenant}/users/{id}

GETPOST
2020 Winter

Request a List of UsersCreate a User

JSON

Insert excerpt

	GET POST /tenant-management/api/system/tenants/{tenant}/usersGET
	POST /tenant-management/api/system/tenants/{tenant}/users
nopanel	true

/tenant-management/api/system/tenants/{tenant}/users

GET
2020 Winter

Retrieve the Data of a User

JSON

Insert excerpt

	GET /tenant-management/api/system/tenants/{tenant}/users/{id}
	GET /tenant-management/api/system/tenants/{tenant}/users/{id}
nopanel	true

/tenant-management/api/system/tenants/{tenant}/users/{id}

DELETEPUT
2020 Winter

Delete a UserUpdate the Data of a User

HTTP status code

Insert excerpt

	DELETE PUT /tenant-management/api/system/tenants/{tenant}/users/{id}DELETE
	PUT /tenant-management/api/system/tenants/{tenant}/users/{id}
nopanel	true

/tenant-management/api/system/tenants/{tenant}/users/{id}

GETDELETE
2020 Winter Retrieve the Roles JSON GET /tenant-management/api/system/tenants/{tenant}/roles GET /tenant-management/api/system/tenants/{tenant}/roles

nopanel true

POST
2021 Autumn Create a Role JSON

Insert excerpt

POST /tenant-management/api/system/tenants/{tenant}/roles POST /tenant-management/api/system/tenants/{tenant}/roles

nopanel true

DELETE
2021 Autumn

Delete a Role

Delete a User

HTTP status code

Insert excerpt

	DELETE /tenant-management/api/system/tenants/{tenant}/roleusers/{nameid}
	DELETE /tenant-management/api/system/tenants/{tenant}/roleusers/{nameid}
nopanel	true

/tenant-management/api/system/tenants/{tenant}/roleusers/{nameid}

GET
2021 Autumn2020 Winter

Retrieve the Groups Number of Users

JSONTXT

Insert excerpt

	GET /tenant-management/api/system/tenants/{tenant}/groupsusers/count
	GET /tenant-management/api/system/tenants/{tenant}/groups
nopanel	true

/tenant-management/api/system/tenants/{tenant}/groups

POST
2021 Autumn

Create a Group

JSON

DELETE
2021 Autumn

Delete a Group

HTTP status code

Insert excerpt

DELETE /tenant-management/api/system/tenants/{tenant}/groups/{id} DELETE /tenant-management/api/system/tenants/{tenant}/groups/{id}

nopanel true

GET
2021 Summer

Retrieve the Current Metrics

JSON

Reads the current metrics of the specified tenant.
/tenant-management/api/system/tenants/{tenant}/metrics

POST /tenant-management/api/system/tenants/{tenant}/groups	POST /tenant-management/api/system/tenants/{tenant}/groups	users/count
nopanel	true

/tenant-management/api/system/tenants/{tenant}/groups

PUT
2021 Autumn

Update a Group

JSON

Insert excerpt

PUT /tenant-management/api/system/tenants/{tenant}/groups/{id} PUT /tenant-management/api/system/tenants/{tenant}/groups/{id}

nopanel true

users/count

Versions Compared

Old Version 1

New Version Current

Key

Manage Tenant Creation Profile

Manage Tenants