Skip to main content

OAuthRolesApi

MethodHTTP requestDescription
listOAuthRolesUsingGETGET /api/web/v1/oauthrolesList oauth roles
modifyUserOAuthRoleAssociationsUsingPUTPUT /api/web/v1/useroauthrole/{userid}/oauthrolesModify user oauth role membership

listOAuthRolesUsingGET

List<OAuthRole> listOAuthRolesUsingGET()

List oauth roles

List all oauth roles. Caller requires the OAUTHROLES:VIEW permission.

Parameters

This endpoint does not need any parameter.

Return type

List<OAuthRole>

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

modifyUserOAuthRoleAssociationsUsingPUT

modifyUserOAuthRoleAssociationsUsingPUT(userid, requestBody)

Modify user oauth role membership

Modify the list of oauth roles assigned to a specified user. Caller requires the USERS:EDIT permission.

Example

Parameters

NameTypeDescriptionNotes
useridStringThe UUID of the user whose oauth role membership is to be modified.
requestBodyList<String>

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-