permissionAndRoleManagement

Delete a custom role

<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 + Delete

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

Deletes a custom role. The request fails if the role is a system role, or if any users are still assigned to it.

Use my in place of a numeric orgId to target the caller's own Workspace.

delete/api/v1/organisation/{orgId}/role/{roleId}

Request

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

Path parameters

roleIdinteger required

Numeric identifier of the role.

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

Role deleted.

object required

Changes

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