Remove role for users


Revokes a role for the specified users.

This topic includes the following sections:

Request

HTTP method: POST

URL: https://<hostname>:<port>/rsso/config/local/role/removeusers

Header: For header information, such as required authentication token, see Remedy-SSO-administrator-Login-and-Logout-calls.

Request body properties

Properties

Type

Required

Description

Values

Default value

roleName

String

Yes

Name of the role

User-provided value

Existing user-defined value

NA

loginNames

String array

Yes

Login names of one or more users

User-provided value

Existing user-defined value

NA

Example request JSON

{
 "roleName":"aRole",
 "loginNames":["aLogin1", "aLogin2"]
}

Response

If successful, this method revokes the role assignment for the specified users.

Response body properties

Property

Description

code

Status code (see Status codes and messages)

msg

Status 

data

NA

Example response JSON

{
 "code":200,
 "msg":"OK",
 "data":{}
}

Status codes and messages

For more details about HTTP response codes, see HTTP response codes.

HTTP code

Message (msg)

Description

200

OK

Request succeeded

400

 

Bad request

Some causes are

  • Role with specified name does not exist
  • User with specified login does not exist

401

 

Unauthorized

Related topics

Format-of-API-examples

Assign-users-to-role

Create-local-user

Search-local-user

Edit-local-user

Delete-local-user

Create-role

Search-role

Edit-role

Delete-role

 

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*