Path: / admin / realms / {realm}

Get the top-level representation of the realm. It will not include nested information like User, Application, or OAuth Client representations.

Path parameters:
realm - realm name (not id!)

Resources
NameDescription
application-session-statsReturns a JSON map.
applicationsList of applications belonging to this realm.
auditView the audit provider and how it is configured.
logout-allRemoves all user sessions.
oauth-clientsGet a list of oauth clients in this realm.
push-revocationPush the realm's revocation policy to any application that has an admin url associated with it.
rolesList all roles for this realm or application
roles-by-id
roles-by-id/{role-id}
Get a specific role's representation
session-statsAny application that has an admin URL will be asked directly how many sessions they have active and what users are involved with those sessions.
sessions
sessions/{session}
Remove a specific user session.
usersQuery list of users.

Method Summary
ResourceDescription
GET /admin/realms/{realm}Get the top-level representation of the realm.
PUT /admin/realms/{realm}Update the top-level information of this realm.
DELETE /admin/realms/{realm}Delete this realm.

Method Detail
HTTP Example:
GET /admin/realms/{realm}

Get the top-level representation of the realm. It will not include nested information like User, Application, or OAuth Client representations.

Output:
RealmRepresentation -
Produces:
application/json
HTTP Example:
PUT /admin/realms/{realm}

Update the top-level information of this realm. Any user, roles, application, or oauth client information in the representation will be ignored. This will only update top-level attributes of the realm.

Input:
RealmRepresentation
Output:
javax.ws.rs.core.Response -
Consumes:
application/json
HTTP Example:
DELETE /admin/realms/{realm}

Delete this realm.

Output:
void