NetIQ Mobile SDK for iOS  2.0
Access Manager iOS Framework for OAuth & OIDC
OIDTokenResponse.h
Go to the documentation of this file.
1 
19 #import <Foundation/Foundation.h>
20 
21 @class OIDTokenRequest;
22 
23 NS_ASSUME_NONNULL_BEGIN
24 
29 @interface OIDTokenResponse : NSObject <NSCopying, NSSecureCoding>
30 
33 @property(nonatomic, readonly) OIDTokenRequest *request;
34 
40 @property(nonatomic, readonly, nullable) NSString *accessToken;
41 
47 @property(nonatomic, readonly, nullable) NSDate *accessTokenExpirationDate;
48 
55 @property(nonatomic, readonly, nullable) NSString *tokenType;
56 
63 @property(nonatomic, readonly, nullable) NSString *idToken;
64 
70 @property(nonatomic, readonly, nullable) NSString *refreshToken;
71 
77 @property(nonatomic, readonly, nullable) NSString *scope;
78 
81 @property(nonatomic, readonly, nullable)
82  NSDictionary<NSString *, NSObject<NSCopying> *> *additionalParameters;
83 
87 - (instancetype)init NS_UNAVAILABLE;
88 
96 - (instancetype)initWithRequest:(OIDTokenRequest *)request
97  parameters:(NSDictionary<NSString *, NSObject<NSCopying> *> *)parameters
98  NS_DESIGNATED_INITIALIZER;
99 
100 @end
101 
102 NS_ASSUME_NONNULL_END
NSString * refreshToken
The refresh token, which can be used to obtain new access tokens using the same authorization grant...
Definition: OIDTokenResponse.h:70
OIDTokenRequest * request
The request which was serviced.
Definition: OIDTokenResponse.h:33
NSDictionary< NSString *, NSObject< NSCopying > * > * additionalParameters
Additional parameters returned from the token server.
Definition: OIDTokenResponse.h:82
NSDate * accessTokenExpirationDate
The approximate expiration date & time of the access token.
Definition: OIDTokenResponse.h:47
NSString * idToken
ID Token value associated with the authenticated session. Set when the response_type requested inclu...
Definition: OIDTokenResponse.h:63
NSString * accessToken
The access token generated by the authorization server. Set when the response_type requested include...
Definition: OIDTokenResponse.h:40
NSString * tokenType
Typically "Bearer" when present. Otherwise, another token_type value that the Client has negotiated w...
Definition: OIDTokenResponse.h:55
Represents a token request.
Definition: OIDTokenRequest.h:34
Represents the response to an token request.
Definition: OIDTokenResponse.h:29
NSString * scope
The scope of the access token. OPTIONAL, if identical to the scopes requested, otherwise, REQUIRED.
Definition: OIDTokenResponse.h:77