List ABAC Attribute Keys

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

Lists the attribute keys in the active attribute store, sorted alphabetically. Use the returned keys as the values of the Attributes required in all ABAC rooms setting (ABAC_Required_Attributes), which applies while Enforce ABAC across all workspace rooms is on.

Each item has a key and a label. Both hold the attribute key.

Permission required: manage-abac-admin-settings

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
Responses
200

OK

Success Example
{
  "data": [
    {
      "key": "clearance",
      "label": "clearance"
    },
    {
      "key": "department",
      "label": "department"
    }
  ],
  "success": true
}
Expand All
object
data
Array of object
object
key
string
label
string
success
boolean
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