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

Performs various OAuth and OpenID Connect related calls via the user agent or . More...

#import <OIDAuthorizationService.h>

Inherits NSObject.

Instance Methods

(instancetype) - NS_UNAVAILABLE
 

Class Methods

(void) + discoverServiceConfigurationForIssuer:completion:
 Convenience method for creating an authorization service configuration from an OpenID Connect compliant issuer URL. More...
 
(void) + discoverServiceConfigurationForDiscoveryURL:completion:
 Convenience method for creating an authorization service configuration from an OpenID Connect compliant identity provider's discovery document. More...
 
(id< OIDAuthorizationFlowSession >) + presentAuthorizationRequest:UICoordinator:callback:
 Perform an authorization flow using a generic flow shim. More...
 
(void) + performTokenRequest:callback:
 Performs a token request. More...
 
(void) + performRegistrationRequest:completion:
 Performs a registration request. More...
 
(id< OIDAuthorizationFlowSession >) + presentAuthorizationRequest:presentingViewController:callback:
 Perform an authorization flow using . More...
 

Properties

OIDServiceConfigurationconfiguration
 The service's configuration. More...
 

Detailed Description

Performs various OAuth and OpenID Connect related calls via the user agent or .

Method Documentation

◆ discoverServiceConfigurationForDiscoveryURL:completion:()

+ (void) discoverServiceConfigurationForDiscoveryURL: (NSURL *)  discoveryURL
completion: (OIDDiscoveryCallback completion 

Convenience method for creating an authorization service configuration from an OpenID Connect compliant identity provider's discovery document.

Parameters
discoveryURLThe URL of the service provider's OpenID Connect discovery document.
completionA block which will be invoked when the authorization service configuration has been created, or when an error has occurred.
See also
https://openid.net/specs/openid-connect-discovery-1_0.html

◆ discoverServiceConfigurationForIssuer:completion:()

+ (void) discoverServiceConfigurationForIssuer: (NSURL *)  issuerURL
completion: (OIDDiscoveryCallback completion 

Convenience method for creating an authorization service configuration from an OpenID Connect compliant issuer URL.

Parameters
issuerURLThe service provider's OpenID Connect issuer.
completionA block which will be invoked when the authorization service configuration has been created, or when an error has occurred.
See also
https://openid.net/specs/openid-connect-discovery-1_0.html

◆ performRegistrationRequest:completion:()

+ (void) performRegistrationRequest: (OIDRegistrationRequest *)  request
completion: (OIDRegistrationCompletion completion 

Performs a registration request.

Parameters
requestThe registration request.
completionThe method called when the request has completed or failed.

◆ performTokenRequest:callback:()

+ (void) performTokenRequest: (OIDTokenRequest *)  request
callback: (OIDTokenCallback callback 

Performs a token request.

Parameters
requestThe token request.
callbackThe method called when the request has completed or failed.

◆ presentAuthorizationRequest:presentingViewController:callback:()

+ (id<OIDAuthorizationFlowSession>) presentAuthorizationRequest: (OIDAuthorizationRequest *)  request
presentingViewController: (UIViewController *)  presentingViewController
callback: (OIDAuthorizationCallback callback 

Perform an authorization flow using .

Parameters
requestThe authorization request.
presentingViewControllerThe view controller from which to present the .
callbackThe method called when the request has completed or failed.
Returns
A OIDAuthorizationFlowSession instance which will terminate when it receives a OIDAuthorizationFlowSession.cancel message, or after processing a OIDAuthorizationFlowSession.resumeAuthorizationFlowWithURL: message.

Provided by category OIDAuthorizationService(IOS).

◆ presentAuthorizationRequest:UICoordinator:callback:()

+ (id<OIDAuthorizationFlowSession>) presentAuthorizationRequest: (OIDAuthorizationRequest *)  request
UICoordinator: (id< OIDAuthorizationUICoordinator >)  UICoordinator
callback: (OIDAuthorizationCallback callback 

Perform an authorization flow using a generic flow shim.

Parameters
requestThe authorization request.
UICoordinatorGeneric authorization UI coordinator that can present an authorization request.
callbackThe method called when the request has completed or failed.
Returns
A OIDAuthorizationFlowSession instance which will terminate when it receives a OIDAuthorizationFlowSession.cancel message, or after processing a OIDAuthorizationFlowSession.resumeAuthorizationFlowWithURL: message.

Property Documentation

◆ configuration

- (OIDServiceConfiguration*) configuration
readnonatomicassign

The service's configuration.

Remarks
Each authorization service is initialized with a configuration. This configuration specifies how to connect to a particular OAuth provider. Clients should use separate authorization service instances for each provider they wish to integrate with. Configurations may be created manually, or via an OpenID Connect Discovery Document.

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