NetIQ Mobile SDK for iOS  2.0
Access Manager iOS Framework for OAuth & OIDC
OIDAuthorizationResponse.h
Go to the documentation of this file.
1 
19 #import <Foundation/Foundation.h>
20 
22 @class OIDTokenRequest;
23 
24 NS_ASSUME_NONNULL_BEGIN
25 
31 @interface OIDAuthorizationResponse : NSObject <NSCopying, NSSecureCoding>
32 
35 @property(nonatomic, readonly) OIDAuthorizationRequest *request;
36 
41 @property(nonatomic, readonly, nullable) NSString *authorizationCode;
42 
47 @property(nonatomic, readonly, nullable) NSString *state;
48 
54 @property(nonatomic, readonly, nullable) NSString *accessToken;
55 
62 @property(nonatomic, readonly, nullable) NSDate *accessTokenExpirationDate;
63 
70 @property(nonatomic, readonly, nullable) NSString *tokenType;
71 
78 @property(nonatomic, readonly, nullable) NSString *idToken;
79 
85 @property(nonatomic, readonly, nullable) NSString *scope;
86 
89 @property(nonatomic, readonly, nullable)
90  NSDictionary<NSString *, NSObject<NSCopying> *> *additionalParameters;
91 
95 - (instancetype)init NS_UNAVAILABLE;
96 
104 - (instancetype)initWithRequest:(OIDAuthorizationRequest *)request
105  parameters:(NSDictionary<NSString *, NSObject<NSCopying> *> *)parameters
106  NS_DESIGNATED_INITIALIZER;
107 
115 
123 - (nullable OIDTokenRequest *)tokenExchangeRequestWithAdditionalParameters:
124  (nullable NSDictionary<NSString *, NSString *> *)additionalParameters;
125 
126 @end
127 
128 NS_ASSUME_NONNULL_END
NSString * scope
The scope of the access token. OPTIONAL, if identical to the scopes requested, otherwise, REQUIRED.
Definition: OIDAuthorizationResponse.h:85
NSDate * accessTokenExpirationDate
The approximate expiration date & time of the access token. Set when the response_type requested include...
Definition: OIDAuthorizationResponse.h:62
nullable OIDTokenRequest * tokenExchangeRequest()
Creates a token request suitable for exchanging an authorization code for an access token...
NSString * idToken
ID Token value associated with the authenticated session. Set when the response_type requested inclu...
Definition: OIDAuthorizationResponse.h:78
Represents the response to an authorization request.
Definition: OIDAuthorizationResponse.h:31
Represents an authorization request.
Definition: OIDAuthorizationRequest.h:40
OIDAuthorizationRequest * request
The request which was serviced.
Definition: OIDAuthorizationResponse.h:35
NSString * state
REQUIRED if the "state" parameter was present in the client authorization request. The exact value received from the client.
Definition: OIDAuthorizationResponse.h:47
Represents a token request.
Definition: OIDTokenRequest.h:34
NSDictionary< NSString *, NSObject< NSCopying > * > * additionalParameters
Additional parameters returned from the authorization server.
Definition: OIDAuthorizationResponse.h:90
NSString * tokenType
Typically "Bearer" when present. Otherwise, another token_type value that the Client has negotiated w...
Definition: OIDAuthorizationResponse.h:70
NSString * authorizationCode
The authorization code generated by the authorization server. Set when the response_type requested i...
Definition: OIDAuthorizationResponse.h:41
NSString * accessToken
The access token generated by the authorization server. Set when the response_type requested include...
Definition: OIDAuthorizationResponse.h:54