Put
/api/v1/abac/rooms/:rid/attributes/:key
- Sets the values of a single ABAC attribute on a room.
- Replaces the existing values for the given attribute key on the specified room with the provided values array (or creates the attribute if it does not yet exist), enforcing the global attribute definition and ABAC validation rules.
- Requires the ABAC license, the
abac-managementandmanage-abac-admin-roomspermissions, and the global settingABAC_Enabledto be turned on.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | Added |
| 8.5.0 | Added the manage-abac-admin-rooms 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
- Values (array of strings, required): The attribute values to assign for this key.
- Must have at least 1 item, max 10 items, and all values must be unique.
Example 1
{
"values": [
"eng",
"sales",
"hr"
]
}object
values
Array of string
string
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Attribute definition missing
{
"success": false,
"error": "error-attribute-definition-not-found"
}Invalid attribute values
{
"success": false,
"error": "error-invalid-attribute-values"
}Room not found
{
"success": false,
"error": "error-room-not-found"
}Cannot convert default room to ABAC
{
"success": false,
"error": "error-cannot-convert-default-room-to-abac"
}ABAC not enabled
{
"success": false,
"error": "error-abac-not-enabled"
}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