Path: / admin / realms / {realm} / roles / {role-name}

Get a role by name

Path parameters:
realm - realm name (not id!)
role-name - role's name (not id!)

Sub-Resources
Resources
NameDescription
compositesList composites of this role

Resource Methods
Method Summary
NameDescription
GET /admin/realms/{realm}/roles/{role-name}Get a role by name
DELETE /admin/realms/{realm}/roles/{role-name}Delete a role by name
PUT /admin/realms/{realm}/roles/{role-name}Update a role by name

Method Detail

GET /admin/realms/{realm}/roles/{role-name}

Get a role by name

HTTP Example:
GET /admin/realms/{realm}/roles/{role-name}
API Example:

RoleContainerResource.getRole({'realm': /* name realm name (not id!) */,
  'role-name': /* roleName role's name (not id!) */});

Output:
RoleRepresentation -
Produces:
application/json

DELETE /admin/realms/{realm}/roles/{role-name}

Delete a role by name

HTTP Example:
DELETE /admin/realms/{realm}/roles/{role-name}
API Example:

RoleContainerResource.deleteRole({'realm': /* name realm name (not id!) */,
  'role-name': /* roleName role's name (not id!) */});

Output:
void

PUT /admin/realms/{realm}/roles/{role-name}

Update a role by name

HTTP Example:
PUT /admin/realms/{realm}/roles/{role-name}
API Example:

RoleContainerResource.updateRole({'realm': /* name realm name (not id!) */,
  'role-name': /* roleName role's name (not id!) */,
  '$entity': /* rep */});

Input:
RoleRepresentation
Output:
Response -
Consumes:
application/json