Access control
List roles
List built-in and custom roles for the current organization.
/organizations/rolesList built-in and custom roles for the current organization. A built-in role_id looks like system:admin, and a custom role_id looks like role_....
Use role_id to update or delete a role, and the identifier when you assign one.
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-keystring
Enterprise API key, or an OAuth access token.
Response
The response is a JSON array of roles.
role_idstring
Id of the role. Built-in roles look like system:admin. Custom roles look like role_....
slugstring
Identifier of the role. Use it when you Assign role.
namestring
Display name of the role.
descriptionstring
What the role is for.
permissionsstring[]
Permissions on the role. See the permission catalog.