AppAuth
Instance Methods | Properties | List of all members
OIDRegistrationResponse Class Reference

Represents a registration response. More...

#import <OIDRegistrationResponse.h>

Inheritance diagram for OIDRegistrationResponse:

Instance Methods

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

Properties

OIDRegistrationRequestrequest
 The request which was serviced.
 
NSString * clientID
 The registered client identifier. More...
 
NSDate * clientIDIssuedAt
 Timestamp of when the client identifier was issued, if provided. More...
 
NSString * clientSecret
 TThe client secret, which is part of the client credentials, if provided. More...
 
NSDate * clientSecretExpiresAt
 Timestamp of when the client credentials expires, if provided. More...
 
NSString * registrationAccessToken
 Client registration access token that can be used for subsequent operations upon the client registration. More...
 
NSURL * registrationClientURI
 Location of the client configuration endpoint, if provided. More...
 
NSString * tokenEndpointAuthenticationMethod
 Client authentication method to use at the token endpoint, if provided. More...
 
NSDictionary< NSString *, NSObject< NSCopying > * > * additionalParameters
 Additional parameters returned from the token server.
 

Detailed Description

Represents a registration response.

See also
https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationResponse

Method Documentation

◆ initWithRequest:parameters:()

- (instancetype) initWithRequest: (OIDRegistrationRequest *)  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

◆ clientID

- (NSString*) clientID
readnonatomicassign

◆ clientIDIssuedAt

- (NSDate*) clientIDIssuedAt
readnonatomicassign

Timestamp of when the client identifier was issued, if provided.

Remarks
client_id_issued_at
See also
https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationResponse

◆ clientSecret

- (NSString*) clientSecret
readnonatomicassign

TThe client secret, which is part of the client credentials, if provided.

Remarks
client_secret
See also
https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationResponse

◆ clientSecretExpiresAt

- (NSDate*) clientSecretExpiresAt
readnonatomicassign

Timestamp of when the client credentials expires, if provided.

Remarks
client_secret_expires_at
See also
https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationResponse

◆ registrationAccessToken

- (NSString*) registrationAccessToken
readnonatomicassign

Client registration access token that can be used for subsequent operations upon the client registration.

Remarks
registration_access_token
See also
https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationResponse

◆ registrationClientURI

- (NSURL*) registrationClientURI
readnonatomicassign

Location of the client configuration endpoint, if provided.

Remarks
registration_client_uri
See also
https://openid.net/specs/openid-connect-registration-1_0.html#RegistrationResponse

◆ tokenEndpointAuthenticationMethod

- (NSString*) tokenEndpointAuthenticationMethod
readnonatomicassign

Client authentication method to use at the token endpoint, if provided.

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

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