Retrieve Role details

Returns one role.

{id} is the role’s name — a slug such as midaz-editor, not a UUID. Called to open a role’s detail screen, and before a PATCH. The permissions inside the role are read separately with GET /v1/roles/{id}/permissions.

Read-only: nothing changes.

Failures:

• 404 — no such role in your organization.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

GET /v1/roles/{id}

Retrieve Role details

cURL

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/roles/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "createdAt": "2026-06-24T10:00:00Z",
  "description": "A custom editor role",
  "groups": [
    "<string>"
  ],
  "id": "custom-editor",
  "isEnabled": true,
  "isSystem": false,
  "name": "Custom Editor",
  "roles": [
    "<string>"
  ],
  "users": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Role ID.

Example:

"midaz-editor"

Response

200

application/json

OK

createdAt · string

Example:

"2026-06-24T10:00:00Z"

description · string

Example:

"A custom editor role"

groups · string[]

id · string

Example:

"custom-editor"

isEnabled · boolean

Example:

true

isSystem · boolean

Example:

false

name · string

Example:

"Custom Editor"

roles · string[]

users · string[]