AppAuth
OIDEndSessionRequest.h
Go to the documentation of this file.
1 
19 #import <Foundation/Foundation.h>
20 
21 #import "OIDExternalUserAgentRequest.h"
22 
24 
25 NS_ASSUME_NONNULL_BEGIN
26 
27 @interface OIDEndSessionRequest : NSObject
28  <NSCopying, NSSecureCoding, OIDExternalUserAgentRequest>
29 
34 @property(nonatomic, readonly) OIDServiceConfiguration *configuration;
35 
40 @property(nonatomic, readonly, nullable) NSURL *postLogoutRedirectURL;
41 
47 @property(nonatomic, readonly, nullable) NSString *idTokenHint;
48 
57 @property(nonatomic, readonly, nullable) NSString *state;
58 
62 @property(nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *additionalParameters;
63 
67 - (instancetype)init NS_UNAVAILABLE;
68 
76 - (instancetype)
77  initWithConfiguration:(OIDServiceConfiguration *)configuration
78  idTokenHint:(NSString *)idTokenHint
79  postLogoutRedirectURL:(NSURL *)postLogoutRedirectURL
80  additionalParameters:(nullable NSDictionary<NSString *, NSString *> *)additionalParameters;
81 
90 - (instancetype)
91  initWithConfiguration:(OIDServiceConfiguration *)configuration
92  idTokenHint:(NSString *)idTokenHint
93  postLogoutRedirectURL:(NSURL *)postLogoutRedirectURL
94  state:(NSString *)state
95  additionalParameters:(nullable NSDictionary<NSString *, NSString *> *)additionalParameters
96  NS_DESIGNATED_INITIALIZER;
97 
103 - (NSURL *)endSessionRequestURL;
104 
105 @end
106 
107 NS_ASSUME_NONNULL_END
OIDServiceConfiguration
Represents the information needed to construct a OIDAuthorizationService.
Definition: OIDServiceConfiguration.h:35
OIDEndSessionRequest::idTokenHint
NSString * idTokenHint
Previously issued ID Token passed to the end session endpoint as a hint about the End-User's current ...
Definition: OIDEndSessionRequest.h:47
OIDEndSessionRequest::additionalParameters
NSDictionary< NSString *, NSString * > * additionalParameters
The client's additional authorization parameters.
Definition: OIDEndSessionRequest.h:62
OIDEndSessionRequest::postLogoutRedirectURL
NSURL * postLogoutRedirectURL
The client's redirect URI.
Definition: OIDEndSessionRequest.h:40
OIDEndSessionRequest
Definition: OIDEndSessionRequest.h:27
OIDEndSessionRequest::configuration
< NSCopying, NSSecureCoding, OIDExternalUserAgentRequest > OIDServiceConfiguration * configuration
The service's configuration.
Definition: OIDEndSessionRequest.h:34
OIDExternalUserAgentRequest-p
Definition: OIDExternalUserAgentRequest.h:23
OIDEndSessionRequest::state
NSString * state
An opaque value used by the client to maintain state between the request and callback.
Definition: OIDEndSessionRequest.h:57
-[OIDEndSessionRequest endSessionRequestURL]
NSURL * endSessionRequestURL()
Constructs the request URI by adding the request parameters to the query component of the authorizati...