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.

Using the ListOAuthRolesUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

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

void ModifyUserOAuthRoleAssociationsUsingPUT (string userid, List<string> requestBody)

Modify user oauth role membership

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

Example

Using the ModifyUserOAuthRoleAssociationsUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

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

Return type

void (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-