Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP Method
as of product version
PurposeResponse FormatDescription

Manage Tenant Creation Profile

GET
2020 Winter
Retrieve the Keycloak System SettingsJSON

Insert excerpt
GET /tenant-management/api/system/info
GET /tenant-management/api/system/info
nopaneltrue

/tenant-management/api/system/info

POST
2020 Winter
Update the ProfileHTTP status code

Insert excerpt
POST /tenant-management/api/system/profile
POST /tenant-management/api/system/profile
nopaneltrue

/tenant-management/api/system/profile

GET
2020 Winter
Retrieve the ProfileJSON

Insert excerpt
GET /tenant-management/api/system/profile
GET /tenant-management/api/system/profile
nopaneltrue

/tenant-management/api/system/profile


Manage Tenants

POST
2020 Winter
Create a TenantHTTP status code

Insert excerpt
POST /tenant-management/api/system/tenants
POST /tenant-management/api/system/tenants
nopaneltrue

/tenant-management/api/system/tenants

PUT
2020 Winter
Update the Data of a TenantHTTP 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}
nopaneltrue

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

GET
2020 Winter
Retrieve the Data of all TenantsJSON

Insert excerpt
GET /tenant-management/api/system/tenants
GET /tenant-management/api/system/tenants
nopaneltrue

/tenant-management/api/system/tenants

DELETE
2020 Winter
Delete TenantJSON

Insert excerpt
DELETE /tenant-management/api/system/tenants/{tenant}
DELETE /tenant-management/api/system/tenants/{tenant}
nopaneltrue

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

PATCH
2021 Summer
UpdateTenantHTTP status code

Insert excerpt
PATCH /tenant-management/api/system/tenants/{tenant}
PATCH /tenant-management/api/system/tenants/{tenant}
nopaneltrue

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

GET
2020 Winter
Retrieve the Number of UsersTXT

Insert excerpt
GET /tenant-management/api/system/tenants/{tenant}/users/count
GET /tenant-management/api/system/tenants/{tenant}/users/count
nopaneltrue

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

POST
2020 Winter
Create  a UserJSON

Insert excerpt
POST /tenant-management/api/system/tenants/{tenant}/users
POST /tenant-management/api/system/tenants/{tenant}/users
nopaneltrue

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

PUT
2020 Winter
Update the Data of a UserHTTP status code

Insert excerpt
PUT /tenant-management/api/system/tenants/{tenant}/users/{id}
PUT /tenant-management/api/system/tenants/{tenant}/users/{id}
nopaneltrue

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

GET
2020 Winter

Request a List of UsersJSON

Insert excerpt
GET /tenant-management/api/system/tenants/{tenant}/users
GET /tenant-management/api/system/tenants/{tenant}/users
nopaneltrue

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

GET
2020 Winter
Retrieve the Data of a UserJSON

Insert excerpt
GET /tenant-management/api/system/tenants/{tenant}/users/{id}
GET /tenant-management/api/system/tenants/{tenant}/users/{id}
nopaneltrue

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

DELETE
2020 Winter
Delete a UserHTTP status code

Insert excerpt
DELETE /tenant-management/api/system/tenants/{tenant}/users/{id}
DELETE /tenant-management/api/system/tenants/{tenant}/users/{id}
nopaneltrue

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

GET
2020 Winter
Retrieve the RolesJSON

Insert excerpt
GET /tenant-management/api/system/tenants/{tenant}/roles
GET /tenant-management/api/system/tenants/{tenant}/roles
nopaneltrue

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

POST
2021 Autumn
Create  a RoleJSON

Insert excerpt
POST /tenant-management/api/system/tenants/{tenant}/roles
POST /tenant-management/api/system/tenants/{tenant}/roles
nopaneltrue

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

DELETE
2021 Autumn
Delete a RoleJSON

Insert excerpt
DELETE /tenant-management/api/system/tenants/{tenant}/roleroles/{name}
DELETE /tenant-management/api/system/tenants/{tenant}/roleroles/{name}
nopaneltrue

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

GET
2021 Autumn
Retrieve the GroupsJSON

Insert excerpt
GET /tenant-management/api/system/tenants/{tenant}/groups
GET /tenant-management/api/system/tenants/{tenant}/groups
nopaneltrue

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

POST
2021 Autumn
Create  a GroupJSON

Insert excerpt
POST /tenant-management/api/system/tenants/{tenant}/groups
POST /tenant-management/api/system/tenants/{tenant}/groups
nopaneltrue

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

GET
2021 Autumn
Retrieve a GroupJSON

Insert excerpt
GET /tenant-management/api/system/tenants/{tenant}/groups/{id}
GET /tenant-management/api/system/tenants/{tenant}/groups/{id}
nopaneltrue

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

PUT
2021 Autumn
UpdateGroupJSON

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

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

DELETE
2021 Autumn
Delete GroupHTTP status code

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

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

GET
2021 Summer

deprecated as of 2023 Autumn

Retrieve the Current Metrics JSONReads the current metrics of the specified tenant.
/tenant-management/api/system/tenants/{tenant}/metrics