InfiniteBlue Platform REST v2.0

Admin

createAuthenticationProfile

Creates an Authentication Profile

This API creates an authentication profile. Note - Not more than Password, Kerberos, Custom, API token & OE authentication profile can exist. This holds true in case of creation of authentication profiles via API too. Authentication type cannot be created via APIs. Authentication type is an integer and mapping for authentication profiles is as given below - LDAP - 1 SOAP - 2 REST - 3 OE - 6 LDAP_ADVANCED - 7 SAML - 9


/meta/authenticationprofiles

Usage and SDK Samples

curl -X POST -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/authenticationprofiles"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        AuthenticationProfileModel body = {
  "name" : "authProfileName",
  "authType" : 1,
  "defaultUIAuth" : true,
  "defaultAPIAuth" : false,
  "props" : { }
}; // AuthenticationProfileModel | Authentication Proifle Record
        try {
            SuccessResponse result = apiInstance.createAuthenticationProfile(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createAuthenticationProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        AuthenticationProfileModel body = {
  "name" : "authProfileName",
  "authType" : 1,
  "defaultUIAuth" : true,
  "defaultAPIAuth" : false,
  "props" : { }
}; // AuthenticationProfileModel | Authentication Proifle Record
        try {
            SuccessResponse result = apiInstance.createAuthenticationProfile(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createAuthenticationProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
AuthenticationProfileModel *body = {
  "name" : "authProfileName",
  "authType" : 1,
  "defaultUIAuth" : true,
  "defaultAPIAuth" : false,
  "props" : { }
}; // Authentication Proifle Record

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

// Creates an Authentication Profile
[apiInstance createAuthenticationProfileWith:body
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = {
  "name" : "authProfileName",
  "authType" : 1,
  "defaultUIAuth" : true,
  "defaultAPIAuth" : false,
  "props" : { }
}; // {{AuthenticationProfileModel}} Authentication Proifle Record

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAuthenticationProfile(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAuthenticationProfileExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var body = new AuthenticationProfileModel(); // AuthenticationProfileModel | Authentication Proifle Record

            try
            {
                // Creates an Authentication Profile
                SuccessResponse result = apiInstance.createAuthenticationProfile(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.createAuthenticationProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = {
  "name" : "authProfileName",
  "authType" : 1,
  "defaultUIAuth" : true,
  "defaultAPIAuth" : false,
  "props" : { }
}; // AuthenticationProfileModel | Authentication Proifle Record

try {
    $result = $api_instance->createAuthenticationProfile($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->createAuthenticationProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::AuthenticationProfileModel->new(); # AuthenticationProfileModel | Authentication Proifle Record

eval { 
    my $result = $api_instance->createAuthenticationProfile(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->createAuthenticationProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body = {
  "name" : "authProfileName",
  "authType" : 1,
  "defaultUIAuth" : true,
  "defaultAPIAuth" : false,
  "props" : { }
} # AuthenticationProfileModel | Authentication Proifle Record

try: 
    # Creates an Authentication Profile
    api_response = api_instance.create_authentication_profile(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->createAuthenticationProfile: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


createBatchJobDef

[Beta] Creates a new batch job definition.

Creates a new batch job definition.


/meta/batchJobs

Usage and SDK Samples

curl -X POST -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/batchJobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        BatchJobDefModel body = ; // BatchJobDefModel | 
        try {
            SuccessResponse result = apiInstance.createBatchJobDef(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createBatchJobDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        BatchJobDefModel body = ; // BatchJobDefModel | 
        try {
            SuccessResponse result = apiInstance.createBatchJobDef(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createBatchJobDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
BatchJobDefModel *body = ; // 

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

// [Beta] Creates a new batch job definition.
[apiInstance createBatchJobDefWith:body
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = ; // {{BatchJobDefModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBatchJobDef(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBatchJobDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var body = new BatchJobDefModel(); // BatchJobDefModel | 

            try
            {
                // [Beta] Creates a new batch job definition.
                SuccessResponse result = apiInstance.createBatchJobDef(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.createBatchJobDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = ; // BatchJobDefModel | 

try {
    $result = $api_instance->createBatchJobDef($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->createBatchJobDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::BatchJobDefModel->new(); # BatchJobDefModel | 

eval { 
    my $result = $api_instance->createBatchJobDef(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->createBatchJobDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body =  # BatchJobDefModel | 

try: 
    # [Beta] Creates a new batch job definition.
    api_response = api_instance.create_batch_job_def(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->createBatchJobDef: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


createFieldDef

[Beta] Creates a new field definition.

Creates a new field definition.


/meta/objects/{objIntegrationName}/fields

Usage and SDK Samples

curl -X POST -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}/fields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        FieldDefModel body = ; // FieldDefModel | Provide field definition.
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.createFieldDef(body, objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createFieldDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        FieldDefModel body = ; // FieldDefModel | Provide field definition.
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.createFieldDef(body, objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createFieldDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
FieldDefModel *body = ; // Provide field definition.
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.

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

// [Beta] Creates a new field definition.
[apiInstance createFieldDefWith:body
    objIntegrationName:objIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = ; // {{FieldDefModel}} Provide field definition.
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFieldDef(bodyobjIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFieldDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var body = new FieldDefModel(); // FieldDefModel | Provide field definition.
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.

            try
            {
                // [Beta] Creates a new field definition.
                SuccessResponse result = apiInstance.createFieldDef(body, objIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.createFieldDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = ; // FieldDefModel | Provide field definition.
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.

try {
    $result = $api_instance->createFieldDef($body, $objIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->createFieldDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::FieldDefModel->new(); # FieldDefModel | Provide field definition.
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.

eval { 
    my $result = $api_instance->createFieldDef(body => $body, objIntegrationName => $objIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->createFieldDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body =  # FieldDefModel | Provide field definition.
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.

try: 
    # [Beta] Creates a new field definition.
    api_response = api_instance.create_field_def(body, objIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->createFieldDef: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


createObjectDef

[Beta] Creates a new object definition.

Creates a new object definition.


/meta/objects

Usage and SDK Samples

curl -X POST -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        ObjectDefModel body = ; // ObjectDefModel | Provide object definition.
        try {
            SuccessResponse result = apiInstance.createObjectDef(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createObjectDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        ObjectDefModel body = ; // ObjectDefModel | Provide object definition.
        try {
            SuccessResponse result = apiInstance.createObjectDef(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createObjectDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
ObjectDefModel *body = ; // Provide object definition.

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

// [Beta] Creates a new object definition.
[apiInstance createObjectDefWith:body
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = ; // {{ObjectDefModel}} Provide object definition.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createObjectDef(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createObjectDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var body = new ObjectDefModel(); // ObjectDefModel | Provide object definition.

            try
            {
                // [Beta] Creates a new object definition.
                SuccessResponse result = apiInstance.createObjectDef(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.createObjectDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = ; // ObjectDefModel | Provide object definition.

try {
    $result = $api_instance->createObjectDef($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->createObjectDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::ObjectDefModel->new(); # ObjectDefModel | Provide object definition.

eval { 
    my $result = $api_instance->createObjectDef(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->createObjectDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body =  # ObjectDefModel | Provide object definition.

try: 
    # [Beta] Creates a new object definition.
    api_response = api_instance.create_object_def(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->createObjectDef: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


createRelationshipDefinition

[Beta] Creates a new relationship definition.

Creates a new relationship definiton between two objects in a direction. Source of the relationship is identified by '*objIntegrationName*' from the request path. A corresponding relationship in the other direction would be defined with '*objDef2*' from the request body.


/meta/objects/{objIntegrationName}/relationships

Usage and SDK Samples

curl -X POST -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}/relationships"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        RelationshipModel body = ; // RelationshipModel | Provide integration name of the other side of the relationship against '*objDef2*'.
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.createRelationshipDefinition(body, objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createRelationshipDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        RelationshipModel body = ; // RelationshipModel | Provide integration name of the other side of the relationship against '*objDef2*'.
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.createRelationshipDefinition(body, objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createRelationshipDefinition");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
RelationshipModel *body = ; // Provide integration name of the other side of the relationship against '*objDef2*'.
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.

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

// [Beta] Creates a new relationship definition.
[apiInstance createRelationshipDefinitionWith:body
    objIntegrationName:objIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = ; // {{RelationshipModel}} Provide integration name of the other side of the relationship against '*objDef2*'.
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRelationshipDefinition(bodyobjIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRelationshipDefinitionExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var body = new RelationshipModel(); // RelationshipModel | Provide integration name of the other side of the relationship against '*objDef2*'.
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.

            try
            {
                // [Beta] Creates a new relationship definition.
                SuccessResponse result = apiInstance.createRelationshipDefinition(body, objIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.createRelationshipDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = ; // RelationshipModel | Provide integration name of the other side of the relationship against '*objDef2*'.
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.

try {
    $result = $api_instance->createRelationshipDefinition($body, $objIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->createRelationshipDefinition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::RelationshipModel->new(); # RelationshipModel | Provide integration name of the other side of the relationship against '*objDef2*'.
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.

eval { 
    my $result = $api_instance->createRelationshipDefinition(body => $body, objIntegrationName => $objIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->createRelationshipDefinition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body =  # RelationshipModel | Provide integration name of the other side of the relationship against '*objDef2*'.
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.

try: 
    # [Beta] Creates a new relationship definition.
    api_response = api_instance.create_relationship_definition(body, objIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->createRelationshipDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


createRole

Create role.

Create role.


/meta/roles

Usage and SDK Samples

curl -X POST -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/roles"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        RoleDefinitionModel body = ; // RoleDefinitionModel | Role definition
        try {
            SuccessResponse result = apiInstance.createRole(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        RoleDefinitionModel body = ; // RoleDefinitionModel | Role definition
        try {
            SuccessResponse result = apiInstance.createRole(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createRole");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
RoleDefinitionModel *body = ; // Role definition

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

// Create role.
[apiInstance createRoleWith:body
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = ; // {{RoleDefinitionModel}} Role definition

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRole(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRoleExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var body = new RoleDefinitionModel(); // RoleDefinitionModel | Role definition

            try
            {
                // Create role.
                SuccessResponse result = apiInstance.createRole(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.createRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = ; // RoleDefinitionModel | Role definition

try {
    $result = $api_instance->createRole($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->createRole: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::RoleDefinitionModel->new(); # RoleDefinitionModel | Role definition

eval { 
    my $result = $api_instance->createRole(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->createRole: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body =  # RoleDefinitionModel | Role definition

try: 
    # Create role.
    api_response = api_instance.create_role(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->createRole: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


createTriggerDef

[Beta] Creates a new trigger definition.

Creates a new trigger definition.


/meta/objects/{objIntegrationName}/triggers

Usage and SDK Samples

curl -X POST -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}/triggers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        TriggerDefModel body = ; // TriggerDefModel | 
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.createTriggerDef(body, objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createTriggerDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        TriggerDefModel body = ; // TriggerDefModel | 
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.createTriggerDef(body, objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createTriggerDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
TriggerDefModel *body = ; // 
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.

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

// [Beta] Creates a new trigger definition.
[apiInstance createTriggerDefWith:body
    objIntegrationName:objIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = ; // {{TriggerDefModel}} 
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTriggerDef(bodyobjIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTriggerDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var body = new TriggerDefModel(); // TriggerDefModel | 
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.

            try
            {
                // [Beta] Creates a new trigger definition.
                SuccessResponse result = apiInstance.createTriggerDef(body, objIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.createTriggerDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = ; // TriggerDefModel | 
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.

try {
    $result = $api_instance->createTriggerDef($body, $objIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->createTriggerDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::TriggerDefModel->new(); # TriggerDefModel | 
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.

eval { 
    my $result = $api_instance->createTriggerDef(body => $body, objIntegrationName => $objIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->createTriggerDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body =  # TriggerDefModel | 
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.

try: 
    # [Beta] Creates a new trigger definition.
    api_response = api_instance.create_trigger_def(body, objIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->createTriggerDef: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


createViewDefinition

Creates a new view.

Creates a new view definition under given object.


/meta/objects/{objIntegrationName}/views

Usage and SDK Samples

curl -X POST -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}/views"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        ViewDefinitionModel body = ; // ViewDefinitionModel | Description
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.createViewDefinition(body, objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createViewDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        ViewDefinitionModel body = ; // ViewDefinitionModel | Description
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.createViewDefinition(body, objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#createViewDefinition");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
ViewDefinitionModel *body = ; // Description
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.

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

// Creates a new view.
[apiInstance createViewDefinitionWith:body
    objIntegrationName:objIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var body = ; // {{ViewDefinitionModel}} Description
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createViewDefinition(bodyobjIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createViewDefinitionExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var body = new ViewDefinitionModel(); // ViewDefinitionModel | Description
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.

            try
            {
                // Creates a new view.
                SuccessResponse result = apiInstance.createViewDefinition(body, objIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.createViewDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$body = ; // ViewDefinitionModel | Description
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.

try {
    $result = $api_instance->createViewDefinition($body, $objIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->createViewDefinition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $body = WWW::SwaggerClient::Object::ViewDefinitionModel->new(); # ViewDefinitionModel | Description
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.

eval { 
    my $result = $api_instance->createViewDefinition(body => $body, objIntegrationName => $objIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->createViewDefinition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
body =  # ViewDefinitionModel | Description
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.

try: 
    # Creates a new view.
    api_response = api_instance.create_view_definition(body, objIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->createViewDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteApplicationDef

Delete an application definition.

Delete an application definition


/meta/applications/{appIntegrationName}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/applications/{appIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String appIntegrationName = appIntegrationName_example; // String | The integrationName of the application.
        try {
            SuccessResponse result = apiInstance.deleteApplicationDef(appIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteApplicationDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String appIntegrationName = appIntegrationName_example; // String | The integrationName of the application.
        try {
            SuccessResponse result = apiInstance.deleteApplicationDef(appIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteApplicationDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *appIntegrationName = appIntegrationName_example; // The integrationName of the application.

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

// Delete an application definition.
[apiInstance deleteApplicationDefWith:appIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var appIntegrationName = appIntegrationName_example; // {{String}} The integrationName of the application.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteApplicationDef(appIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteApplicationDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var appIntegrationName = appIntegrationName_example;  // String | The integrationName of the application.

            try
            {
                // Delete an application definition.
                SuccessResponse result = apiInstance.deleteApplicationDef(appIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteApplicationDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$appIntegrationName = appIntegrationName_example; // String | The integrationName of the application.

try {
    $result = $api_instance->deleteApplicationDef($appIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteApplicationDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $appIntegrationName = appIntegrationName_example; # String | The integrationName of the application.

eval { 
    my $result = $api_instance->deleteApplicationDef(appIntegrationName => $appIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteApplicationDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
appIntegrationName = appIntegrationName_example # String | The integrationName of the application.

try: 
    # Delete an application definition.
    api_response = api_instance.delete_application_def(appIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteApplicationDef: %s\n" % e)

Parameters

Path parameters
Name Description
appIntegrationName*
String
The integrationName of the application.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteAuthenticationProfile

Delete an authentication profile with given id

Delete an authentication profile with given id. If an authentication profile is mapped to any role or if it set as a Default UI/API authentication profile for a tenant, then we cannot delete the authentication profile. Note: Global authentication profiles like Custom, Kerberos, API token cannot be deleted.


/meta/authenticationprofiles/{authenticationProfileId}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/authenticationprofiles/{authenticationProfileId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String authenticationProfileId = authenticationProfileId_example; // String | The originalId of the authentication profile.
        try {
            SuccessResponse result = apiInstance.deleteAuthenticationProfile(authenticationProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteAuthenticationProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String authenticationProfileId = authenticationProfileId_example; // String | The originalId of the authentication profile.
        try {
            SuccessResponse result = apiInstance.deleteAuthenticationProfile(authenticationProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteAuthenticationProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *authenticationProfileId = authenticationProfileId_example; // The originalId of the authentication profile.

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

// Delete an authentication profile with given id
[apiInstance deleteAuthenticationProfileWith:authenticationProfileId
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var authenticationProfileId = authenticationProfileId_example; // {{String}} The originalId of the authentication profile.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAuthenticationProfile(authenticationProfileId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAuthenticationProfileExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var authenticationProfileId = authenticationProfileId_example;  // String | The originalId of the authentication profile.

            try
            {
                // Delete an authentication profile with given id
                SuccessResponse result = apiInstance.deleteAuthenticationProfile(authenticationProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteAuthenticationProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$authenticationProfileId = authenticationProfileId_example; // String | The originalId of the authentication profile.

try {
    $result = $api_instance->deleteAuthenticationProfile($authenticationProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteAuthenticationProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $authenticationProfileId = authenticationProfileId_example; # String | The originalId of the authentication profile.

eval { 
    my $result = $api_instance->deleteAuthenticationProfile(authenticationProfileId => $authenticationProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteAuthenticationProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
authenticationProfileId = authenticationProfileId_example # String | The originalId of the authentication profile.

try: 
    # Delete an authentication profile with given id
    api_response = api_instance.delete_authentication_profile(authenticationProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteAuthenticationProfile: %s\n" % e)

Parameters

Path parameters
Name Description
authenticationProfileId*
String
The originalId of the authentication profile.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteBatchJobDef

Delete a batch job definition

Delete batch job definition


/meta/batchJobs/{batchJobIntegrationName}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/batchJobs/{batchJobIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String batchJobIntegrationName = batchJobIntegrationName_example; // String | The integrationName of the batch job.
        try {
            SuccessResponse result = apiInstance.deleteBatchJobDef(batchJobIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteBatchJobDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String batchJobIntegrationName = batchJobIntegrationName_example; // String | The integrationName of the batch job.
        try {
            SuccessResponse result = apiInstance.deleteBatchJobDef(batchJobIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteBatchJobDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *batchJobIntegrationName = batchJobIntegrationName_example; // The integrationName of the batch job.

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

// Delete a batch job definition
[apiInstance deleteBatchJobDefWith:batchJobIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var batchJobIntegrationName = batchJobIntegrationName_example; // {{String}} The integrationName of the batch job.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteBatchJobDef(batchJobIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteBatchJobDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var batchJobIntegrationName = batchJobIntegrationName_example;  // String | The integrationName of the batch job.

            try
            {
                // Delete a batch job definition
                SuccessResponse result = apiInstance.deleteBatchJobDef(batchJobIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteBatchJobDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$batchJobIntegrationName = batchJobIntegrationName_example; // String | The integrationName of the batch job.

try {
    $result = $api_instance->deleteBatchJobDef($batchJobIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteBatchJobDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $batchJobIntegrationName = batchJobIntegrationName_example; # String | The integrationName of the batch job.

eval { 
    my $result = $api_instance->deleteBatchJobDef(batchJobIntegrationName => $batchJobIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteBatchJobDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
batchJobIntegrationName = batchJobIntegrationName_example # String | The integrationName of the batch job.

try: 
    # Delete a batch job definition
    api_response = api_instance.delete_batch_job_def(batchJobIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteBatchJobDef: %s\n" % e)

Parameters

Path parameters
Name Description
batchJobIntegrationName*
String
The integrationName of the batch job.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteFieldDef

[Beta] Delete a field definition.

Delete a field definition


/meta/objects/{objIntegrationName}/fields/{fieldIntegrationName}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}/fields/{fieldIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        String fieldIntegrationName = fieldIntegrationName_example; // String | The integrationName of the field.
        try {
            SuccessResponse result = apiInstance.deleteFieldDef(objIntegrationName, fieldIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteFieldDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        String fieldIntegrationName = fieldIntegrationName_example; // String | The integrationName of the field.
        try {
            SuccessResponse result = apiInstance.deleteFieldDef(objIntegrationName, fieldIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteFieldDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.
String *fieldIntegrationName = fieldIntegrationName_example; // The integrationName of the field.

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

// [Beta] Delete a field definition.
[apiInstance deleteFieldDefWith:objIntegrationName
    fieldIntegrationName:fieldIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.
var fieldIntegrationName = fieldIntegrationName_example; // {{String}} The integrationName of the field.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteFieldDef(objIntegrationName, fieldIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFieldDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.
            var fieldIntegrationName = fieldIntegrationName_example;  // String | The integrationName of the field.

            try
            {
                // [Beta] Delete a field definition.
                SuccessResponse result = apiInstance.deleteFieldDef(objIntegrationName, fieldIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteFieldDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
$fieldIntegrationName = fieldIntegrationName_example; // String | The integrationName of the field.

try {
    $result = $api_instance->deleteFieldDef($objIntegrationName, $fieldIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteFieldDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.
my $fieldIntegrationName = fieldIntegrationName_example; # String | The integrationName of the field.

eval { 
    my $result = $api_instance->deleteFieldDef(objIntegrationName => $objIntegrationName, fieldIntegrationName => $fieldIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteFieldDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.
fieldIntegrationName = fieldIntegrationName_example # String | The integrationName of the field.

try: 
    # [Beta] Delete a field definition.
    api_response = api_instance.delete_field_def(objIntegrationName, fieldIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteFieldDef: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required
fieldIntegrationName*
String
The integrationName of the field.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteObjectDef

Delete an object definition.

Delete an object definition


/meta/objects/{objIntegrationName}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.deleteObjectDef(objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteObjectDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        try {
            SuccessResponse result = apiInstance.deleteObjectDef(objIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteObjectDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.

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

// Delete an object definition.
[apiInstance deleteObjectDefWith:objIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteObjectDef(objIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteObjectDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.

            try
            {
                // Delete an object definition.
                SuccessResponse result = apiInstance.deleteObjectDef(objIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteObjectDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.

try {
    $result = $api_instance->deleteObjectDef($objIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteObjectDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.

eval { 
    my $result = $api_instance->deleteObjectDef(objIntegrationName => $objIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteObjectDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.

try: 
    # Delete an object definition.
    api_response = api_instance.delete_object_def(objIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteObjectDef: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteRelationshipDefinition

[Beta] Delete a relationship definition

Delete relationship definition


/meta/objects/{objIntegrationName}/relationships/{relIntegrationName}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}/relationships/{relIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        String relIntegrationName = relIntegrationName_example; // String | The integrationName of the relationship.
        try {
            SuccessResponse result = apiInstance.deleteRelationshipDefinition(objIntegrationName, relIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteRelationshipDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        String relIntegrationName = relIntegrationName_example; // String | The integrationName of the relationship.
        try {
            SuccessResponse result = apiInstance.deleteRelationshipDefinition(objIntegrationName, relIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteRelationshipDefinition");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.
String *relIntegrationName = relIntegrationName_example; // The integrationName of the relationship.

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

// [Beta] Delete a relationship definition
[apiInstance deleteRelationshipDefinitionWith:objIntegrationName
    relIntegrationName:relIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.
var relIntegrationName = relIntegrationName_example; // {{String}} The integrationName of the relationship.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRelationshipDefinition(objIntegrationName, relIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRelationshipDefinitionExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.
            var relIntegrationName = relIntegrationName_example;  // String | The integrationName of the relationship.

            try
            {
                // [Beta] Delete a relationship definition
                SuccessResponse result = apiInstance.deleteRelationshipDefinition(objIntegrationName, relIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteRelationshipDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
$relIntegrationName = relIntegrationName_example; // String | The integrationName of the relationship.

try {
    $result = $api_instance->deleteRelationshipDefinition($objIntegrationName, $relIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteRelationshipDefinition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.
my $relIntegrationName = relIntegrationName_example; # String | The integrationName of the relationship.

eval { 
    my $result = $api_instance->deleteRelationshipDefinition(objIntegrationName => $objIntegrationName, relIntegrationName => $relIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteRelationshipDefinition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.
relIntegrationName = relIntegrationName_example # String | The integrationName of the relationship.

try: 
    # [Beta] Delete a relationship definition
    api_response = api_instance.delete_relationship_definition(objIntegrationName, relIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteRelationshipDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required
relIntegrationName*
String
The integrationName of the relationship.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteRoleByIntegrationName

Delete a role definition

Delete role definition


/meta/roles/{roleIntegrationName}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/roles/{roleIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String roleIntegrationName = roleIntegrationName_example; // String | The integrationName of the role.
        try {
            SuccessResponse result = apiInstance.deleteRoleByIntegrationName(roleIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteRoleByIntegrationName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String roleIntegrationName = roleIntegrationName_example; // String | The integrationName of the role.
        try {
            SuccessResponse result = apiInstance.deleteRoleByIntegrationName(roleIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteRoleByIntegrationName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *roleIntegrationName = roleIntegrationName_example; // The integrationName of the role.

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

// Delete a role definition
[apiInstance deleteRoleByIntegrationNameWith:roleIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var roleIntegrationName = roleIntegrationName_example; // {{String}} The integrationName of the role.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRoleByIntegrationName(roleIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRoleByIntegrationNameExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var roleIntegrationName = roleIntegrationName_example;  // String | The integrationName of the role.

            try
            {
                // Delete a role definition
                SuccessResponse result = apiInstance.deleteRoleByIntegrationName(roleIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteRoleByIntegrationName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$roleIntegrationName = roleIntegrationName_example; // String | The integrationName of the role.

try {
    $result = $api_instance->deleteRoleByIntegrationName($roleIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteRoleByIntegrationName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $roleIntegrationName = roleIntegrationName_example; # String | The integrationName of the role.

eval { 
    my $result = $api_instance->deleteRoleByIntegrationName(roleIntegrationName => $roleIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteRoleByIntegrationName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
roleIntegrationName = roleIntegrationName_example # String | The integrationName of the role.

try: 
    # Delete a role definition
    api_response = api_instance.delete_role_by_integration_name(roleIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteRoleByIntegrationName: %s\n" % e)

Parameters

Path parameters
Name Description
roleIntegrationName*
String
The integrationName of the role.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteTriggerDef

[Beta] Delete a trigger definition.

Delete trigger definition


/meta/objects/{objIntegrationName}/triggers/{triggerIntegrationName}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}/triggers/{triggerIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        String triggerIntegrationName = triggerIntegrationName_example; // String | The integrationName of the trigger.
        try {
            SuccessResponse result = apiInstance.deleteTriggerDef(objIntegrationName, triggerIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteTriggerDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        String triggerIntegrationName = triggerIntegrationName_example; // String | The integrationName of the trigger.
        try {
            SuccessResponse result = apiInstance.deleteTriggerDef(objIntegrationName, triggerIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteTriggerDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.
String *triggerIntegrationName = triggerIntegrationName_example; // The integrationName of the trigger.

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

// [Beta] Delete a trigger definition.
[apiInstance deleteTriggerDefWith:objIntegrationName
    triggerIntegrationName:triggerIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.
var triggerIntegrationName = triggerIntegrationName_example; // {{String}} The integrationName of the trigger.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteTriggerDef(objIntegrationName, triggerIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTriggerDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.
            var triggerIntegrationName = triggerIntegrationName_example;  // String | The integrationName of the trigger.

            try
            {
                // [Beta] Delete a trigger definition.
                SuccessResponse result = apiInstance.deleteTriggerDef(objIntegrationName, triggerIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteTriggerDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
$triggerIntegrationName = triggerIntegrationName_example; // String | The integrationName of the trigger.

try {
    $result = $api_instance->deleteTriggerDef($objIntegrationName, $triggerIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteTriggerDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.
my $triggerIntegrationName = triggerIntegrationName_example; # String | The integrationName of the trigger.

eval { 
    my $result = $api_instance->deleteTriggerDef(objIntegrationName => $objIntegrationName, triggerIntegrationName => $triggerIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteTriggerDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.
triggerIntegrationName = triggerIntegrationName_example # String | The integrationName of the trigger.

try: 
    # [Beta] Delete a trigger definition.
    api_response = api_instance.delete_trigger_def(objIntegrationName, triggerIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteTriggerDef: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required
triggerIntegrationName*
String
The integrationName of the trigger.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


deleteViewDefinition

Delete a view definition

Delete view definition


/meta/objects/{objIntegrationName}/views/{viewIntegrationName}

Usage and SDK Samples

curl -X DELETE -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/objects/{objIntegrationName}/views/{viewIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        String viewIntegrationName = viewIntegrationName_example; // String | The integrationName of the view.
        try {
            SuccessResponse result = apiInstance.deleteViewDefinition(objIntegrationName, viewIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteViewDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
        String viewIntegrationName = viewIntegrationName_example; // String | The integrationName of the view.
        try {
            SuccessResponse result = apiInstance.deleteViewDefinition(objIntegrationName, viewIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#deleteViewDefinition");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *objIntegrationName = objIntegrationName_example; // The integrationName of the object.
String *viewIntegrationName = viewIntegrationName_example; // The integrationName of the view.

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

// Delete a view definition
[apiInstance deleteViewDefinitionWith:objIntegrationName
    viewIntegrationName:viewIntegrationName
              completionHandler: ^(SuccessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var objIntegrationName = objIntegrationName_example; // {{String}} The integrationName of the object.
var viewIntegrationName = viewIntegrationName_example; // {{String}} The integrationName of the view.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteViewDefinition(objIntegrationName, viewIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteViewDefinitionExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var objIntegrationName = objIntegrationName_example;  // String | The integrationName of the object.
            var viewIntegrationName = viewIntegrationName_example;  // String | The integrationName of the view.

            try
            {
                // Delete a view definition
                SuccessResponse result = apiInstance.deleteViewDefinition(objIntegrationName, viewIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.deleteViewDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$objIntegrationName = objIntegrationName_example; // String | The integrationName of the object.
$viewIntegrationName = viewIntegrationName_example; // String | The integrationName of the view.

try {
    $result = $api_instance->deleteViewDefinition($objIntegrationName, $viewIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->deleteViewDefinition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $objIntegrationName = objIntegrationName_example; # String | The integrationName of the object.
my $viewIntegrationName = viewIntegrationName_example; # String | The integrationName of the view.

eval { 
    my $result = $api_instance->deleteViewDefinition(objIntegrationName => $objIntegrationName, viewIntegrationName => $viewIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->deleteViewDefinition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
objIntegrationName = objIntegrationName_example # String | The integrationName of the object.
viewIntegrationName = viewIntegrationName_example # String | The integrationName of the view.

try: 
    # Delete a view definition
    api_response = api_instance.delete_view_definition(objIntegrationName, viewIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->deleteViewDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
objIntegrationName*
String
The integrationName of the object.
Required
viewIntegrationName*
String
The integrationName of the view.
Required

Responses

Status: 200 - successful operation

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getAllPortals

Retrieves the full description of all the portals.

Retrieves the full description of all the portals.


/meta/portals

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/portals?appIntegrationName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String appIntegrationName = appIntegrationName_example; // String | 
        try {
            inline_response_200_10 result = apiInstance.getAllPortals(appIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getAllPortals");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String appIntegrationName = appIntegrationName_example; // String | 
        try {
            inline_response_200_10 result = apiInstance.getAllPortals(appIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getAllPortals");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *appIntegrationName = appIntegrationName_example; //  (optional)

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

// Retrieves the full description of all the portals.
[apiInstance getAllPortalsWith:appIntegrationName
              completionHandler: ^(inline_response_200_10 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var opts = { 
  'appIntegrationName': appIntegrationName_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllPortals(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllPortalsExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var appIntegrationName = appIntegrationName_example;  // String |  (optional) 

            try
            {
                // Retrieves the full description of all the portals.
                inline_response_200_10 result = apiInstance.getAllPortals(appIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getAllPortals: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$appIntegrationName = appIntegrationName_example; // String | 

try {
    $result = $api_instance->getAllPortals($appIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getAllPortals: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $appIntegrationName = appIntegrationName_example; # String | 

eval { 
    my $result = $api_instance->getAllPortals(appIntegrationName => $appIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getAllPortals: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
appIntegrationName = appIntegrationName_example # String |  (optional)

try: 
    # Retrieves the full description of all the portals.
    api_response = api_instance.get_all_portals(appIntegrationName=appIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getAllPortals: %s\n" % e)

Parameters

Query parameters
Name Description
appIntegrationName
String

Responses

Status: 200 - Retrieves the full description of all the portals.

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getAllRoles

Retrieve all Roles information.

Retrieve all Roles information


/meta/roles

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/roles"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            inline_response_200_9 result = apiInstance.getAllRoles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getAllRoles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        try {
            inline_response_200_9 result = apiInstance.getAllRoles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getAllRoles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];

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

// Retrieve all Roles information.
[apiInstance getAllRolesWithCompletionHandler: 
              ^(inline_response_200_9 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllRoles(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllRolesExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();

            try
            {
                // Retrieve all Roles information.
                inline_response_200_9 result = apiInstance.getAllRoles();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getAllRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();

try {
    $result = $api_instance->getAllRoles();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getAllRoles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();

eval { 
    my $result = $api_instance->getAllRoles();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getAllRoles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()

try: 
    # Retrieve all Roles information.
    api_response = api_instance.get_all_roles()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getAllRoles: %s\n" % e)

Parameters

Responses

Status: 200 - Description of of all roles

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getApplicationDef

Get application definition

Get application definition


/meta/applications/{appIntegrationName}

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/applications/{appIntegrationName}?isXML="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String appIntegrationName = appIntegrationName_example; // String | The integrationName of the application.
        Boolean isXML = true; // Boolean | If true, app XML will be returned.
        try {
            inline_response_200 result = apiInstance.getApplicationDef(appIntegrationName, isXML);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getApplicationDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String appIntegrationName = appIntegrationName_example; // String | The integrationName of the application.
        Boolean isXML = true; // Boolean | If true, app XML will be returned.
        try {
            inline_response_200 result = apiInstance.getApplicationDef(appIntegrationName, isXML);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getApplicationDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *appIntegrationName = appIntegrationName_example; // The integrationName of the application.
Boolean *isXML = true; // If true, app XML will be returned. (optional)

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

// Get application definition
[apiInstance getApplicationDefWith:appIntegrationName
    isXML:isXML
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var appIntegrationName = appIntegrationName_example; // {{String}} The integrationName of the application.
var opts = { 
  'isXML': true // {{Boolean}} If true, app XML will be returned.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplicationDef(appIntegrationName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var appIntegrationName = appIntegrationName_example;  // String | The integrationName of the application.
            var isXML = true;  // Boolean | If true, app XML will be returned. (optional) 

            try
            {
                // Get application definition
                inline_response_200 result = apiInstance.getApplicationDef(appIntegrationName, isXML);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getApplicationDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$appIntegrationName = appIntegrationName_example; // String | The integrationName of the application.
$isXML = true; // Boolean | If true, app XML will be returned.

try {
    $result = $api_instance->getApplicationDef($appIntegrationName, $isXML);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getApplicationDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $appIntegrationName = appIntegrationName_example; # String | The integrationName of the application.
my $isXML = true; # Boolean | If true, app XML will be returned.

eval { 
    my $result = $api_instance->getApplicationDef(appIntegrationName => $appIntegrationName, isXML => $isXML);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getApplicationDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
appIntegrationName = appIntegrationName_example # String | The integrationName of the application.
isXML = true # Boolean | If true, app XML will be returned. (optional)

try: 
    # Get application definition
    api_response = api_instance.get_application_def(appIntegrationName, isXML=isXML)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getApplicationDef: %s\n" % e)

Parameters

Path parameters
Name Description
appIntegrationName*
String
The integrationName of the application.
Required
Query parameters
Name Description
isXML
Boolean
If true, app XML will be returned.

Responses

Status: 200 - Get application definition.

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getApplicationDefs

Get all the application definitions.

Get all application definitions.


/meta/applications

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/applications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            inline_response_200 result = apiInstance.getApplicationDefs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getApplicationDefs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        try {
            inline_response_200 result = apiInstance.getApplicationDefs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getApplicationDefs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];

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

// Get all the application definitions.
[apiInstance getApplicationDefsWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplicationDefs(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationDefsExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();

            try
            {
                // Get all the application definitions.
                inline_response_200 result = apiInstance.getApplicationDefs();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getApplicationDefs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();

try {
    $result = $api_instance->getApplicationDefs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getApplicationDefs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();

eval { 
    my $result = $api_instance->getApplicationDefs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getApplicationDefs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()

try: 
    # Get all the application definitions.
    api_response = api_instance.get_application_defs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getApplicationDefs: %s\n" % e)

Parameters

Responses

Status: 200 - Get application definitions.

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getApplicationPermissions

[Beta] Retrieves application's access permission.

Returns information about the specified application, including permissions granted to the specified role/user. Ensure either of roleIntegrationName or userId is provided.


/meta/applications/{appIntegrationName}/permissions

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/applications/{appIntegrationName}/permissions?roleIntegrationName=&userId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String appIntegrationName = appIntegrationName_example; // String | The integration name of the application.
        String roleIntegrationName = roleIntegrationName_example; // String | The integration name of the role.
        String userId = userId_example; // String | The id of the user.
        try {
            inline_response_200_1 result = apiInstance.getApplicationPermissions(appIntegrationName, roleIntegrationName, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getApplicationPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String appIntegrationName = appIntegrationName_example; // String | The integration name of the application.
        String roleIntegrationName = roleIntegrationName_example; // String | The integration name of the role.
        String userId = userId_example; // String | The id of the user.
        try {
            inline_response_200_1 result = apiInstance.getApplicationPermissions(appIntegrationName, roleIntegrationName, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getApplicationPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *appIntegrationName = appIntegrationName_example; // The integration name of the application.
String *roleIntegrationName = roleIntegrationName_example; // The integration name of the role. (optional)
String *userId = userId_example; // The id of the user. (optional)

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

// [Beta] Retrieves application's access permission.
[apiInstance getApplicationPermissionsWith:appIntegrationName
    roleIntegrationName:roleIntegrationName
    userId:userId
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var appIntegrationName = appIntegrationName_example; // {{String}} The integration name of the application.
var opts = { 
  'roleIntegrationName': roleIntegrationName_example, // {{String}} The integration name of the role.
  'userId': userId_example // {{String}} The id of the user.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplicationPermissions(appIntegrationName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationPermissionsExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var appIntegrationName = appIntegrationName_example;  // String | The integration name of the application.
            var roleIntegrationName = roleIntegrationName_example;  // String | The integration name of the role. (optional) 
            var userId = userId_example;  // String | The id of the user. (optional) 

            try
            {
                // [Beta] Retrieves application's access permission.
                inline_response_200_1 result = apiInstance.getApplicationPermissions(appIntegrationName, roleIntegrationName, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getApplicationPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$appIntegrationName = appIntegrationName_example; // String | The integration name of the application.
$roleIntegrationName = roleIntegrationName_example; // String | The integration name of the role.
$userId = userId_example; // String | The id of the user.

try {
    $result = $api_instance->getApplicationPermissions($appIntegrationName, $roleIntegrationName, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getApplicationPermissions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $appIntegrationName = appIntegrationName_example; # String | The integration name of the application.
my $roleIntegrationName = roleIntegrationName_example; # String | The integration name of the role.
my $userId = userId_example; # String | The id of the user.

eval { 
    my $result = $api_instance->getApplicationPermissions(appIntegrationName => $appIntegrationName, roleIntegrationName => $roleIntegrationName, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getApplicationPermissions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
appIntegrationName = appIntegrationName_example # String | The integration name of the application.
roleIntegrationName = roleIntegrationName_example # String | The integration name of the role. (optional)
userId = userId_example # String | The id of the user. (optional)

try: 
    # [Beta] Retrieves application's access permission.
    api_response = api_instance.get_application_permissions(appIntegrationName, roleIntegrationName=roleIntegrationName, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getApplicationPermissions: %s\n" % e)

Parameters

Path parameters
Name Description
appIntegrationName*
String
The integration name of the application.
Required
Query parameters
Name Description
roleIntegrationName
String
The integration name of the role.
userId
String
The id of the user.

Responses

Status: 200 - The 'permissions' entity in the response contains only 'view' permission.

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getAuthenticationProfileById

Return settings of an authentication profile based on the given authentication profile ID for viewing.

Return settings of an authentication profile based on the given authentication profile ID for viewing. Authentication type is an integer and mapping for authentication profiles is as given below - LDAP - 1 SOAP - 2 REST - 3 OE - 6 LDAP_ADVANCED - 7 SAML - 9


/meta/authenticationprofiles/{authenticationProfileId}

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/authenticationprofiles/{authenticationProfileId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String authenticationProfileId = authenticationProfileId_example; // String | The originalId of the authentication profile.
        try {
            inline_response_200_8 result = apiInstance.getAuthenticationProfileById(authenticationProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getAuthenticationProfileById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String authenticationProfileId = authenticationProfileId_example; // String | The originalId of the authentication profile.
        try {
            inline_response_200_8 result = apiInstance.getAuthenticationProfileById(authenticationProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getAuthenticationProfileById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *authenticationProfileId = authenticationProfileId_example; // The originalId of the authentication profile.

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

// Return settings of an authentication profile based on the given authentication profile ID for viewing.
[apiInstance getAuthenticationProfileByIdWith:authenticationProfileId
              completionHandler: ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var authenticationProfileId = authenticationProfileId_example; // {{String}} The originalId of the authentication profile.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthenticationProfileById(authenticationProfileId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAuthenticationProfileByIdExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var authenticationProfileId = authenticationProfileId_example;  // String | The originalId of the authentication profile.

            try
            {
                // Return settings of an authentication profile based on the given authentication profile ID for viewing.
                inline_response_200_8 result = apiInstance.getAuthenticationProfileById(authenticationProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getAuthenticationProfileById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$authenticationProfileId = authenticationProfileId_example; // String | The originalId of the authentication profile.

try {
    $result = $api_instance->getAuthenticationProfileById($authenticationProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getAuthenticationProfileById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $authenticationProfileId = authenticationProfileId_example; # String | The originalId of the authentication profile.

eval { 
    my $result = $api_instance->getAuthenticationProfileById(authenticationProfileId => $authenticationProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getAuthenticationProfileById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
authenticationProfileId = authenticationProfileId_example # String | The originalId of the authentication profile.

try: 
    # Return settings of an authentication profile based on the given authentication profile ID for viewing.
    api_response = api_instance.get_authentication_profile_by_id(authenticationProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getAuthenticationProfileById: %s\n" % e)

Parameters

Path parameters
Name Description
authenticationProfileId*
String
The originalId of the authentication profile.
Required

Responses

Status: 200 - Return Authentication Profile by given id

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getAuthenticationProfiles

Return all authentication profiles list with each profile settings for viewing

Return all authentication profiles list with each profile settings for viewing Authentication type is an integer and mapping for authentication profiles is as given below - LDAP - 1 SOAP - 2 REST - 3 OE - 6 LDAP_ADVANCED - 7 SAML - 9


/meta/authenticationprofiles

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/authenticationprofiles"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            inline_response_200_8 result = apiInstance.getAuthenticationProfiles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getAuthenticationProfiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        try {
            inline_response_200_8 result = apiInstance.getAuthenticationProfiles();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getAuthenticationProfiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];

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

// Return all authentication profiles list with each profile settings for viewing
[apiInstance getAuthenticationProfilesWithCompletionHandler: 
              ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuthenticationProfiles(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAuthenticationProfilesExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();

            try
            {
                // Return all authentication profiles list with each profile settings for viewing
                inline_response_200_8 result = apiInstance.getAuthenticationProfiles();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getAuthenticationProfiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();

try {
    $result = $api_instance->getAuthenticationProfiles();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getAuthenticationProfiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();

eval { 
    my $result = $api_instance->getAuthenticationProfiles();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getAuthenticationProfiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()

try: 
    # Return all authentication profiles list with each profile settings for viewing
    api_response = api_instance.get_authentication_profiles()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getAuthenticationProfiles: %s\n" % e)

Parameters

Responses

Status: 200 - Return authentication profiles of a customer

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getBatchJobDef

Retrieves the full description of a batch job definition.

Retrieves the full description of a batch job definition.


/meta/batchJobs/{batchJobIntegrationName}

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/batchJobs/{batchJobIntegrationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String batchJobIntegrationName = batchJobIntegrationName_example; // String | The integrationName of the batch job.
        try {
            inline_response_200_7 result = apiInstance.getBatchJobDef(batchJobIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getBatchJobDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String batchJobIntegrationName = batchJobIntegrationName_example; // String | The integrationName of the batch job.
        try {
            inline_response_200_7 result = apiInstance.getBatchJobDef(batchJobIntegrationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getBatchJobDef");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];
String *batchJobIntegrationName = batchJobIntegrationName_example; // The integrationName of the batch job.

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

// Retrieves the full description of a batch job definition.
[apiInstance getBatchJobDefWith:batchJobIntegrationName
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Api-Key.apiKeyPrefix['Api-Key'] = "Token"

// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['JWT'] = "Token"

var api = new InfiniteBluePlatformRestV20.AdminApi()
var batchJobIntegrationName = batchJobIntegrationName_example; // {{String}} The integrationName of the batch job.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBatchJobDef(batchJobIntegrationName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBatchJobDefExample
    {
        public void main()
        {

            // Configure API key authorization: Api-Key
            Configuration.Default.ApiKey.Add("Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Api-Key", "Bearer");
            // Configure API key authorization: JWT
            Configuration.Default.ApiKey.Add("JWT", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("JWT", "Bearer");

            var apiInstance = new AdminApi();
            var batchJobIntegrationName = batchJobIntegrationName_example;  // String | The integrationName of the batch job.

            try
            {
                // Retrieves the full description of a batch job definition.
                inline_response_200_7 result = apiInstance.getBatchJobDef(batchJobIntegrationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.getBatchJobDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Api-Key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');
// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('JWT', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$batchJobIntegrationName = batchJobIntegrationName_example; // String | The integrationName of the batch job.

try {
    $result = $api_instance->getBatchJobDef($batchJobIntegrationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->getBatchJobDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: Api-Key
$WWW::SwaggerClient::Configuration::api_key->{'Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Api-Key'} = "Bearer";
# Configure API key authorization: JWT
$WWW::SwaggerClient::Configuration::api_key->{'JWT'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'JWT'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $batchJobIntegrationName = batchJobIntegrationName_example; # String | The integrationName of the batch job.

eval { 
    my $result = $api_instance->getBatchJobDef(batchJobIntegrationName => $batchJobIntegrationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->getBatchJobDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Api-Key
swagger_client.configuration.api_key['Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Api-Key'] = 'Bearer'
# Configure API key authorization: JWT
swagger_client.configuration.api_key['JWT'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['JWT'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdminApi()
batchJobIntegrationName = batchJobIntegrationName_example # String | The integrationName of the batch job.

try: 
    # Retrieves the full description of a batch job definition.
    api_response = api_instance.get_batch_job_def(batchJobIntegrationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->getBatchJobDef: %s\n" % e)

Parameters

Path parameters
Name Description
batchJobIntegrationName*
String
The integrationName of the batch job.
Required

Responses

Status: 200 - Return the batch job definition

Status: 400 - This error is thrown when user request path params or query params are invalid

Status: 403 - This error is thrown when user does not have access permissions

Status: 500 - Internal server error


getBatchJobDefs

Retrieves the full description of all batch jobs.

Retrieves the full description of all batch jobs.


/meta/batchJobs

Usage and SDK Samples

curl -X GET -H "Api-Key: [[apiKey]]" -H "JWT: [[apiKey]]" "//meta/batchJobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Api-Key
        ApiKeyAuth Api-Key = (ApiKeyAuth) defaultClient.getAuthentication("Api-Key");
        Api-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Api-Key.setApiKeyPrefix("Token");

        // Configure API key authorization: JWT
        ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
        JWT.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //JWT.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        try {
            inline_response_200_7 result = apiInstance.getBatchJobDefs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getBatchJobDefs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        try {
            inline_response_200_7 result = apiInstance.getBatchJobDefs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#getBatchJobDefs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Api-Key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Api-Key"];
// Configure API key authorization: (authentication scheme: JWT)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"JWT"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"JWT"];

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

// Retrieves the full description of all batch jobs.
[apiInstance getBatchJobDefsWithCompletionHandler: 
              ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var InfiniteBluePlatformRestV20 = require('infinite_blue_platform_rest_v20');
var defaultClient = InfiniteBluePlatformRestV20.ApiClient.instance;

// Configure API key authorization: Api-Key
var Api-Key = defaultClient.authentications['Api-Key'];
Api-Key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API