Get role
GET
/api/v1/roles/{name}
const url = 'https://example.com/api/v1/roles/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/roles/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
Responses
Section titled “Responses”OK
Media typeapplication/json
object
createdAt
required
string format: date-time
id
required
string
idpGroups
Array<string>
includes
Array<string>
name
required
string
permissions
required
Array<string>
scope
required
object
folder
string
selector
string
tenantId
string
system
boolean
tenantId
required
string
updatedAt
required
string format: date-time
version
required
integer
Examplegenerated
{ "createdAt": "2026-04-15T12:00:00Z", "id": "example", "idpGroups": [ "example" ], "includes": [ "example" ], "name": "example", "permissions": [ "example" ], "scope": { "folder": "example", "selector": "example", "tenantId": "example" }, "system": true, "tenantId": "example", "updatedAt": "2026-04-15T12:00:00Z", "version": 1}default
Section titled “default”Problem Details (RFC 9457)
Media typeapplication/problem+json
object
code
required
string
detail
string
instance
string
status
required
integer
title
required
string
type
required
string
Examplegenerated
{ "code": "example", "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}