Service: OAuth2 Client Info

** WARNING: This service is experimental and may change without any notice.

retrieves information of a registered OAuth2 client. Registration information is only shown to the owner. If the OAuth2 client is a plugin, the information includes the plugin source.

This service is not part of the general OAuth2 specification. Only super clients are allowed to use this service. It requires super client authentications..

Available in: full version

Method: POST

Service URL: root/oauth2/client/{client_id}

Parameters

Header Parameters

Name	Required	Description	Value
Authorization	yes	HTTP authentication with scheme: Bearer	OAuth2 access token

Path parameters

Name	Required	Description	Type
client_id	yes	A client identifier obtained on client registration	String

Request body

URL-encoded form parameters

Name	Required	Description	Type
super_client_id	yes	A super client identifier obtained on client registration.	String
super_client_secret	yes, for confidential clients	A super client secret obtained on client registration.	String

Examples

Requesting client info

curl -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' 
     -d 'super_client_id=fCBbQkA2YzIxYmY1Ng==&super_client_secret=
         Z0yTxWfoVPT3APmkU8mQoc7lyA9LvUmJQADwHhFLNIeOARoF0T47gc4hPXm9fwHV'  
     http://localhost:8089/api/v1.0/oauth2/client/MfJMHP77FrM4pbN46rtHdM

Response

{
  "permitted": true,
  "super": false,
  "client_id": "MfJMHP77FrM4pbN46rtHdM",
  "client_name": "Confidential client",
  "client_type": "CONFIDENTIAL",
  "client_description": "This is a confidential test client.",
  "client_url": "http://example.client.com",
  "client_redirect_uri": "https://example.client.com/redirect",
  "registration_date": "2022-05-04T13:04:34.415+02:00[Europe/Berlin]",
  "registered_by": "username"
}

Requesting plugin info

curl -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' 
     -d 'super_client_id=fCBbQkA2YzIxYmY1Ng==&super_client_secret=
         Z0yTxWfoVPT3APmkU8mQoc7lyA9LvUmJQADwHhFLNIeOARoF0T47gc4hPXm9fwHV'  
     http://localhost:8089/api/v1.0/oauth2/client/r6RMbLdMG3n4JLbMt9Ndbm

Response

{
  "source" : {
    "plugin" : "source"
  },
  "permitted" : false,
  "super" : false,
  "client_id" : "r6RMbLdMG3n4JLbMt9Ndbm",
  "client_name" : "Plugin",
  "client_type" : "CONFIDENTIAL",
  "client_description" : "This is a plugin test client."  
}