Versions Compared

Key

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

...

/tenant-management/api/admin/roles2021 Autumn GroupsJSONgroupsgroups/tenant-management/api/admin/groupsPOST /tenant-management/api/admin/groupsgroups/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 Retrieve the Tenant MetricsJSON

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

/tenant-management/api/admin/tenantmetrics

GET
2020 Winter
Retrieve the Number of Users  RolesTXTJSON

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

/tenant-management/api/admin/users/countroles

POSTGET
2020 Winter
CreateUserRetrieve the Tenant data JSON

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.

Insert excerpt
POST GET /tenant-management/api/admin/userstenantPOST
GET /tenant-management/api/admin/userstenant
nopaneltrue

/tenant-management/api/admin/users

POST
2020 Winter
Create a User via CSVJSON

GET
2020 Winter

Retrieve  a Usera List of UsersJSON

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

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

PUTPOST
2020 Winter
Update the Data of a UserHTTP status codeCreateUserJSON

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

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

DELETEGET
2020 Winter
Delete a Retrieve a UserHTTP status codeJSON

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

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

GET
PUT
2020 Winter
Retrieve a List of UsersJSONUpdate the Data of a UserHTTP status code

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

GET
2020 Winter
Retrieve the RolesJSONPOST /tenant-management/api/admin/roles
nopaneltrue
DELETE
2021 Autumn
Delete a RoleJSON

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

/tenant-management/api/admin/roles

POST
2021 Autumn
CreateRoleJSON
Insert excerpt
POST /tenant-management/api/admin/roles
DELETE
2020 Winter
Delete a UserHTTP status code

Insert excerpt
DELETE /tenant-management/api/admin/roleusers/{nameid}
DELETE /tenant-management/api/admin/roleusers/{nameid}
nopaneltrue

/tenant-management/api/admin/roleusers/{nameid}

GET
2020 Winter
Retrieve the Number of Users TXT

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

count
GET /tenant-management/api/admin/

nopaneltrue
POST
2021 Autumn
CreateGroupJSON
Insert excerpt
POST /tenant-management/api/admin/groups

users/count
nopaneltrue

/tenant-management/api/admin/

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