API ReferenceRoles

Get role

Get a role by name.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

role-namestringRequired

role’s name (not id!)

realmstringRequired

Response

idstringOptional
namestringOptional
descriptionstringOptional
compositebooleanOptional
compositesobjectOptional
clientRolebooleanOptional
containerIdstringOptional
attributesmap from strings to lists of stringsOptional
scopeParamRequiredbooleanOptionalDeprecated

Errors

403
Forbidden Error
404
Not Found Error