Roles

Get a role, with its generated Cedar

Changed on

Returns one built-in or custom role with its permission ids and holder counts. A custom role also carries its conditions and the Cedar generated from it.

Requires the role.read permission. See Permissions for the roles and API key permissions that include it.

get/v1/roles/{roleId}

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/roles/{roleId}
  • Auth
    HTTP bearer

Path parameters

roleIdstring required

Response

The role

builtinboolean required
cedarstring

The Cedar policies generated for the role (custom roles only).

createdAtstring
createdBystring
descriptionstring
endpointsstring[]

Dedicated endpoints every holder of the role is limited to.

idstring required

A built-in role id (owner, admin, member, billing, inference, viewer) or a custom role id (role_...).

ipRangesstring[]

Networks every holder of the role is limited to.

memberCountinteger
modelsstring[]

Models every holder of the role is limited to.

namestring required
permissionsstring[] required
stalestring

Set when the role names a permission this version of OpenRelay does not know, or no longer compiles: what it does now and what to change. The rest of the role still applies.

updatedAtstring
updatedBystring

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 551a288b9aa0Revision changes
    • warning

      removed the optional property from the response with the status