Assign a Role to Users

post/accountmanager.assignrole

Assigns a role to multiple users.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
assign
required
boolean

Set to true to assign the user to the role. Set false to remove the role from the user.

typedId
required
string non-empty

TypedId of the role you want to assign or revoke. Either typedId or uniqeName is required.

uniqueName
required
string non-empty

uniqueName of the role you want to assign or revoke. Either typedId or uniqeName is required.

users
required
Array of strings

The list of users' typedIds or loginName. Can be mixed.

Responses
200

OK

Response Schema: application/json
object
node
string non-empty
data
any
status
number
Request samples
application/json
{
  • "data": {
    • "assign": true,
    • "typedId": "8.R",
    • "uniqueName": "DASHBOARDADMIN",
    • "users": [
      • "2147491023.U",
      • "john.doe"
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": null,
    • "status": 0
    }
}