AppAuth
OIDRegistrationRequest.h
Go to the documentation of this file.
1 
19 #import <Foundation/Foundation.h>
20 
23 
24 NS_ASSUME_NONNULL_BEGIN
25 
29 @interface OIDRegistrationRequest : NSObject <NSCopying, NSSecureCoding>
30 
35 @property(nonatomic, readonly) OIDServiceConfiguration *configuration;
36 
45 @property(nonatomic, readonly) NSString *initialAccessToken;
46 
51 @property(nonatomic, readonly) NSString *applicationType;
52 
57 @property(nonatomic, readonly) NSArray<NSURL *> *redirectURIs;
58 
63 @property(nonatomic, readonly, nullable) NSArray<NSString *> *responseTypes;
64 
69 @property(nonatomic, readonly, nullable) NSArray<NSString *> *grantTypes;
70 
75 @property(nonatomic, readonly, nullable) NSString *subjectType;
76 
81 @property(nonatomic, readonly, nullable) NSString *tokenEndpointAuthenticationMethod;
82 
85 @property(nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *additionalParameters;
86 
90 - (instancetype)init NS_UNAVAILABLE;
91 
103 - (instancetype)initWithConfiguration:(OIDServiceConfiguration *)configuration
104  redirectURIs:(NSArray<NSURL *> *)redirectURIs
105  responseTypes:(nullable NSArray<NSString *> *)responseTypes
106  grantTypes:(nullable NSArray<NSString *> *)grantTypes
107  subjectType:(nullable NSString *)subjectType
108  tokenEndpointAuthMethod:(nullable NSString *)tokenEndpointAuthMethod
109  additionalParameters:(nullable NSDictionary<NSString *, NSString *> *)additionalParameters;
110 
124 - (instancetype)initWithConfiguration:(OIDServiceConfiguration *)configuration
125  redirectURIs:(NSArray<NSURL *> *)redirectURIs
126  responseTypes:(nullable NSArray<NSString *> *)responseTypes
127  grantTypes:(nullable NSArray<NSString *> *)grantTypes
128  subjectType:(nullable NSString *)subjectType
129  tokenEndpointAuthMethod:(nullable NSString *)tokenEndpointAuthMethod
130  initialAccessToken:(nullable NSString *)initialAccessToken
131  additionalParameters:(nullable NSDictionary<NSString *, NSString *> *)additionalParameters
132  NS_DESIGNATED_INITIALIZER;
133 
137 - (NSURLRequest *)URLRequest;
138 
139 @end
140 
141 NS_ASSUME_NONNULL_END
OIDRegistrationRequest::responseTypes
NSArray< NSString * > * responseTypes
The response types to register for usage by this client.
Definition: OIDRegistrationRequest.h:63
OIDServiceConfiguration
Represents the information needed to construct a OIDAuthorizationService.
Definition: OIDServiceConfiguration.h:35
OIDAuthorizationResponse
Represents the response to an authorization request.
Definition: OIDAuthorizationResponse.h:31
OIDRegistrationRequest
Represents a registration request.
Definition: OIDRegistrationRequest.h:29
OIDRegistrationRequest::applicationType
NSString * applicationType
The application type to register, will always be 'native'.
Definition: OIDRegistrationRequest.h:51
OIDRegistrationRequest::grantTypes
NSArray< NSString * > * grantTypes
The grant types to register for usage by this client.
Definition: OIDRegistrationRequest.h:69
OIDRegistrationRequest::configuration
OIDServiceConfiguration * configuration
The service's configuration.
Definition: OIDRegistrationRequest.h:35
OIDRegistrationRequest::tokenEndpointAuthenticationMethod
NSString * tokenEndpointAuthenticationMethod
The client authentication method to use at the token endpoint.
Definition: OIDRegistrationRequest.h:81
OIDRegistrationRequest::redirectURIs
NSArray< NSURL * > * redirectURIs
The client's redirect URI's.
Definition: OIDRegistrationRequest.h:57
OIDRegistrationRequest::additionalParameters
NSDictionary< NSString *, NSString * > * additionalParameters
The client's additional token request parameters.
Definition: OIDRegistrationRequest.h:85
OIDRegistrationRequest::initialAccessToken
NSString * initialAccessToken
The initial access token to access the Client Registration Endpoint (if required by the OpenID Provid...
Definition: OIDRegistrationRequest.h:45
OIDRegistrationRequest::subjectType
NSString * subjectType
The subject type to to request.
Definition: OIDRegistrationRequest.h:75
-[OIDRegistrationRequest URLRequest]
NSURLRequest * URLRequest()
Constructs an NSURLRequest representing the registration request.