OIDRegistrationRequest Class Reference

Represents a registration request. More...

#import <OIDRegistrationRequest.h>

Inheritance diagram for OIDRegistrationRequest:

Instance Methods
(instancetype)	- initWithConfiguration:redirectURIs:responseTypes:grantTypes:subjectType:tokenEndpointAuthMethod:additionalParameters:
	Create a Client Registration Request to an OpenID Provider that supports open Dynamic Registration. More...
(instancetype)	- initWithConfiguration:redirectURIs:responseTypes:grantTypes:subjectType:tokenEndpointAuthMethod:initialAccessToken:additionalParameters:
	Designated initializer. More...
(NSURLRequest *)	- URLRequest
	Constructs an NSURLRequest representing the registration request. More...

Properties
OIDServiceConfiguration *	configuration
	The service's configuration. More...
NSString *	initialAccessToken
	The initial access token to access the Client Registration Endpoint (if required by the OpenID Provider). More...
NSString *	applicationType
	The application type to register, will always be 'native'. More...
NSArray< NSURL * > *	redirectURIs
	The client's redirect URI's. More...
NSArray< NSString * > *	responseTypes
	The response types to register for usage by this client. More...
NSArray< NSString * > *	grantTypes
	The grant types to register for usage by this client. More...
NSString *	subjectType
	The subject type to to request. More...
NSString *	tokenEndpointAuthenticationMethod
	The client authentication method to use at the token endpoint. More...
NSDictionary< NSString *, NSString * > *	additionalParameters
	The client's additional token request parameters.

Detailed Description

Represents a registration request.

See also

https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationRequest

Method Documentation

initWithConfiguration:redirectURIs:responseTypes:grantTypes:subjectType:tokenEndpointAuthMethod:additionalParameters:()

- (instancetype) initWithConfiguration:		(OIDServiceConfiguration *)	configuration
redirectURIs:		(NSArray< NSURL * > *)	redirectURIs
responseTypes:		(nullable NSArray< NSString * > *)	responseTypes
grantTypes:		(nullable NSArray< NSString * > *)	grantTypes
subjectType:		(nullable NSString *)	subjectType
tokenEndpointAuthMethod:		(nullable NSString *)	tokenEndpointAuthMethod
additionalParameters:		(nullable NSDictionary< NSString *, NSString * > *)	additionalParameters

Create a Client Registration Request to an OpenID Provider that supports open Dynamic Registration.

Parameters

configuration	The service's configuration.
redirectURIs	The redirect URIs to register for the client.
responseTypes	The response types to register for the client.
grantTypes	The grant types to register for the client.
subjectType	The subject type to register for the client.
tokenEndpointAuthMethod	The token endpoint authentication method to register for the client.
additionalParameters	The client's additional registration request parameters.

initWithConfiguration:redirectURIs:responseTypes:grantTypes:subjectType:tokenEndpointAuthMethod:initialAccessToken:additionalParameters:()

- (instancetype) initWithConfiguration:		(OIDServiceConfiguration *)	configuration
redirectURIs:		(NSArray< NSURL * > *)	redirectURIs
responseTypes:		(nullable NSArray< NSString * > *)	responseTypes
grantTypes:		(nullable NSArray< NSString * > *)	grantTypes
subjectType:		(nullable NSString *)	subjectType
tokenEndpointAuthMethod:		(nullable NSString *)	tokenEndpointAuthMethod
initialAccessToken:		(nullable NSString *)	initialAccessToken
additionalParameters:		(nullable NSDictionary< NSString *, NSString * > *)	NS_DESIGNATED_INITIALIZER

Designated initializer.

Parameters

configuration	The service's configuration.
redirectURIs	The redirect URIs to register for the client.
responseTypes	The response types to register for the client.
grantTypes	The grant types to register for the client.
subjectType	The subject type to register for the client.
tokenEndpointAuthMethod	The token endpoint authentication method to register for the client.
initialAccessToken	The initial access token to access the Client Registration Endpoint (if required by the OpenID Provider).
additionalParameters	The client's additional registration request parameters.

See also

https://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration

URLRequest()

- (NSURLRequest *) URLRequest

Constructs an NSURLRequest representing the registration request.

Returns

An NSURLRequest representing the registration request.

Property Documentation

applicationType

- (NSString*) applicationType

readnonatomicassign

The application type to register, will always be 'native'.

Remarks

application_type

See also

https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata

configuration

- (OIDServiceConfiguration*) configuration

readnonatomicassign

The service's configuration.

Remarks

This configuration specifies how to connect to a particular OAuth provider. Configurations may be created manually, or via an OpenID Connect Discovery Document.

grantTypes

- (NSArray<NSString *>*) grantTypes

readnonatomicassign

The grant types to register for usage by this client.

Remarks

grant_types

See also

https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata

initialAccessToken

- (NSString*) initialAccessToken

readnonatomicassign

The initial access token to access the Client Registration Endpoint (if required by the OpenID Provider).

Remarks

OAuth 2.0 Access Token optionally issued by an Authorization Server granting access to its Client Registration Endpoint. This token (if required) is provisioned out of band.

See also

Section 3 of OpenID Connect Dynamic Client Registration 1.0 https://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration

redirectURIs

- (NSArray<NSURL *>*) redirectURIs

readnonatomicassign

The client's redirect URI's.

Remarks

redirect_uris

See also

https://tools.ietf.org/html/rfc6749#section-3.1.2

responseTypes

- (NSArray<NSString *>*) responseTypes

readnonatomicassign

The response types to register for usage by this client.

Remarks

response_types

See also

http://openid.net/specs/openid-connect-core-1_0.html#Authentication

subjectType

- (NSString*) subjectType

readnonatomicassign

The subject type to to request.

Remarks

subject_type

See also

http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes

tokenEndpointAuthenticationMethod

- (NSString*) tokenEndpointAuthenticationMethod

readnonatomicassign

The client authentication method to use at the token endpoint.

Remarks

token_endpoint_auth_method

See also

http://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication

---

The documentation for this class was generated from the following file:

• Source/OIDRegistrationRequest.h