permissionAndRoleManagement

List system and custom roles

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

Organisation.Role + List

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge></div> </Info>

Returns all roles in the Workspace. System roles come first, in the order Administrator, User, and Observer, followed by custom roles alphabetically.

Pass include_permissions=true to also receive each role's permission list. Use my in place of a numeric orgId to target the caller's own Workspace.

get/api/v1/organisation/{orgId}/role

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/organisation/{orgId}/role
  • Auth: HTTP bearer

Path parameters

integer required
OR
'my' required

Workspace identifier. Either a positive integer organization ID, or the literal string my to target the caller's own Workspace.

Query parameters

include_permissionsboolean

When true, each returned role also includes its permissions array. Defaults to false to keep the list response light.

Response

Successful response.

idnumber double required

Unique role identifier.

namestring required

Display name of the role.

name_translation_keystring nullable required

Translation key for the role name. Set for system roles only.

descriptionstring required

Human-readable description of the role. An empty string when no description has been set.

description_translation_keystring nullable required

Translation key for the role description. Set for system roles only.

user_countnumber double required

Number of users assigned to this role in the Workspace.

type'system' | 'custom' required

Whether this is a system-defined role or an organization's custom role.

is_system_roleboolean required

True for built-in system roles, which can't be modified or deleted.

Changes

No recorded changes to this operation across all 1 revision of this API.