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.

Check if ABAC attribute is in use

Prev Next
Get
/api/v1/abac/attributes/:key/is-in-use
Defense
  • Checks whether an ABAC attribute definition is currently used by any room.
  • Requires the abac-management and manage-abac-admin-room-attributes permissions.

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

OK

Success
{
  "success": true,
  "inUse": true
}
object
success
boolean
inUse
boolean
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