OIDEndSessionRequest Class Reference

Inheritance diagram for OIDEndSessionRequest:

Instance Methods
(instancetype)	- initWithConfiguration:idTokenHint:postLogoutRedirectURL:additionalParameters:
	Creates an authorization request with opinionated defaults (a secure state). More...
(instancetype)	- initWithConfiguration:idTokenHint:postLogoutRedirectURL:state:additionalParameters:
	Designated initializer. More...
(NSURL *)	- endSessionRequestURL
	Constructs the request URI by adding the request parameters to the query component of the authorization endpoint URI using the "application/x-www-form-urlencoded" format. More...

Properties
< NSCopying, NSSecureCoding, OIDExternalUserAgentRequest > OIDServiceConfiguration *	configuration
	The service's configuration. More...
NSURL *	postLogoutRedirectURL
	The client's redirect URI. More...
NSString *	idTokenHint
	Previously issued ID Token passed to the end session endpoint as a hint about the End-User's current authenticated session with the Client. More...
NSString *	state
	An opaque value used by the client to maintain state between the request and callback. More...
NSDictionary< NSString *, NSString * > *	additionalParameters
	The client's additional authorization parameters. More...

Method Documentation

endSessionRequestURL()

- (NSURL *) endSessionRequestURL

Constructs the request URI by adding the request parameters to the query component of the authorization endpoint URI using the "application/x-www-form-urlencoded" format.

Returns

A URL representing the authorization request.

See also

http://openid.net/specs/openid-connect-session-1_0.html#RPLogout

initWithConfiguration:idTokenHint:postLogoutRedirectURL:additionalParameters:()

- (instancetype) initWithConfiguration:		(OIDServiceConfiguration *)	configuration
idTokenHint:		(NSString *)	idTokenHint
postLogoutRedirectURL:		(NSURL *)	postLogoutRedirectURL
additionalParameters:		(nullable NSDictionary< NSString *, NSString * > *)	additionalParameters

Creates an authorization request with opinionated defaults (a secure state).

Parameters

configuration	The service's configuration.
idTokenHint	The previously issued ID Token
postLogoutRedirectURL	The client's post-logout redirect URI. callback.
additionalParameters	The client's additional authorization parameters.

initWithConfiguration:idTokenHint:postLogoutRedirectURL:state:additionalParameters:()

- (instancetype) initWithConfiguration:		(OIDServiceConfiguration *)	configuration
idTokenHint:		(NSString *)	idTokenHint
postLogoutRedirectURL:		(NSURL *)	postLogoutRedirectURL
state:		(NSString *)	state
additionalParameters:		(nullable NSDictionary< NSString *, NSString * > *)	NS_DESIGNATED_INITIALIZER

Designated initializer.

Parameters

configuration	The service's configuration.
idTokenHint	The previously issued ID Token
postLogoutRedirectURL	The client's post-logout redirect URI.
state	An opaque value used by the client to maintain state between the request and callback.
additionalParameters	The client's additional authorization parameters.

Property Documentation

additionalParameters

- (NSDictionary<NSString *, NSString *>*) additionalParameters

readnonatomicassign

The client's additional authorization parameters.

See also

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

configuration

- (<NSCopying, NSSecureCoding, OIDExternalUserAgentRequest> 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.

idTokenHint

- (NSString*) idTokenHint

readnonatomicassign

Previously issued ID Token passed to the end session endpoint as a hint about the End-User's current authenticated session with the Client.

Remarks

id_token_hint

See also

http://openid.net/specs/openid-connect-session-1_0.html#RPLogout

postLogoutRedirectURL

- (NSURL*) postLogoutRedirectURL

readnonatomicassign

The client's redirect URI.

Remarks

post_logout_redirect_uri

See also

http://openid.net/specs/openid-connect-session-1_0.html#RPLogout

state

- (NSString*) state

readnonatomicassign

An opaque value used by the client to maintain state between the request and callback.

Remarks

state @discussion If this value is not explicitly set, this library will automatically add state and perform appropriate validation of the state in the authorization response. It is recommended that the default implementation of this parameter be used wherever possible. Typically used to prevent CSRF attacks, as recommended in RFC6819 Section 5.3.5.

See also

http://openid.net/specs/openid-connect-session-1_0.html#RPLogout

---

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

• Source/OIDEndSessionRequest.h