Skip to content

Latest commit

 

History

History
216 lines (152 loc) · 6.69 KB

OAIIdentificationApi.md

File metadata and controls

216 lines (152 loc) · 6.69 KB

OAIIdentificationApi

All URIs are relative to http://http:/v1

Method HTTP request Description
identificationLoginGet GET /identification/login Authenticate with OpenID Connect
identificationLoginMonitorGet GET /identification/login/monitor Get token for off band response login flow monitor
identificationLoginReturnGet GET /identification/login/return Redirect endpoint for OpenID Connect
identificationUserStampUuidPost POST /identification/user/stamp/{uuid} Query when the strong identification was last updated

identificationLoginGet

-(NSURLSessionTask*) identificationLoginGetWithMonitor: (NSString*) monitor
        completionHandler: (void (^)(NSError* error)) handler;

Authenticate with OpenID Connect

Example

NSString* monitor = @"monitor_example"; //  (optional)

OAIIdentificationApi*apiInstance = [[OAIIdentificationApi alloc] init];

// Authenticate with OpenID Connect
[apiInstance identificationLoginGetWithMonitor:monitor
          completionHandler: ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIIdentificationApi->identificationLoginGet: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
monitor NSString* [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

identificationLoginMonitorGet

-(NSURLSessionTask*) identificationLoginMonitorGetWithCompletionHandler: 
        (void (^)(NSError* error)) handler;

Get token for off band response login flow monitor

Example

OAIIdentificationApi*apiInstance = [[OAIIdentificationApi alloc] init];

// Get token for off band response login flow monitor
[apiInstance identificationLoginMonitorGetWithCompletionHandler: 
          ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIIdentificationApi->identificationLoginMonitorGet: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

identificationLoginReturnGet

-(NSURLSessionTask*) identificationLoginReturnGetWithCode: (NSString*) code
    state: (NSString*) state
    cookie: (NSURL*) cookie
    cookie2: (NSURL*) cookie2
        completionHandler: (void (^)(NSString* output, NSError* error)) handler;

Redirect endpoint for OpenID Connect

Example

NSString* code = @"code_example"; // 
NSString* state = @"state_example"; // 
NSURL* cookie = [NSURL fileURLWithPath:@"/path/to/file"]; // 
NSURL* cookie2 = [NSURL fileURLWithPath:@"/path/to/file"]; // 

OAIIdentificationApi*apiInstance = [[OAIIdentificationApi alloc] init];

// Redirect endpoint for OpenID Connect
[apiInstance identificationLoginReturnGetWithCode:code
              state:state
              cookie:cookie
              cookie2:cookie2
          completionHandler: ^(NSString* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIIdentificationApi->identificationLoginReturnGet: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
code NSString*
state NSString*
cookie NSURLNSURL
cookie2 NSURLNSURL

Return type

NSString*

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

identificationUserStampUuidPost

-(NSURLSessionTask*) identificationUserStampUuidPostWithUuid: (NSString*) uuid
    authUser: (NSString*) authUser
    authorization: (NSString*) authorization
        completionHandler: (void (^)(NSString* output, NSError* error)) handler;

Query when the strong identification was last updated

Authorization header expects the following format ‘OAuth {token}’

Example

NSString* uuid = @"uuid_example"; // 
NSString* authUser = @"authUser_example"; //  (optional)
NSString* authorization = @"authorization_example"; //  (optional)

OAIIdentificationApi*apiInstance = [[OAIIdentificationApi alloc] init];

// Query when the strong identification was last updated
[apiInstance identificationUserStampUuidPostWithUuid:uuid
              authUser:authUser
              authorization:authorization
          completionHandler: ^(NSString* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIIdentificationApi->identificationUserStampUuidPost: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
uuid NSString*
authUser NSString* [optional]
authorization NSString* [optional]

Return type

NSString*

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]