Assignments

Assigning an Actor to a server-wide Role

Changed on

Given a roleId, which may be a numeric ID or a string role system name, and a numeric actorId, assigns that Role to that Actor across the entire server.

No POST body data is required, and if provided it will be ignored.

post/v1/assignments/{roleId}/{actorId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/assignments/{roleId}/{actorId}
  • Auth
    none declared

Path parameters

roleIdstring required

Typically the integer ID of the Role. You may also supply the Role system name if it has one.

actorIdnumber required

The integer ID of the Actor.

Response

OK

successboolean required

Example response

{
  "success": true
}

Changes