Path: / admin / realms / {realm} / applications-by-id / {app-name}

Get representation of the application.

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

Sub-Resources
Resources
NameDescription
allowed-originsReturns set of allowed origin.
certificates
certificates/{attr}
client-secretGet the secret of this application
installation
logout-allIf the application has an admin URL, invalidate all sessions associated with that application directly.
logout-user
logout-user/{username}
If the application has an admin URL, invalidate the sessions for a particular user directly.
nodesManually register cluster node to this application - usually it's not needed to call this directly as adapter should handle by sending registration request to Keycloak
protocol-mappers
push-revocationIf the application has an admin URL, push the application's revocation policy to it.
rolesList all roles for this realm or application
scope-mappingsGet all scope mappings for this client
session-countNumber of user sessions associated with this application { "count": number }
test-nodes-availableTest if registered cluster nodes are available by sending 'ping' request to all of them
user-sessionsReturn a list of user sessions associated with this application

Resource Methods
Method Summary
NameDescription
PUT /admin/realms/{realm}/applications-by-id/{app-name}Update the application.
GET /admin/realms/{realm}/applications-by-id/{app-name}Get representation of the application.
DELETE /admin/realms/{realm}/applications-by-id/{app-name}Delete this application.

Method Detail

PUT /admin/realms/{realm}/applications-by-id/{app-name}

Update the application.

HTTP Example:
PUT /admin/realms/{realm}/applications-by-id/{app-name}
API Example:

ApplicationResource.update({'realm': /* name realm name (not id!) */,
  'app-name': /* name */,
  '$entity': /* rep */});

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

GET /admin/realms/{realm}/applications-by-id/{app-name}

Get representation of the application.

HTTP Example:
GET /admin/realms/{realm}/applications-by-id/{app-name}
API Example:

ApplicationResource.getApplication({'realm': /* name realm name (not id!) */,
  'app-name': /* name */});

Output:
ApplicationRepresentation -
Produces:
application/json

DELETE /admin/realms/{realm}/applications-by-id/{app-name}

Delete this application.

HTTP Example:
DELETE /admin/realms/{realm}/applications-by-id/{app-name}
API Example:

ApplicationResource.deleteApplication({'realm': /* name realm name (not id!) */,
  'app-name': /* name */});

Output:
void