Attach roles to access profile

Attaches one or more roles. Setting is_default: true makes the profile the role’s default for new users. apply_to_existing: true provisions the profile to users already in the role.

POST /api/access-profiles/{id}/roles

Error

A valid request URL is required to generate request examples

200

{
  "message": "<string>",
  "users_applied": 123
}

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Path Parameters

id · integer · required

Body

application/json

role_ids · integer<uint>[] · required

Minimum array length: 1

is_default · boolean

apply_to_existing · boolean

Response

200

application/json

Roles attached.

message · string

users_applied · integer