Versions Compared

Key

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

...

API SectionRequired User Role in Default ConfigurationAvailable User Management EndpointsDescription

system-controller endpoints

operations on any tenant in the system

YUUVIS_SYSTEM_INTEGRATOR




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

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

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

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

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

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

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

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

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

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

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

admin-controller endpoints

operations on the own tenant

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

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

GET /tenant-management/api/admin/users

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

POST /tenant-management/api/admin/users

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

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

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

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

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

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

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

idm-controller endpoints

operations on the own tenant

The endpoints are available for every logged-in user.GET /tenant-management/api/idm/me

Insert excerpt
GET /tenant-management/api/idm/me
GET /tenant-management/api/idm/me
nopaneltrue

GET /tenant-management/api/idm/roles/{role}/users

Insert excerpt
GET /tenant-management/api/idm/roles/{role}/users
GET /tenant-management/api/idm/roles/{role}/users
nopaneltrue

GET /tenant-management/api/idm/users

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

GET /tenant-management/api/idm/users/{id}

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

...