Assign a Role to a User

post/accountmanager.assignrole/{userId}

Assigns a role to a user.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
userId
required
string

The ID of the user you want to assign a role to. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806.

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.

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
    }
}