ObjectApikeyApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
apikeyCreateObjectV2	POST /2/object/apikey	Create a new Apikey
apikeyEditObjectV1	PUT /1/object/apikey/{pkiApikeyID}	Edit an existing Apikey
apikeyEditPermissionsV1	PUT /1/object/apikey/{pkiApikeyID}/editPermissions	Edit multiple Permissions
apikeyGenerateDelegatedCredentialsV1	POST /1/object/apikey/generateDelegatedCredentials	Generate a delegated credentials
apikeyGetCorsV1	GET /1/object/apikey/{pkiApikeyID}/getCors	Retrieve an existing Apikey's cors
apikeyGetListV1	GET /1/object/apikey/getList	Retrieve Apikey list
apikeyGetObjectV2	GET /2/object/apikey/{pkiApikeyID}	Retrieve an existing Apikey
apikeyGetPermissionsV1	GET /1/object/apikey/{pkiApikeyID}/getPermissions	Retrieve an existing Apikey's Permissions
apikeyGetSubnetsV1	GET /1/object/apikey/{pkiApikeyID}/getSubnets	Retrieve an existing Apikey's subnets
apikeyRegenerateV1	POST /1/object/apikey/{pkiApikeyID}/regenerate	Regenerate the Apikey

apikeyCreateObjectV2

-(NSURLSessionTask*) apikeyCreateObjectV2WithApikeyCreateObjectV2Request: (ApikeyCreateObjectV2Request*) apikeyCreateObjectV2Request
        completionHandler: (void (^)(ApikeyCreateObjectV2Response* output, NSError* error)) handler;

Create a new Apikey

The endpoint allows to create one or many elements at once.

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


ApikeyCreateObjectV2Request* apikeyCreateObjectV2Request = [[ApikeyCreateObjectV2Request alloc] init]; // 

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

// Create a new Apikey
[apiInstance apikeyCreateObjectV2WithApikeyCreateObjectV2Request:apikeyCreateObjectV2Request
          completionHandler: ^(ApikeyCreateObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyCreateObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
apikeyCreateObjectV2Request	ApikeyCreateObjectV2Request*

Return type

ApikeyCreateObjectV2Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

apikeyEditObjectV1

-(NSURLSessionTask*) apikeyEditObjectV1WithPkiApikeyID: (NSNumber*) pkiApikeyID
    apikeyEditObjectV1Request: (ApikeyEditObjectV1Request*) apikeyEditObjectV1Request
        completionHandler: (void (^)(ApikeyEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Apikey

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiApikeyID = @56; // The unique ID of the Apikey
ApikeyEditObjectV1Request* apikeyEditObjectV1Request = [[ApikeyEditObjectV1Request alloc] init]; // 

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

// Edit an existing Apikey
[apiInstance apikeyEditObjectV1WithPkiApikeyID:pkiApikeyID
              apikeyEditObjectV1Request:apikeyEditObjectV1Request
          completionHandler: ^(ApikeyEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiApikeyID	NSNumber*	The unique ID of the Apikey
apikeyEditObjectV1Request	ApikeyEditObjectV1Request*

Return type

ApikeyEditObjectV1Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

apikeyEditPermissionsV1

-(NSURLSessionTask*) apikeyEditPermissionsV1WithPkiApikeyID: (NSNumber*) pkiApikeyID
    apikeyEditPermissionsV1Request: (ApikeyEditPermissionsV1Request*) apikeyEditPermissionsV1Request
        completionHandler: (void (^)(ApikeyEditPermissionsV1Response* output, NSError* error)) handler;

Edit multiple Permissions

Using this endpoint, you can edit multiple Permissions at the same time.

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiApikeyID = @56; // 
ApikeyEditPermissionsV1Request* apikeyEditPermissionsV1Request = [[ApikeyEditPermissionsV1Request alloc] init]; // 

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

// Edit multiple Permissions
[apiInstance apikeyEditPermissionsV1WithPkiApikeyID:pkiApikeyID
              apikeyEditPermissionsV1Request:apikeyEditPermissionsV1Request
          completionHandler: ^(ApikeyEditPermissionsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyEditPermissionsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiApikeyID	NSNumber*
apikeyEditPermissionsV1Request	ApikeyEditPermissionsV1Request*

Return type

ApikeyEditPermissionsV1Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

apikeyGenerateDelegatedCredentialsV1

-(NSURLSessionTask*) apikeyGenerateDelegatedCredentialsV1WithApikeyGenerateDelegatedCredentialsV1Request: (ApikeyGenerateDelegatedCredentialsV1Request*) apikeyGenerateDelegatedCredentialsV1Request
        completionHandler: (void (^)(ApikeyGenerateDelegatedCredentialsV1Response* output, NSError* error)) handler;

Generate a delegated credentials

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


ApikeyGenerateDelegatedCredentialsV1Request* apikeyGenerateDelegatedCredentialsV1Request = [[ApikeyGenerateDelegatedCredentialsV1Request alloc] init]; // 

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

// Generate a delegated credentials
[apiInstance apikeyGenerateDelegatedCredentialsV1WithApikeyGenerateDelegatedCredentialsV1Request:apikeyGenerateDelegatedCredentialsV1Request
          completionHandler: ^(ApikeyGenerateDelegatedCredentialsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyGenerateDelegatedCredentialsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
apikeyGenerateDelegatedCredentialsV1Request	ApikeyGenerateDelegatedCredentialsV1Request*

Return type

ApikeyGenerateDelegatedCredentialsV1Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

apikeyGetCorsV1

-(NSURLSessionTask*) apikeyGetCorsV1WithPkiApikeyID: (NSNumber*) pkiApikeyID
        completionHandler: (void (^)(ApikeyGetCorsV1Response* output, NSError* error)) handler;

Retrieve an existing Apikey's cors

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiApikeyID = @56; // 

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

// Retrieve an existing Apikey's cors
[apiInstance apikeyGetCorsV1WithPkiApikeyID:pkiApikeyID
          completionHandler: ^(ApikeyGetCorsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyGetCorsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiApikeyID	NSNumber*

Return type

ApikeyGetCorsV1Response*

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

apikeyGetListV1

-(NSURLSessionTask*) apikeyGetListV1WithEOrderBy: (NSString*) eOrderBy
    iRowMax: (NSNumber*) iRowMax
    iRowOffset: (NSNumber*) iRowOffset
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
    sFilter: (NSString*) sFilter
        completionHandler: (void (^)(ApikeyGetListV1Response* output, NSError* error)) handler;

Retrieve Apikey list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---|

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSString* eOrderBy = @"eOrderBy_example"; // Specify how you want the results to be sorted (optional)
NSNumber* iRowMax = @56; //  (optional)
NSNumber* iRowOffset = @0; //  (optional) (default to @0)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)
NSString* sFilter = @"sFilter_example"; //  (optional)

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

// Retrieve Apikey list
[apiInstance apikeyGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(ApikeyGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyGetListV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
eOrderBy	NSString*	Specify how you want the results to be sorted	[optional]
iRowMax	NSNumber*		[optional]
iRowOffset	NSNumber*		[optional] [default to @0]
acceptLanguage	HeaderAcceptLanguage		[optional]
sFilter	NSString*		[optional]

Return type

ApikeyGetListV1Response*

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

apikeyGetObjectV2

-(NSURLSessionTask*) apikeyGetObjectV2WithPkiApikeyID: (NSNumber*) pkiApikeyID
        completionHandler: (void (^)(ApikeyGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Apikey

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiApikeyID = @56; // The unique ID of the Apikey

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

// Retrieve an existing Apikey
[apiInstance apikeyGetObjectV2WithPkiApikeyID:pkiApikeyID
          completionHandler: ^(ApikeyGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiApikeyID	NSNumber*	The unique ID of the Apikey

Return type

ApikeyGetObjectV2Response*

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

apikeyGetPermissionsV1

-(NSURLSessionTask*) apikeyGetPermissionsV1WithPkiApikeyID: (NSNumber*) pkiApikeyID
        completionHandler: (void (^)(ApikeyGetPermissionsV1Response* output, NSError* error)) handler;

Retrieve an existing Apikey's Permissions

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiApikeyID = @56; // 

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

// Retrieve an existing Apikey's Permissions
[apiInstance apikeyGetPermissionsV1WithPkiApikeyID:pkiApikeyID
          completionHandler: ^(ApikeyGetPermissionsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyGetPermissionsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiApikeyID	NSNumber*

Return type

ApikeyGetPermissionsV1Response*

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

apikeyGetSubnetsV1

-(NSURLSessionTask*) apikeyGetSubnetsV1WithPkiApikeyID: (NSNumber*) pkiApikeyID
        completionHandler: (void (^)(ApikeyGetSubnetsV1Response* output, NSError* error)) handler;

Retrieve an existing Apikey's subnets

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiApikeyID = @56; // 

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

// Retrieve an existing Apikey's subnets
[apiInstance apikeyGetSubnetsV1WithPkiApikeyID:pkiApikeyID
          completionHandler: ^(ApikeyGetSubnetsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyGetSubnetsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiApikeyID	NSNumber*

Return type

ApikeyGetSubnetsV1Response*

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

apikeyRegenerateV1

-(NSURLSessionTask*) apikeyRegenerateV1WithPkiApikeyID: (NSNumber*) pkiApikeyID
    apikeyRegenerateV1Request: (ApikeyRegenerateV1Request*) apikeyRegenerateV1Request
        completionHandler: (void (^)(ApikeyRegenerateV1Response* output, NSError* error)) handler;

Regenerate the Apikey

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiApikeyID = @56; // 
ApikeyRegenerateV1Request* apikeyRegenerateV1Request = [[ApikeyRegenerateV1Request alloc] init]; // 

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

// Regenerate the Apikey
[apiInstance apikeyRegenerateV1WithPkiApikeyID:pkiApikeyID
              apikeyRegenerateV1Request:apikeyRegenerateV1Request
          completionHandler: ^(ApikeyRegenerateV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectApikeyApi->apikeyRegenerateV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiApikeyID	NSNumber*
apikeyRegenerateV1Request	ApikeyRegenerateV1Request*

Return type

ApikeyRegenerateV1Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

ObjectApikeyApi.md

Latest commit

History

ObjectApikeyApi.md

File metadata and controls

ObjectApikeyApi

apikeyCreateObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyEditObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyEditPermissionsV1

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyGenerateDelegatedCredentialsV1

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyGetCorsV1

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyGetListV1

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyGetObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyGetPermissionsV1

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyGetSubnetsV1

Example

Parameters

Return type

Authorization

HTTP request headers

apikeyRegenerateV1

Example

Parameters

Return type

Authorization

HTTP request headers