OAuthRolesApi
| Method | HTTP request | Description |
|---|---|---|
| list_o_auth_roles_using_get | GET /api/web/v1/oauthroles | List oauth roles |
| modify_user_o_auth_role_associations_using_put | PUT /api/web/v1/useroauthrole/{userid}/oauthroles | Modify user oauth role membership |
list_o_auth_roles_using_get
List[OAuthRole] list_o_auth_roles_using_get()
List oauth roles
List all oauth roles. Caller requires the OAUTHROLES:VIEW permission.
- 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_o_auth_role_associations_using_put
modify_user_o_auth_role_associations_using_put(userid, request_body)
Modify user oauth role membership
Modify the list of oauth roles assigned to a specified user. Caller requires the USERS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user whose oauth role membership is to be modified. | |
| request_body | List[str] |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- 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 | - |