AppAuth
OIDServiceConfiguration.h
Go to the documentation of this file.
1 
19 #import <Foundation/Foundation.h>
20 
22 @class OIDServiceDiscovery;
23 
24 NS_ASSUME_NONNULL_BEGIN
25 
29 typedef void (^OIDServiceConfigurationCreated)
30  (OIDServiceConfiguration *_Nullable serviceConfiguration,
31  NSError *_Nullable error);
32 
35 @interface OIDServiceConfiguration : NSObject <NSCopying, NSSecureCoding>
36 
39 @property(nonatomic, readonly) NSURL *authorizationEndpoint;
40 
43 @property(nonatomic, readonly) NSURL *tokenEndpoint;
44 
47 @property(nonatomic, readonly, nullable) NSURL *issuer;
48 
51 @property(nonatomic, readonly, nullable) NSURL *registrationEndpoint;
52 
55 @property(nonatomic, readonly, nullable) NSURL *endSessionEndpoint;
56 
59 @property(nonatomic, readonly, nullable) OIDServiceDiscovery *discoveryDocument;
60 
65 - (instancetype)init NS_UNAVAILABLE;
66 
70 - (instancetype)initWithAuthorizationEndpoint:(NSURL *)authorizationEndpoint
71  tokenEndpoint:(NSURL *)tokenEndpoint;
72 
77 - (instancetype)initWithAuthorizationEndpoint:(NSURL *)authorizationEndpoint
78  tokenEndpoint:(NSURL *)tokenEndpoint
79  registrationEndpoint:(nullable NSURL *)registrationEndpoint;
80 
85 - (instancetype)initWithAuthorizationEndpoint:(NSURL *)authorizationEndpoint
86  tokenEndpoint:(NSURL *)tokenEndpoint
87  issuer:(nullable NSURL *)issuer;
88 
94 - (instancetype)initWithAuthorizationEndpoint:(NSURL *)authorizationEndpoint
95  tokenEndpoint:(NSURL *)tokenEndpoint
96  issuer:(nullable NSURL *)issuer
97  registrationEndpoint:(nullable NSURL *)registrationEndpoint;
98 
105 - (instancetype)initWithAuthorizationEndpoint:(NSURL *)authorizationEndpoint
106  tokenEndpoint:(NSURL *)tokenEndpoint
107  issuer:(nullable NSURL *)issuer
108  registrationEndpoint:(nullable NSURL *)registrationEndpoint
109  endSessionEndpoint:(nullable NSURL *)endSessionEndpoint;
110 
114 - (instancetype)initWithDiscoveryDocument:(OIDServiceDiscovery *)discoveryDocument;
115 
116 @end
117 
118 NS_ASSUME_NONNULL_END
OIDServiceConfiguration
Represents the information needed to construct a OIDAuthorizationService.
Definition: OIDServiceConfiguration.h:35
OIDServiceConfiguration::endSessionEndpoint
NSURL * endSessionEndpoint
The end session logout endpoint URI.
Definition: OIDServiceConfiguration.h:55
OIDServiceConfiguration::registrationEndpoint
NSURL * registrationEndpoint
The dynamic client registration endpoint URI.
Definition: OIDServiceConfiguration.h:51
OIDServiceConfiguration::issuer
NSURL * issuer
The OpenID Connect issuer.
Definition: OIDServiceConfiguration.h:47
OIDServiceConfiguration::discoveryDocument
OIDServiceDiscovery * discoveryDocument
The discovery document.
Definition: OIDServiceConfiguration.h:59
OIDServiceConfiguration::tokenEndpoint
NSURL * tokenEndpoint
The token exchange and refresh endpoint URI.
Definition: OIDServiceConfiguration.h:43
OIDServiceConfigurationCreated
void(^ OIDServiceConfigurationCreated)(OIDServiceConfiguration *_Nullable serviceConfiguration, NSError *_Nullable error)
The type of block called when a OIDServiceConfiguration has been created by loading a OIDServiceDisco...
Definition: OIDServiceConfiguration.h:30
OIDServiceConfiguration::authorizationEndpoint
NSURL * authorizationEndpoint
The authorization endpoint URI.
Definition: OIDServiceConfiguration.h:39
OIDServiceDiscovery
Represents an OpenID Connect 1.0 Discovery Document.
Definition: OIDServiceDiscovery.h:26