Path: / admin / realms / {realm} / oauth-clients / {clientId}

Get a representation of the oauth client

Path parameters:
realm - realm name (not id!)
clientId - oauth client's clientId

Sub-Resources
Resources
NameDescription
certificates
certificates/{attr}
client-secretGet the secret of the oauth client
installationGet an example keycloak.json file to use to configure the oauth client
protocol-mappers
scope-mappingsGet all scope mappings for this client

Resource Methods
Method Summary
NameDescription
PUT /admin/realms/{realm}/oauth-clients/{clientId}Update the oauth client
GET /admin/realms/{realm}/oauth-clients/{clientId}Get a representation of the oauth client
DELETE /admin/realms/{realm}/oauth-clients/{clientId}Remove the OAuth Client

Method Detail

PUT /admin/realms/{realm}/oauth-clients/{clientId}

Update the oauth client

HTTP Example:
PUT /admin/realms/{realm}/oauth-clients/{clientId}
API Example:

OAuthClientResource.update({'realm': /* name realm name (not id!) */,
  'clientId': /* clientId oauth client's clientId */,
  '$entity': /* rep */});

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

GET /admin/realms/{realm}/oauth-clients/{clientId}

Get a representation of the oauth client

HTTP Example:
GET /admin/realms/{realm}/oauth-clients/{clientId}
API Example:

OAuthClientResource.getOAuthClient({'realm': /* name realm name (not id!) */,
  'clientId': /* clientId oauth client's clientId */});

Output:
OAuthClientRepresentation -
Produces:
application/json

DELETE /admin/realms/{realm}/oauth-clients/{clientId}

Remove the OAuth Client

HTTP Example:
DELETE /admin/realms/{realm}/oauth-clients/{clientId}
API Example:

OAuthClientResource.deleteOAuthClient({'realm': /* name realm name (not id!) */,
  'clientId': /* clientId oauth client's clientId */});

Output:
void