permissionAndRoleManagement

List available permissions

<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.Permission + List

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

Returns the catalog of permissions usable in this Workspace, excluding deleted permissions. Deprecated permissions are still returned with deprecated_at populated, so consumers can surface end-of-life warnings.

The catalog isn't paginated. Use my in place of a numeric orgId to target the caller's own Workspace.

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

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/organisation/{orgId}/permission
  • 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.

Response

Successful response.

idnumber double required

Unique permission identifier.

resourcestring required

Resource the permission applies to.

actionstring required

Action the permission grants on the resource.

created_atstring date-time required

When the permission was created.

updated_atstring date-time required

When the permission was last updated.

deprecated_atstring date-time nullable required

Set once the permission is end-of-life. The permission is still returned so clients can warn users, but it can't be assigned to new or updated custom roles.

Changes

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