Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

These endpoints can be used with the role YUUVIS_TENANT_ADMIN for role, group and user management. Administrative tenant-specific information can be retrieved as well.

HTTP Method
as of product version
PurposeResponse FormatDescription
GET
2020 Winter
Retrieve the Tenant data JSON

Retrieves the tenant data as given in the Keycloak identity provider for the tenant of the calling user.
/tenant-management/api/admin/tenant

GET
2020 Winter
Retrieve the Number of Users TXT

Retrieves the number of all users of the tenant.
/tenant-management/api/admin/users/count

POST
2020 Winter
CreateUserJSON

Creates a new user with the given properties.
/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

Retrieves the data of the user specified by id.
/tenant-management/api/admin/users/{id}

PUT
2020 Winter
Update the Data of a UserHTTP status code

Updates the data of the user specified by id with the data passed in the request body in JSON format.
/tenant-management/api/admin/users/{id}

DELETE
2020 Winter
Delete a UserHTTP status code

Deletes the user specified by id.
/tenant-management/api/admin/users/{id}

GET
2020 Winter

Retrieve a List of UsersJSON

Retrieves a list of all users. As 2021 Autumn, the list can be filtered by applying query parameters.
/tenant-management/api/admin/users

GET
2020 Winter
Retrieve the RolesJSON
POST
2021 Autumn
CreateRoleJSON

Error rendering macro 'excerpt-include' : No link could be created for 'POST /tenant-management/api/admin/roles'.

/tenant-management/api/admin/roles

DELETE
2021 Autumn
Delete a RoleJSON

Error rendering macro 'excerpt-include' : No link could be created for 'DELETE /tenant-management/api/admin/role/{name}'.

/tenant-management/api/admin/role/{name}

GET
2021 Autumn
Retrieve the GroupsJSON

Error rendering macro 'excerpt-include' : No link could be created for 'GET /tenant-management/api/admin/groups'.

/tenant-management/api/admin/groups

POST
2021 Autumn
CreateGroupJSON

Error rendering macro 'excerpt-include' : No link could be created for 'POST /tenant-management/api/admin/groups'.

/tenant-management/api/admin/groups

PUT
2021 Autumn
UpdateGroupJSON

Error rendering macro 'excerpt-include' : No link could be created for 'PUT /tenant-management/api/admin/groups/{id}'.

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

DELETE
2021 Autumn
DeleteGroupJSON

Error rendering macro 'excerpt-include' : No link could be created for 'DELETE /tenant-management/api/admin/groups/{id}'.

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

GET
2021 Spring
Retrieve the Current Metrics JSONReads the current metrics of the specified tenant.
/tenant-management/api/admin/metrics
  • No labels