RolesApi
| Method | HTTP request | Description |
|---|---|---|
| delete_user_site_role_association_using_delete | DELETE /api/web/v1/users/{userid}/roles/{roleid} | Delete a site role from a user |
| get_site_role_using_get | GET /api/web/v1/roles/{id} | Get a role |
| get_user_roles_using_get | GET /api/web/v1/users/{userid}/roles | List all site roles assigned to user |
| get_user_site_role_association_using_get | GET /api/web/v1/users/{userid}/roles/{roleid} | Get site role assigned to user |
| list_site_roles_using_get | GET /api/web/v1/roles | List roles |
| modify_user_site_role_association_using_put | PUT /api/web/v1/users/{userid}/roles/{roleid} | Set user role |
delete_user_site_role_association_using_delete
delete_user_site_role_association_using_delete(userid, roleid)
Delete a site role from a user
Delete a user's site role. Caller requires the USERSITEROLES:REMOVE permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user from which the role is to be removed. | |
| roleid | str | The UUID of the role that is to be removed. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_site_role_using_get
Role get_site_role_using_get(id)
Get a role
Get a specified role. Caller requires the ROLES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the role to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_user_roles_using_get
List[Role] get_user_roles_using_get(userid)
List all site roles assigned to user
List all site roles assigned to the specified user. Caller requires the USERSITEROLES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_user_site_role_association_using_get
Role get_user_site_role_association_using_get(userid, roleid)
Get site role assigned to user
Get the specified site role assigned to the specified user. Caller requires the USERSITEROLES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user to which the role is assigned. | |
| roleid | str | The UUID of the role assigned to the user. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
list_site_roles_using_get
List[RoleUser] list_site_roles_using_get()
List roles
List all roles. Caller requires the ROLES:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
modify_user_site_role_association_using_put
modify_user_site_role_association_using_put(userid, roleid)
Set user role
Set the role of the given user to the given role. Caller requires the USERSITEROLES:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user whose role is to be modified. | |
| roleid | str | The UUID of the role which will be assigned to the user. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |