NetIQ Mobile SDK for iOS  2.0
Access Manager iOS Framework for OAuth & OIDC
OIDRegistrationRequest Class Reference

Represents a registration request. More...

#import <OIDRegistrationRequest.h>

Inherits NSObject, <NSCopying>, and <NSSecureCoding>.

Instance Methods

(instancetype) - NS_UNAVAILABLE
 
(instancetype) - initWithConfiguration:redirectURIs:responseTypes:grantTypes:subjectType:tokenEndpointAuthMethod:additionalParameters:
 Designated initializer. More...
 
(NSURLRequest *) - URLRequest
 Constructs an NSURLRequest representing the registration request. More...
 

Properties

OIDServiceConfigurationconfiguration
 The service's configuration. More...
 
NSString * applicationType
 The application type to register, will always be 'native'. More...
 
NSArray< NSURL * > * redirectURIs
 The client's redirect URI's. More...
 
NSArray< NSString * > * responseTypes
 The response types to register for usage by this client. More...
 
NSArray< NSString * > * grantTypes
 The grant types to register for usage by this client. More...
 
NSString * subjectType
 The subject type to to request. More...
 
NSString * tokenEndpointAuthenticationMethod
 The client authentication method to use at the token endpoint. More...
 
NSDictionary< NSString *, NSString * > * additionalParameters
 The client's additional token request parameters.
 

Detailed Description

Method Documentation

◆ initWithConfiguration:redirectURIs:responseTypes:grantTypes:subjectType:tokenEndpointAuthMethod:additionalParameters:()

- (instancetype) initWithConfiguration: (OIDServiceConfiguration *)  configuration
redirectURIs: (NSArray< NSURL * > *)  redirectURIs
responseTypes: (nullable NSArray< NSString * > *)  responseTypes
grantTypes: (nullable NSArray< NSString * > *)  grantTypes
subjectType: (nullable NSString *)  subjectType
tokenEndpointAuthMethod: (nullable NSString *)  tokenEndpointAuthMethod
additionalParameters: (nullable NSDictionary< NSString *, NSString * > *)  NS_DESIGNATED_INITIALIZER 

Designated initializer.

Parameters
configurationThe service's configuration.
redirectURIsThe redirect URIs to register for the client.
responseTypesThe response types to register for the client.
grantTypesThe grant types to register for the client.
subjectTypeThe subject type to register for the client.
tokenEndpointAuthMethodThe token endpoint authentication method to register for the client.
additionalParametersThe client's additional registration request parameters.

◆ URLRequest()

- (NSURLRequest *) URLRequest

Constructs an NSURLRequest representing the registration request.

Returns
An NSURLRequest representing the registration request.

Property Documentation

◆ applicationType

- (NSString*) applicationType
readnonatomicassign

The application type to register, will always be 'native'.

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

◆ configuration

- (OIDServiceConfiguration*) configuration
readnonatomicassign

The service's configuration.

Remarks
This configuration specifies how to connect to a particular OAuth provider. Configurations may be created manually, or via an OpenID Connect Discovery Document.

◆ grantTypes

- (NSArray<NSString *>*) grantTypes
readnonatomicassign

The grant types to register for usage by this client.

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

◆ redirectURIs

- (NSArray<NSURL *>*) redirectURIs
readnonatomicassign

The client's redirect URI's.

Remarks
redirect_uris
See also
https://tools.ietf.org/html/rfc6749#section-3.1.2

◆ responseTypes

- (NSArray<NSString *>*) responseTypes
readnonatomicassign

The response types to register for usage by this client.

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

◆ subjectType

- (NSString*) subjectType
readnonatomicassign

The subject type to to request.

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

◆ tokenEndpointAuthenticationMethod

- (NSString*) tokenEndpointAuthenticationMethod
readnonatomicassign

The client authentication method to use at the token endpoint.

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: