Open Dashboard

This feature is only available in the Enterprise version

Access control

Update role

Update a custom organization role.

PUT/organizations/roles/{role_id}

Update a custom role.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Path

role_idstringrequiredpath

Id of the custom role (role_...).

Body

slugstringrequiredbody

Identifier for the role. Must not be admin, member, operator, analyst, or investigator.

namestringrequiredbody

Display name of the role.

descriptionstringbody

What the role is for.

permissionsstring[]requiredbody

Permissions on the role. At least one. Each value must be from the permission catalog.

Response

The response is the updated role.

role_idstringrequired

Id of the role. This stays the same when the identifier changes.

slugstringrequired

Identifier of the role.

namestringrequired

Display name of the role.

descriptionstring

What the role is for.

permissionsstring[]required

Permissions on the role.