This feature is only available in the Enterprise version

Access control

Create role

Create a custom organization role.

POST/organizations/roles

Create a custom role for the current organization. The identifier cannot be a built-in 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.

Body

slugstringrequiredbody

Identifier for the role, such as finance-ops. 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

A 201 response returns the created role. Save role_id.

role_idstringrequired

Id of the role (role_...). Use it to update or delete the role.

slugstringrequired

Identifier of the role. Use it when you Assign role.

namestringrequired

Display name of the role.

descriptionstring

What the role is for.

permissionsstring[]required

Permissions on the role.