AppAuth
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 
48 @property(nonatomic, readonly, nullable) NSDate *accessTokenExpirationDate;
49 
56 @property(nonatomic, readonly, nullable) NSString *tokenType;
57 
71 @property(nonatomic, readonly, nullable) NSString *idToken;
72 
78 @property(nonatomic, readonly, nullable) NSString *refreshToken;
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:(OIDTokenRequest *)request
105  parameters:(NSDictionary<NSString *, NSObject<NSCopying> *> *)parameters
106  NS_DESIGNATED_INITIALIZER;
107 
108 @end
109 
110 NS_ASSUME_NONNULL_END
OIDTokenResponse::scope
NSString * scope
The scope of the access token. OPTIONAL, if identical to the scopes requested, otherwise,...
Definition: OIDTokenResponse.h:85
OIDTokenResponse::accessTokenExpirationDate
NSDate * accessTokenExpirationDate
The approximate expiration date & time of the access token.
Definition: OIDTokenResponse.h:48
OIDTokenResponse::refreshToken
NSString * refreshToken
The refresh token, which can be used to obtain new access tokens using the same authorization grant.
Definition: OIDTokenResponse.h:78
OIDTokenResponse::idToken
NSString * idToken
ID Token value associated with the authenticated session. Always present for the authorization code g...
Definition: OIDTokenResponse.h:71
OIDTokenResponse::accessToken
NSString * accessToken
The access token generated by the authorization server.
Definition: OIDTokenResponse.h:40
OIDTokenResponse::tokenType
NSString * tokenType
Typically "Bearer" when present. Otherwise, another token_type value that the Client has negotiated w...
Definition: OIDTokenResponse.h:56
OIDTokenRequest
Represents a token request.
Definition: OIDTokenRequest.h:34
OIDTokenResponse::request
OIDTokenRequest * request
The request which was serviced.
Definition: OIDTokenResponse.h:33
OIDTokenResponse::additionalParameters
NSDictionary< NSString *, NSObject< NSCopying > * > * additionalParameters
Additional parameters returned from the token server.
Definition: OIDTokenResponse.h:90
OIDTokenResponse
Represents the response to an token request.
Definition: OIDTokenResponse.h:29