NetIQ Mobile SDK for iOS  2.0
Access Manager iOS Framework for OAuth & OIDC
OIDTokenResponse Class Reference

Represents the response to an token request. More...

#import <OIDTokenResponse.h>

Inherits NSObject, <NSCopying>, and <NSSecureCoding>.

Instance Methods

(instancetype) - NS_UNAVAILABLE
 
(instancetype) - initWithRequest:parameters:
 Designated initializer. More...
 

Properties

OIDTokenRequestrequest
 The request which was serviced.
 
NSString * accessToken
 The access token generated by the authorization server. Set when the response_type requested includes 'token'. More...
 
NSDate * accessTokenExpirationDate
 The approximate expiration date & time of the access token. More...
 
NSString * tokenType
 Typically "Bearer" when present. Otherwise, another token_type value that the Client has negotiated with the Authorization Server. Set when the response_type requested includes 'token'. More...
 
NSString * idToken
 ID Token value associated with the authenticated session. Set when the response_type requested includes 'id_token'. More...
 
NSString * refreshToken
 The refresh token, which can be used to obtain new access tokens using the same authorization grant. More...
 
NSString * scope
 The scope of the access token. OPTIONAL, if identical to the scopes requested, otherwise, REQUIRED. More...
 
NSDictionary< NSString *, NSObject< NSCopying > * > * additionalParameters
 Additional parameters returned from the token server.
 

Detailed Description

Method Documentation

◆ initWithRequest:parameters:()

- (instancetype) initWithRequest: (OIDTokenRequest *)  request
parameters: (NSDictionary< NSString *, NSObject< NSCopying > * > *)  NS_DESIGNATED_INITIALIZER 

Designated initializer.

Parameters
requestThe serviced request.
parametersThe decoded parameters returned from the Authorization Server.
Remarks
Known parameters are extracted from the parameters parameter and the normative properties are populated. Non-normative parameters are placed in the additionalParameters dictionary.

Property Documentation

◆ accessToken

- (NSString*) accessToken
readnonatomicassign

The access token generated by the authorization server. Set when the response_type requested includes 'token'.

Remarks
access_token
See also
http://openid.net/specs/openid-connect-core-1_0.html#ImplicitAuthResponse

◆ accessTokenExpirationDate

- (NSDate*) accessTokenExpirationDate
readnonatomicassign

The approximate expiration date & time of the access token.

Remarks
expires_in OIDTokenResponse.accessToken
See also
http://openid.net/specs/openid-connect-core-1_0.html#ImplicitAuthResponse

◆ idToken

- (NSString*) idToken
readnonatomicassign

ID Token value associated with the authenticated session. Set when the response_type requested includes 'id_token'.

Remarks
id_token
See also
http://openid.net/specs/openid-connect-core-1_0.html#IDToken
http://openid.net/specs/openid-connect-core-1_0.html#ImplicitAuthResponse

◆ refreshToken

- (NSString*) refreshToken
readnonatomicassign

The refresh token, which can be used to obtain new access tokens using the same authorization grant.

Remarks
refresh_token
See also
https://tools.ietf.org/html/rfc6749#section-5.1

◆ scope

- (NSString*) scope
readnonatomicassign

The scope of the access token. OPTIONAL, if identical to the scopes requested, otherwise, REQUIRED.

Remarks
scope
See also
https://tools.ietf.org/html/rfc6749#section-5.1

◆ tokenType

- (NSString*) tokenType
readnonatomicassign

Typically "Bearer" when present. Otherwise, another token_type value that the Client has negotiated with the Authorization Server. Set when the response_type requested includes 'token'.

Remarks
token_type
See also
http://openid.net/specs/openid-connect-core-1_0.html#ImplicitAuthResponse

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