Assign a User to a User Group

post/accountmanager.assigngroup/{userId}

Assigns a User Group to the specified user.

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

The ID of the user you want to add to the group. 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 add the user to the User Group. Set false to remove the user from the group.

typedId
required
string non-empty

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

uniqueName
required
string [ 1 .. 255 ] characters

uniqeName of the User Group you want to assign or revoke. Either typedId or uniqeName is required.

Responses
200

OK

Response Schema: application/json
object
node
string non-empty
csrfToken
string non-empty
data
any
status
number
Request samples
application/json
{
  • "data": {
    • "assign": true,
    • "uniqueName": "PricingManagers",
    • "typedId": "15666.UG"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "csrfToken": "string",
    • "data": null,
    • "status": 0
    }
}