Replace organization role set for user

Atomically replace the complete role set a user holds in the organization. At most one system role plus any number of custom roles; the set must not be empty. Requires custom roles (Enterprise).

PUT /api/v2/orgs/{orgUuid}/roles/assignments/user/{userId}/set

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "customRoleUuids": [
      "<string>"
    ],
    "systemRole": "member"
  },
  "status": "ok"
}

Path Parameters

orgUuid · string<uuid> · required

Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

userId · string<uuid> · required

Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Body

application/json

Complete set of roles held at one level: at most one system role plus any number of custom roles. Permissions are the union of all held roles.

customRoleUuids · string[] · required

systemRole · enum<string> | null · required

Available options: member, viewer, interactive_viewer, editor, developer, admin

Response

200

application/json

Success

results · object · required

Complete set of roles held at one level: at most one system role plus any number of custom roles. Permissions are the union of all held roles.

Show child attributes

status · enum<string> · required

Available options: ok