AppAuth
OIDRegistrationResponse.h
Go to the documentation of this file.
1 
20 #import <Foundation/Foundation.h>
21 
23 
24 NS_ASSUME_NONNULL_BEGIN
25 
28 extern NSString *const OIDClientIDParam;
29 
32 extern NSString *const OIDClientIDIssuedAtParam;
33 
36 extern NSString *const OIDClientSecretParam;
37 
40 extern NSString *const OIDClientSecretExpirestAtParam;
41 
44 extern NSString *const OIDRegistrationAccessTokenParam;
45 
48 extern NSString *const OIDRegistrationClientURIParam;
49 
53 @interface OIDRegistrationResponse : NSObject <NSCopying, NSSecureCoding>
54 
57 @property(nonatomic, readonly) OIDRegistrationRequest *request;
58 
64 @property(nonatomic, readonly) NSString *clientID;
65 
70 @property(nonatomic, readonly, nullable) NSDate *clientIDIssuedAt;
71 
76 @property(nonatomic, readonly, nullable) NSString *clientSecret;
77 
82 @property(nonatomic, readonly, nullable) NSDate *clientSecretExpiresAt;
83 
89 @property(nonatomic, readonly, nullable) NSString *registrationAccessToken;
90 
95 @property(nonatomic, readonly, nullable) NSURL *registrationClientURI;
96 
101 @property(nonatomic, readonly, nullable) NSString *tokenEndpointAuthenticationMethod;
102 
105 @property(nonatomic, readonly, nullable) NSDictionary<NSString *, NSObject <NSCopying> *>
107 
111 - (instancetype)init NS_UNAVAILABLE;
112 
120 - (instancetype)initWithRequest:(OIDRegistrationRequest *)request
121  parameters:(NSDictionary<NSString *, NSObject <NSCopying> *> *)parameters
122  NS_DESIGNATED_INITIALIZER;
123 
124 @end
125 
126 NS_ASSUME_NONNULL_END
OIDRegistrationResponse::tokenEndpointAuthenticationMethod
NSString * tokenEndpointAuthenticationMethod
Client authentication method to use at the token endpoint, if provided.
Definition: OIDRegistrationResponse.h:101
OIDRegistrationResponse::clientSecretExpiresAt
NSDate * clientSecretExpiresAt
Timestamp of when the client credentials expires, if provided.
Definition: OIDRegistrationResponse.h:82
OIDRegistrationResponse::clientID
NSString * clientID
The registered client identifier.
Definition: OIDRegistrationResponse.h:64
OIDRegistrationRequest
Represents a registration request.
Definition: OIDRegistrationRequest.h:29
OIDRegistrationResponse::registrationClientURI
NSURL * registrationClientURI
Location of the client configuration endpoint, if provided.
Definition: OIDRegistrationResponse.h:95
OIDRegistrationAccessTokenParam
NSString *const OIDRegistrationAccessTokenParam
Parameter name for the registration access token.
OIDRegistrationResponse::additionalParameters
NSDictionary< NSString *, NSObject< NSCopying > * > * additionalParameters
Additional parameters returned from the token server.
Definition: OIDRegistrationResponse.h:106
OIDRegistrationResponse::registrationAccessToken
NSString * registrationAccessToken
Client registration access token that can be used for subsequent operations upon the client registrat...
Definition: OIDRegistrationResponse.h:89
OIDClientIDIssuedAtParam
NSString *const OIDClientIDIssuedAtParam
Parameter name for the client id issuance timestamp.
OIDRegistrationResponse
Represents a registration response.
Definition: OIDRegistrationResponse.h:53
OIDClientSecretParam
NSString *const OIDClientSecretParam
Parameter name for the client secret.
OIDRegistrationResponse::clientIDIssuedAt
NSDate * clientIDIssuedAt
Timestamp of when the client identifier was issued, if provided.
Definition: OIDRegistrationResponse.h:70
OIDRegistrationResponse::request
OIDRegistrationRequest * request
The request which was serviced.
Definition: OIDRegistrationResponse.h:57
OIDClientIDParam
NSString *const OIDClientIDParam
Parameter name for the client id.
OIDClientSecretExpirestAtParam
NSString *const OIDClientSecretExpirestAtParam
Parameter name for the client secret expiration time.
OIDRegistrationClientURIParam
NSString *const OIDRegistrationClientURIParam
Parameter name for the client configuration URI.
OIDRegistrationResponse::clientSecret
NSString * clientSecret
TThe client secret, which is part of the client credentials, if provided.
Definition: OIDRegistrationResponse.h:76