Package com.nimbusds.oauth2.sdk.client

Class ClientInformationResponse

java.lang.Object
com.nimbusds.oauth2.sdk.client.ClientRegistrationResponse
com.nimbusds.oauth2.sdk.client.ClientInformationResponse
All Implemented Interfaces:
Message, Response, SuccessResponse
Direct Known Subclasses:
OIDCClientInformationResponse
@Immutable public class ClientInformationResponse extends ClientRegistrationResponse implements SuccessResponse
Client information response.

Example HTTP response: 

 HTTP/1.1 200 OK
 Content-Type: application/json
 Cache-Control: no-store
 Pragma: no-cache

 {
  "registration_access_token"  : "reg-23410913-abewfq.123483",
  "registration_client_uri"    : "https://server.example.com/register/s6BhdRkqt3",
  "client_id"                  : "s6BhdRkqt3",
  "client_secret"              : "cf136dc3c1fc93f31185e5885805d",
  "client_id_issued_at"        : 2893256800
  "client_secret_expires_at"   : 2893276800
  "client_name"                : "My Example Client",
  "client_name#ja-Jpan-JP"     : "クライアント名",
  "redirect_uris"              : [ "https://client.example.org/callback",
                                   "https://client.example.org/callback2" ]
  "scope"                      : "read write dolphin",
  "grant_types"                : [ "authorization_code", "refresh_token" ]
  "token_endpoint_auth_method" : "client_secret_basic",
  "logo_uri"                   : "https://client.example.org/logo.png",
  "jwks_uri"                   : "https://client.example.org/my_public_keys.jwks"
 }

Related specifications:

  • OAuth 2.0 Dynamic Client Registration Management Protocol (RFC 7592), section 3.1.
  • OAuth 2.0 Dynamic Client Registration Protocol (RFC 7591), section 3.2.1.

  • Constructor Details

    • ClientInformationResponse

      public ClientInformationResponse(ClientInformation clientInfo, boolean forNewClient)
      Creates a new client information response.
      Parameters:
      clientInfo - The client information. Must not be null.
      forNewClient - true for a newly registered client, false for a retrieved or updated client.

  • Method Details

    • indicatesSuccess

      public boolean indicatesSuccess()
      Description copied from interface: Response
      Checks if the response indicates success.
      Specified by:
      indicatesSuccess in interface Response
      Returns:
      true if the response indicates success, else false.

    • getClientInformation

      public ClientInformation getClientInformation()
      Gets the client information.
      Returns:
      The client information.

    • isForNewClient

      public boolean isForNewClient()
      Checks if the client information response is for a new client.
      Returns:
      true for a newly registered client, false for a retrieved or updated client.

    • toHTTPResponse

      public HTTPResponse toHTTPResponse()
      Description copied from interface: Response
      Returns the matching HTTP response.
      Specified by:
      toHTTPResponse in interface Response
      Returns:
      The HTTP response.

    • parse

      public static ClientInformationResponse parse(HTTPResponse httpResponse) throws ParseException
      Parses a client information response from the specified HTTP response.
      Parameters:
      httpResponse - The HTTP response. Must not be null.
      Returns:
      The client information response.
      Throws:
      ParseException - If the HTTP response couldn't be parsed to a client information response.