List Assignable ABAC Attributes

Prev Next
Get
/api/v1/abac/attributes.listAssignable
Defense

Lists the ABAC attributes and values the caller can assign, sorted by key. ABAC must be enabled.

  • Without rid, the list covers a new ABAC-managed private room or team. Permission required: create-abac-managed-room.
  • With rid, the list covers the attributes of that existing room. Permissions required: abac-management and manage-abac-admin-rooms, or edit-room-abac-attributes in that room.

With the local attribute store, the list contains every attribute definition. When Restrict room creators and editors to attributes they hold is on, it is limited to the values the caller holds plus, with rid, the values the room already has. ABAC administrators editing an existing room and users with bypass-abac-store-validation are not limited. With an external attribute store such as Virtru, the list contains the caller's entitlements.

requiredKeys lists the attribute keys every ABAC room must carry while Enforce ABAC across all workspace rooms is on. It is empty otherwise.

Changelog

Version Description
9.0.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
rid
string

Optional. The ID of an existing room. Include it to list the attributes you can assign to that room. Omit it to list the attributes you can assign when creating a room.

Example64f0a1c2b3d4e5f6a7b8c9d0
Responses
200

OK

Success Example
{
  "attributes": [
    {
      "key": "clearance",
      "values": [
        "confidential",
        "secret"
      ]
    },
    {
      "key": "department",
      "values": [
        "engineering"
      ]
    }
  ],
  "requiredKeys": [
    "clearance"
  ],
  "success": true
}
Expand All
object
attributes
Array of object
object
key
string
values
Array of string
string
requiredKeys
Array of string
string
success
boolean
400

Bad Request

ABAC not enabled
{
  "success": false,
  "error": "error-abac-not-enabled",
  "errorType": "error-abac-not-enabled"
}
Expand All
object
success
boolean
error
string
errorType
string
details
object

Present only when a specific attribute or cause is at fault.

401

Unauthorized

Authorization Error
{
  "success": false,
  "error": "You must be logged in to do this."
}
object
success
boolean
error
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string