RolesApi

Method	HTTP request	Description
DeleteUserSiteRoleAssociationUsingDELETE	DELETE /api/web/v1/users/{userid}/roles/{roleid}	Delete a site role from a user
GetSiteRoleUsingGET	GET /api/web/v1/roles/{id}	Get a role
GetUserRolesUsingGET	GET /api/web/v1/users/{userid}/roles	List all site roles assigned to user
GetUserSiteRoleAssociationUsingGET	GET /api/web/v1/users/{userid}/roles/{roleid}	Get site role assigned to user
ListSiteRolesUsingGET	GET /api/web/v1/roles	List roles
ModifyUserSiteRoleAssociationUsingPUT	PUT /api/web/v1/users/{userid}/roles/{roleid}	Set user role

DeleteUserSiteRoleAssociationUsingDELETE

void DeleteUserSiteRoleAssociationUsingDELETE (string userid, string roleid)

Delete a site role from a user

Delete a user's site role. Caller requires the USERSITEROLES:REMOVE permission.

Using the DeleteUserSiteRoleAssociationUsingDELETEWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user from which the role is to be removed.
roleid	string	The UUID of the role that is to be removed.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-

GetSiteRoleUsingGET

Role GetSiteRoleUsingGET (string id)

Get a role

Get a specified role. Caller requires the ROLES:VIEW permission.

Example

Using the GetSiteRoleUsingGETWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
id	string	The UUID of the role to be fetched.

Return type

Role

Authorization

AdminAPIAuthentication

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	-

GetUserRolesUsingGET

List<Role> GetUserRolesUsingGET (string userid)

List all site roles assigned to user

List all site roles assigned to the specified user. Caller requires the USERSITEROLES:VIEW permission.

Example

Using the GetUserRolesUsingGETWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user.

Return type

List<Role>

Authorization

AdminAPIAuthentication

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	-

GetUserSiteRoleAssociationUsingGET

Role GetUserSiteRoleAssociationUsingGET (string userid, string roleid)

Get site role assigned to user

Get the specified site role assigned to the specified user. Caller requires the USERSITEROLES:VIEW permission.

Example

Using the GetUserSiteRoleAssociationUsingGETWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user to which the role is assigned.
roleid	string	The UUID of the role assigned to the user.

Return type

Role

Authorization

AdminAPIAuthentication

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	-

ListSiteRolesUsingGET

List<RoleUser> ListSiteRolesUsingGET ()

List roles

List all roles. Caller requires the ROLES:VIEW permission.

Example

Using the ListSiteRolesUsingGETWithHttpInfo 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<RoleUser>

Authorization

AdminAPIAuthentication

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	-

ModifyUserSiteRoleAssociationUsingPUT

void ModifyUserSiteRoleAssociationUsingPUT (string userid, string roleid)

Set user role

Set the role of the given user to the given role. Caller requires the USERSITEROLES:EDIT permission.

Example

Using the ModifyUserSiteRoleAssociationUsingPUTWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user whose role is to be modified.
roleid	string	The UUID of the role which will be assigned to the user.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-