AppAuth: OIDAuthorizationResponse Class Reference (original) (raw)
Represents the response to an authorization request. More...
#import <[OIDAuthorizationResponse.h](%5Fo%5Fi%5Fd%5Fauthorization%5Fresponse%5F8h%5Fsource.html)>
| Instance Methods | |
|---|---|
| (instancetype) | - initWithRequest:parameters: |
| Designated initializer. More... | |
| (nullable OIDTokenRequest *) | - tokenExchangeRequest |
| Creates a token request suitable for exchanging an authorization code for an access token. More... | |
| (nullable OIDTokenRequest *) | - tokenExchangeRequestWithAdditionalParameters: |
| Creates a token request suitable for exchanging an authorization code for an access token. More... | |
| Properties | |
|---|---|
| OIDAuthorizationRequest * | request |
| The request which was serviced. | |
| NSString * | authorizationCode |
| The authorization code generated by the authorization server. @discussion Set when the response_type requested includes 'code'. More... | |
| NSString * | state |
| REQUIRED if the "state" parameter was present in the client authorization request. The exact value received from the client. More... | |
| NSString * | accessToken |
| The access token generated by the authorization server. @discussion Set when the response_type requested includes 'token'. More... | |
| NSDate * | accessTokenExpirationDate |
| The approximate expiration date & time of the access token. @discussion Set when the response_type requested includes 'token'. More... | |
| NSString * | tokenType |
| Typically "Bearer" when present. Otherwise, another token_type value that the Client has negotiated with the Authorization Server. @discussion Set when the response_type requested includes 'token'. More... | |
| NSString * | idToken |
| ID Token value associated with the authenticated session. @discussion Set when the response_type requested includes 'id_token'. 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 authorization server. | |
◆ initWithRequest:parameters:()
| - (instancetype) initWithRequest: | (OIDAuthorizationRequest *) | request |
|---|---|---|
| parameters: | (NSDictionary< NSString *, NSObject< NSCopying > * > *) | NS_DESIGNATED_INITIALIZER |
Designated initializer.
Parameters
| request | The serviced request. |
|---|---|
| parameters | The decoded parameters returned from the Authorization Server. |
◆ tokenExchangeRequest()
◆ tokenExchangeRequestWithAdditionalParameters:()
| - (nullable OIDTokenRequest *) tokenExchangeRequestWithAdditionalParameters: | (nullable NSDictionary< NSString *, NSString * > *) | additionalParameters |
|---|
◆ accessToken
| - (NSString*) accessToken | readnonatomicassign |
|---|
◆ accessTokenExpirationDate
| - (NSDate*) accessTokenExpirationDate | readnonatomicassign |
|---|
◆ authorizationCode
| - (NSString*) authorizationCode | readnonatomicassign |
|---|
The authorization code generated by the authorization server. @discussion Set when the response_type requested includes 'code'.
◆ idToken
◆ scope
◆ state
REQUIRED if the "state" parameter was present in the client authorization request. The exact value received from the client.
◆ tokenType
The documentation for this class was generated from the following file:
- Source/OIDAuthorizationResponse.h