Endpoints for Tenant Administrators

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 MetricsJSON

Retrieves the current metrics of the tenant
/tenant-management/api/admin/metrics

GET
2020 Winter
Retrieve the RolesJSON
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 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

POST
2020 Winter
CreateUserJSON

Creates a new user with the given properties.
/tenant-management/api/admin/users

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 the Number of Users TXT

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