Versions Compared

Key

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

...

/tenant-management/api/admin/roles/tenant-management/api/admin/role/{name}/tenant-management/api/admin/groups/tenant-management/api/admin/groups/tenant-management/api/admin/groups/{id}
/tenant-management/api/admin/groups/{id}
HTTP Method
as of product version
PurposeResponse FormatDescription
GET
2020 Winter
Retrieve the Tenant data JSON

Insert excerpt
GET /tenant-management/api/admin/tenant
GET /tenant-management/api/admin/tenant
nopaneltrue

/tenant-management/api/admin/tenant

GET
2020 Winter
Retrieve the Number of Users TXT

Insert excerpt
GET /tenant-management/api/admin/users/count
GET /tenant-management/api/admin/users/count
nopaneltrue

/tenant-management/api/admin/users/count

POST
2020 Winter
CreateUserJSON

Insert excerpt
POST /tenant-management/api/admin/users
POST /tenant-management/api/admin/users
nopaneltrue

/tenant-management/api/admin/users

POST
2020 Winter
Create a User via CSVJSON

Creates users listed in a CSV-based file.
/api-tm/admin/users/batchcreate

Note: Keycloak does not offer an API for creating more than one user in one call. So you may want to create multiple users one by one by yourself.

GET
2020 Winter
Retrieve a UserJSON

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

/tenant-management/api/admin/users/{id}

PUT
2020 Winter
Update the Data of a UserHTTP status code

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

/tenant-management/api/admin/users/{id}

DELETE
2020 Winter
Delete a UserHTTP status code

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

/tenant-management/api/admin/users/{id}

GET
2020 Winter

Retrieve a List of UsersJSON

Insert excerpt
GET /tenant-management/api/admin/users
GET /tenant-management/api/admin/users
nopaneltrue

/tenant-management/api/admin/users

GET
2020 Winter
Retrieve the RolesJSON

Insert excerpt
GET /tenant-management/api/admin/roles
GET /tenant-management/api/admin/roles
nopaneltrue

/tenant-management/api/admin/roles

POST
2021 Autumn
CreateRoleJSON
Insert excerpt
POST /tenant-management/api/admin/rolesPOST /tenant-management/api/admin/roles
nopaneltrue
DELETE
2021 Autumn
Delete a RoleJSON
Insert excerpt
DELETE /tenant-management/api/admin/role/{name}DELETE /tenant-management/api/admin/role/{name}
nopaneltrue
GET
2021 Autumn
Retrieve the GroupsJSON
Insert excerpt
GET /tenant-management/api/admin/groupsGET /tenant-management/api/admin/groups
nopaneltrue
POST
2021 Autumn
CreateGroupJSON
Insert excerpt
POST /tenant-management/api/admin/groupsPOST /tenant-management/api/admin/groups
nopaneltrue
PUT
2021 Autumn
UpdateGroupJSON
Insert excerpt
PUT /tenant-management/api/admin/groups/{id}PUT /tenant-management/api/admin/groups/{id}
nopaneltrue
DELETE
2021 Autumn
DeleteGroupJSON
Insert excerpt
DELETE /tenant-management/api/admin/groups/{id}DELETE /tenant-management/api/admin/groups/{id}
nopaneltrue
GET
2021 Spring
Retrieve the Current Metrics JSONReads the current metrics of the specified tenant.
/tenant-management/api/admin/metrics