com.nimbusds.openid.connect.sdk
Class OIDCClientRegisterRequest

java.lang.Object
  com.nimbusds.oauth2.sdk.ProtectedResourceRequest
      com.nimbusds.openid.connect.sdk.OIDCClientRegisterRequest

All Implemented Interfaces:

Message, Request

@Immutable
public final class OIDCClientRegisterRequest
extends ProtectedResourceRequest

OpenID Connect client register request. This class is immutable.

Example HTTP request:

 POST /connect/register HTTP/1.1
 Content-Type: application/json
 Accept: application/json
 Host: server.example.com
 Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJ ...

 {
 "application_type"                : "web",
 "redirect_uris"                   : [ "https://client.example.org/callback",
                                       "https://client.example.org/callback2" ],
 "client_name"                     : "My Example",
 "client_name#ja-Jpan-JP"          : "クライアント名",
 "logo_uri"                        : "https://client.example.org/logo.png",
 "subject_type"                    : "pairwise",
 "sector_identifier_uri"           : "https://other.example.net/file_of_redirect_uris.json",
 "token_endpoint_auth_method"      : "client_secret_basic",
 "jwks_uri"                        : "https://client.example.org/my_public_keys.jwks",
 "userinfo_encrypted_response_alg" : "RSA1_5",
 "userinfo_encrypted_response_enc" : "A128CBC-HS256",
 "contacts"                        : [ "[email protected]", "[email protected]" ],
 "request_uris"                    : [ "https://client.example.org/rf.txt#qpXaRLh_n93TTR9F252ValdatUQvQiJi5BDub2BeznA" ]
 }
 

Related specifications:

• OpenID Connect Dynamic ClientDetails Registration 1.0, section 3.1.

Author:

Vladimir Dzhuvinov

Constructor Summary

OIDCClientRegisterRequest(ClientDetails client, BearerAccessToken accessToken)
Creates a new OpenID Connect client register request.

Method Summary

ClientDetails	getClientDetails() Gets the associated client details.
static OIDCClientRegisterRequest	parse(HTTPRequest httpRequest) Parses an OpenID Connect client register request from the specified HTTP POST request.
HTTPRequest	toHTTPRequest(URL url) Returns the matching HTTP request.

Methods inherited from class com.nimbusds.oauth2.sdk.ProtectedResourceRequest

getAccessToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OIDCClientRegisterRequest

public OIDCClientRegisterRequest(ClientDetails client,
                                 BearerAccessToken accessToken)

Creates a new OpenID Connect client register request.

Parameters:

client - The client details. Must not be null and must specify one or more redirect URIs.

accessToken - An OAuth 2.0 Bearer access token for the request, null if none.

Method Detail

getClientDetails

public ClientDetails getClientDetails()

Gets the associated client details.

Returns:

The client details.

toHTTPRequest

public HTTPRequest toHTTPRequest(URL url)

Description copied from interface: Request

Returns the matching HTTP request.

Parameters:

url - The URL of the HTTP endpoint for which the request is intended. Must not be null.

Returns:

The HTTP request.

parse

public static OIDCClientRegisterRequest parse(HTTPRequest httpRequest)
                                       throws ParseException

Parses an OpenID Connect client register request from the specified HTTP POST request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The client add (register) request.

Throws:

ParseException - If the HTTP request couldn't be parsed to a client register request.