Documentation Index

Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt

Use this file to discover all available pages before exploring further.

Update ABAC attribute definition

Prev Next
Put
/api/v1/abac/attributes/:_id
Defense
  • Updates an existing ABAC attribute definition.
  • Modifies the attribute identified by _id, allowing you to rename its key, change its list of allowed values, or both, subject to in-use and validation checks.
  • Requires the ABAC license, the abac-management and manage-abac-admin-room-attributes permissions, and the global setting ABAC_Enabled to be turned on.

Changelog

Version Description
8.0.0 Added
8.5.0 Added the manage-abac-admin-room-attributes granular permission requirement.
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
object
key
string Required
values
Array of string Required
string
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

ABAC disabled
{
  "success": false,
  "error": "error-abac-not-enabled"
}
Attribute not found
{
  "success": false,
  "error": "error-attribute-not-found"
}
Attribute in use (cannot rename key / cannot remove used values)
{
  "success": false,
  "error": "error-attribute-in-use"
}
Invalid values (e.g. empty values)
{
  "success": false,
  "error": "error-invalid-attribute-values"
}
Duplicate attribute key (renaming to an existing key)
{
  "success": false,
  "error": "error-duplicate-attribute-key"
}
object
success
boolean
error
string
401

Unauthorized

Unauthorized login attempt
{
  "success": false,
  "error": "error-unauthorized"
}
object
success
boolean
error
string
403

Forbidden

Missing required ABAC permissions
{
  "success": false,
  "error": "error-not-authorized"
}
object
success
boolean
error
string