Provisioning APIs

GetTenantExchangePublicKey

Retrieves tenant exchange public key type, modulus and exponent for the given tenant.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/TenantExchangePublicKey

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/TenantExchangePublicKey"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        try {
            TenantConfiguration result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet(tenantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        try {
            TenantConfiguration result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet(tenantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).

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

// Gets tenant exchange public key type, modulus and exponent for the given tenant.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdTenantExchangePublicKeyGetWith:tenantId
              completionHandler: ^(TenantConfiguration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).

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

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).

            try
            {
                // Gets tenant exchange public key type, modulus and exponent for the given tenant.
                TenantConfiguration result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet(tenantId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).

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

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).

eval { 
    my $result = $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet(tenantId => $tenantId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier (GUID format).

try: 
    # Gets tenant exchange public key type, modulus and exponent for the given tenant.
    api_response = api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_tenant_exchange_public_key_get(tenantId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdTenantExchangePublicKeyGet: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required

Responses

Status: 200 - Success - Returns tenant exchange public key type, modulus and exponent

Status: 401 - Unauthorized Access!

Status: 404 - Tenant Not Found!

Status: 500 - Internal Server Error!


CreateToken

Creates a virtual token under a given tenant.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens

Use this Api version to create token, which is capable to store 2048 size Rsa key.


/IDPrimeVirtual/Provisioning/V2.0/Tenants/{tenantId}/Users/{userId}/Tokens

Use this Api version to create token, which is capable to store upto 4096 size Rsa key.


Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        try {
            'String' result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost(tenantId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        try {
            'String' result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost(tenantId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.

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

// Creates a virtual token under a given tenant.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdUsersUserIdTokensPostWith:tenantId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.

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

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.

            try
            {
                // Creates a virtual token under a given tenant.
                'String' result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost(tenantId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.

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

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.

eval { 
    my $result = $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost(tenantId => $tenantId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.

try: 
    # Creates a virtual token under a given tenant.
    api_response = api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_users_user_id_tokens_post(tenantId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensPost: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required

Responses

Status: 200 - Success - Returns Token Identifier

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant Not Found!

Status: 409 - Conflict

Status: 500 - Internal Server Error!


GetAllTokens

Get all the virtual token ID(s) list assigned to the given user.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens

Use this Api version to get the list of all the tokens which can contains only 2048 size RSA key.


/IDPrimeVirtual/Provisioning/V2.0/Tenants/{tenantId}/Users/{userId}/Tokens

Use this Api version to get the list of all the tokens.


Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        try {
            'String' result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet(tenantId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        try {
            'String' result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet(tenantId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.

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

// Get all the virtual token ID(s) list assigned to the given user.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdUsersUserIdTokensPostWith:tenantId
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.

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

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.

            try
            {
                // Get all the virtual token ID(s) list assigned to the given user.
                'String' result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet(tenantId, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.

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

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.

eval { 
    my $result = $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet(tenantId => $tenantId, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.

try: 
    # Get all the virtual token ID(s) list assigned to the given user.
    api_response = api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_users_user_id_tokens_post(tenantId, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensGet: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required

Version 1.0, Responses

Status: 200 - Success - Returns the list of token ID(s) assigned to the given user


Version 2.0, Responses

Status: 200 - Success - Returns the list of token ID(s) along with token other details, assigned to the given user

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User Not Found!

Status: 409 - Conflict

Status: 500 - Internal Server Error!


ImportCertificate

Imports PFX certificate in the virtual token. API does not support certificate import from a PFX without a password.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Certificate

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Certificate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String xIDPrimeVirtualCertificatePassword = ; // String | Pfx certificate password.
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        byte[] pfxCertificate = pfxCertificate_example; // byte[] | 
        String xIDPrimeVirtualIsPasswordEncrypted = xIDPrimeVirtualIsPasswordEncrypted_example; // String | Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false.
        try {
            array['String'] result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost(xIDPrimeVirtualCertificatePassword, tenantId, userId, tokenId, pfxCertificate, xIDPrimeVirtualIsPasswordEncrypted);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String xIDPrimeVirtualCertificatePassword = ; // String | Pfx certificate password.
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        byte[] pfxCertificate = pfxCertificate_example; // byte[] | 
        String xIDPrimeVirtualIsPasswordEncrypted = xIDPrimeVirtualIsPasswordEncrypted_example; // String | Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false.
        try {
            array['String'] result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost(xIDPrimeVirtualCertificatePassword, tenantId, userId, tokenId, pfxCertificate, xIDPrimeVirtualIsPasswordEncrypted);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *xIDPrimeVirtualCertificatePassword = ; // Pfx certificate password.
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.
String *tokenId = tokenId_example; // Token Identifier (GUID format).
byte[] *pfxCertificate = pfxCertificate_example; //  (optional)
String *xIDPrimeVirtualIsPasswordEncrypted = xIDPrimeVirtualIsPasswordEncrypted_example; // Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false. (optional) (default to False)

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

// Imports PFX certificate in the virtual token.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdUsersUserIdTokensTokenIdCertificatePostWith:xIDPrimeVirtualCertificatePassword
    tenantId:tenantId
    userId:userId
    tokenId:tokenId
    pfxCertificate:pfxCertificate
    xIDPrimeVirtualIsPasswordEncrypted:xIDPrimeVirtualIsPasswordEncrypted
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var xIDPrimeVirtualCertificatePassword = ; // {{String}} Pfx certificate password.
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.
var tokenId = tokenId_example; // {{String}} Token Identifier (GUID format).
var opts = { 
  'pfxCertificate': pfxCertificate_example // {{byte[]}} 
  'xIDPrimeVirtualIsPasswordEncrypted': xIDPrimeVirtualIsPasswordEncrypted_example // {{String}} Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost(xIDPrimeVirtualCertificatePasswordtenantIduserIdtokenId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProvisioningApi();
            var xIDPrimeVirtualCertificatePassword = new String(); // String | Pfx certificate password.
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.
            var tokenId = tokenId_example;  // String | Token Identifier (GUID format).
            var pfxCertificate = pfxCertificate_example;  // byte[] |  (optional) 
            var xIDPrimeVirtualIsPasswordEncrypted = xIDPrimeVirtualIsPasswordEncrypted_example;  // String | Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false. (optional)  (default to False)

            try
            {
                // Imports PFX certificate in the virtual token.
                array['String'] result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost(xIDPrimeVirtualCertificatePassword, tenantId, userId, tokenId, pfxCertificate, xIDPrimeVirtualIsPasswordEncrypted);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$xIDPrimeVirtualCertificatePassword = ; // String | Pfx certificate password.
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.
$tokenId = tokenId_example; // String | Token Identifier (GUID format).
$pfxCertificate = pfxCertificate_example; // byte[] | 
$xIDPrimeVirtualIsPasswordEncrypted = xIDPrimeVirtualIsPasswordEncrypted_example; // String | Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false.

try {
    $result = $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost($xIDPrimeVirtualCertificatePassword, $tenantId, $userId, $tokenId, $pfxCertificate, $xIDPrimeVirtualIsPasswordEncrypted);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProvisioningApi;

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $xIDPrimeVirtualCertificatePassword = ; # String | Pfx certificate password.
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.
my $tokenId = tokenId_example; # String | Token Identifier (GUID format).
my $pfxCertificate = pfxCertificate_example; # byte[] | 
my $xIDPrimeVirtualIsPasswordEncrypted = xIDPrimeVirtualIsPasswordEncrypted_example; # String | Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false.

eval { 
    my $result = $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost(xIDPrimeVirtualCertificatePassword => $xIDPrimeVirtualCertificatePassword, tenantId => $tenantId, userId => $userId, tokenId => $tokenId, pfxCertificate => $pfxCertificate, xIDPrimeVirtualIsPasswordEncrypted => $xIDPrimeVirtualIsPasswordEncrypted);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
xIDPrimeVirtualCertificatePassword =  # String | Pfx certificate password.
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.
tokenId = tokenId_example # String | Token Identifier (GUID format).
pfxCertificate = pfxCertificate_example # byte[] |  (optional)
xIDPrimeVirtualIsPasswordEncrypted = xIDPrimeVirtualIsPasswordEncrypted_example # String | Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false. (optional) (default to False)

try: 
    # Imports PFX certificate in the virtual token.
    api_response = api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_users_user_id_tokens_token_id_certificate_post(xIDPrimeVirtualCertificatePassword, tenantId, userId, tokenId, pfxCertificate=pfxCertificate, xIDPrimeVirtualIsPasswordEncrypted=xIDPrimeVirtualIsPasswordEncrypted)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatePost: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required
tokenId*
String
Token Identifier (GUID format).
Required
Header parameters
Name Description
X-IDPrimeVirtual-IsPasswordEncrypted
String
Specify true if the pfx certificate password is encrypted with tenant exchange public key otherwise false.
X-IDPrimeVirtual-CertificatePassword*
String (password)
Pfx certificate password.
Required
Form parameters
Name Description
pfxCertificate
byte[] (binary)

Responses

Status: 200 - Success - Returns array of certificate serial numbers

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User/Token Not Found!

Status: 500 - Internal Server Error!


GetTokenCertificates

Gets the certificates assigned to virtual token for the given user.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Certificates

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Certificates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        try {
            array[TokenCertificates] result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet(tenantId, userId, tokenId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        try {
            array[TokenCertificates] result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet(tenantId, userId, tokenId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.
String *tokenId = tokenId_example; // Token Identifier (GUID format).

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

// Gets the certificates assigned to virtual token for the given user.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGetWith:tenantId
    userId:userId
    tokenId:tokenId
              completionHandler: ^(array[TokenCertificates] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.
var tokenId = tokenId_example; // {{String}} Token Identifier (GUID format).

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

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.
            var tokenId = tokenId_example;  // String | Token Identifier (GUID format).

            try
            {
                // Gets the certificates assigned to virtual token for the given user.
                array[TokenCertificates] result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet(tenantId, userId, tokenId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.
$tokenId = tokenId_example; // String | Token Identifier (GUID format).

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

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.
my $tokenId = tokenId_example; # String | Token Identifier (GUID format).

eval { 
    my $result = $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet(tenantId => $tenantId, userId => $userId, tokenId => $tokenId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.
tokenId = tokenId_example # String | Token Identifier (GUID format).

try: 
    # Gets the certificates assigned to virtual token for the given user.
    api_response = api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_users_user_id_tokens_token_id_certificates_get(tenantId, userId, tokenId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCertificatesGet: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required
tokenId*
String
Token Identifier (GUID format).
Required

Responses

Status: 200 - Success - Returns list of user and ca certificates in X509Certificate format for specified Token.

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User/Token Not Found!

Status: 409 - Conflict

Status: 500 - Internal Server Error!


CompleteTokenProvisioning

Marks the provisioning process complete for the token.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Complete

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Complete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut(tenantId, userId, tokenId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut(tenantId, userId, tokenId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.
String *tokenId = tokenId_example; // Token Identifier (GUID format).

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

// Marks the provisioning process complete for the token.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdUsersUserIdTokensTokenIdCompletePutWith:tenantId
    userId:userId
    tokenId:tokenId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.
var tokenId = tokenId_example; // {{String}} Token Identifier (GUID format).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut(tenantId, userId, tokenId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.
            var tokenId = tokenId_example;  // String | Token Identifier (GUID format).

            try
            {
                // Marks the provisioning process complete for the token.
                apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut(tenantId, userId, tokenId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.
$tokenId = tokenId_example; // String | Token Identifier (GUID format).

try {
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut($tenantId, $userId, $tokenId);
} catch (Exception $e) {
    echo 'Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProvisioningApi;

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.
my $tokenId = tokenId_example; # String | Token Identifier (GUID format).

eval { 
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut(tenantId => $tenantId, userId => $userId, tokenId => $tokenId);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.
tokenId = tokenId_example # String | Token Identifier (GUID format).

try: 
    # Marks the provisioning process complete for the token.
    api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_users_user_id_tokens_token_id_complete_put(tenantId, userId, tokenId)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdCompletePut: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required
tokenId*
String
Token Identifier (GUID format).
Required

Responses

Status: 204 - Success - No response body.

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User/Token Not Found!

Status: 409 - Conflict

Status: 500 - Internal Server Error!


DeleteToken

Deletes the virtual token for the given user and tenant.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete(tenantId, userId, tokenId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete(tenantId, userId, tokenId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.
String *tokenId = tokenId_example; // Token Identifier (GUID format).

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

// Deletes the virtual token for the given user and tenant.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdUsersUserIdTokensTokenIdDeleteWith:tenantId
    userId:userId
    tokenId:tokenId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.
var tokenId = tokenId_example; // {{String}} Token Identifier (GUID format).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete(tenantId, userId, tokenId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.
            var tokenId = tokenId_example;  // String | Token Identifier (GUID format).

            try
            {
                // Deletes the virtual token for the given user and tenant.
                apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete(tenantId, userId, tokenId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.
$tokenId = tokenId_example; // String | Token Identifier (GUID format).

try {
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete($tenantId, $userId, $tokenId);
} catch (Exception $e) {
    echo 'Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProvisioningApi;

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.
my $tokenId = tokenId_example; # String | Token Identifier (GUID format).

eval { 
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete(tenantId => $tenantId, userId => $userId, tokenId => $tokenId);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.
tokenId = tokenId_example # String | Token Identifier (GUID format).

try: 
    # Deletes the virtual token for the given user and tenant.
    api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_users_user_id_tokens_token_id_delete(tenantId, userId, tokenId)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required
tokenId*
String
Token Identifier (GUID format).
Required

Responses

Status: 204 - Success - No response body.

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User/Token Not Found!

Status: 500 - Internal Server Error!


UpdateTokenLabel

Updates the token label of the given virtual token.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Label/{tokenLabel}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Label/{tokenLabel}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        String tokenLabel = tokenLabel_example; // String | Token Label (Length should be between 1-32 characters)
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut(tenantId, userId, tokenId, tokenLabel);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        String tokenLabel = tokenLabel_example; // String | Token Label (Length should be between 1-32 characters)
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut(tenantId, userId, tokenId, tokenLabel);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.
String *tokenId = tokenId_example; // Token Identifier (GUID format).
String *tokenLabel = tokenLabel_example; // Token Label (Length should be between 1-32 characters)

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

// Updates the token label of the given virtual token.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPutWith:tenantId
    userId:userId
    tokenId:tokenId
    tokenLabel:tokenLabel
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.
var tokenId = tokenId_example; // {{String}} Token Identifier (GUID format).
var tokenLabel = tokenLabel_example; // {{String}} Token Label (Length should be between 1-32 characters)

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut(tenantId, userId, tokenId, tokenLabel, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.
            var tokenId = tokenId_example;  // String | Token Identifier (GUID format).
            var tokenLabel = tokenLabel_example;  // String | Token Label (Length should be between 1-32 characters)

            try
            {
                // Updates the token label of the given virtual token.
                apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut(tenantId, userId, tokenId, tokenLabel);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.
$tokenId = tokenId_example; // String | Token Identifier (GUID format).
$tokenLabel = tokenLabel_example; // String | Token Label (Length should be between 1-32 characters)

try {
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut($tenantId, $userId, $tokenId, $tokenLabel);
} catch (Exception $e) {
    echo 'Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProvisioningApi;

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.
my $tokenId = tokenId_example; # String | Token Identifier (GUID format).
my $tokenLabel = tokenLabel_example; # String | Token Label (Length should be between 1-32 characters)

eval { 
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut(tenantId => $tenantId, userId => $userId, tokenId => $tokenId, tokenLabel => $tokenLabel);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.
tokenId = tokenId_example # String | Token Identifier (GUID format).
tokenLabel = tokenLabel_example # String | Token Label (Length should be between 1-32 characters)

try: 
    # Updates the token label of the given virtual token.
    api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_users_user_id_tokens_token_id_label_token_label_put(tenantId, userId, tokenId, tokenLabel)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdLabelTokenLabelPut: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required
tokenId*
String
Token Identifier (GUID format).
Required
tokenLabel*
String
Token Label (Length should be between 1-32 characters)
Required

Responses

Status: 204 - Success - No response body.

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User/Token Not Found!

Status: 409 - Conflict

Status: 500 - Internal Server Error!


ResetPassword

Resets the token user/admin password.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Role/{roleName}:ResetPin

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json,text/json,application/*+json"\
"//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Role/{roleName}:ResetPin"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String body = ; // String | The new User/Admin password of the token. The value would be encrypted with tenant exchange public key if the header flag 'X-IDPrimeVirtual-IsNewPasswordEncrypted' is true. User Password length must be in between 8-25 characters. Admin password must be of 48 characters(hex) length.
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        String roleName = roleName_example; // String | The accepted role name will be "User" or "Admin".
        String xIDPrimeVirtualIsNewPasswordEncrypted = xIDPrimeVirtualIsNewPasswordEncrypted_example; // String | Specify true if the provided new user/admin password is encrypted with tenant exchange public key Otherwise false. The default value is false.
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost(body, tenantId, userId, tokenId, roleName, xIDPrimeVirtualIsNewPasswordEncrypted);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String body = ; // String | The new User/Admin password of the token. The value would be encrypted with tenant exchange public key if the header flag 'X-IDPrimeVirtual-IsNewPasswordEncrypted' is true. User Password length must be in between 8-25 characters. Admin password must be of 48 characters(hex) length.
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        String roleName = roleName_example; // String | The accepted role name will be "User" or "Admin".
        String xIDPrimeVirtualIsNewPasswordEncrypted = xIDPrimeVirtualIsNewPasswordEncrypted_example; // String | Specify true if the provided new user/admin password is encrypted with tenant exchange public key Otherwise false. The default value is false.
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost(body, tenantId, userId, tokenId, roleName, xIDPrimeVirtualIsNewPasswordEncrypted);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *body = ; // The new User/Admin password of the token. The value would be encrypted with tenant exchange public key if the header flag 'X-IDPrimeVirtual-IsNewPasswordEncrypted' is true. User Password length must be in between 8-25 characters. Admin password must be of 48 characters(hex) length.
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.
String *tokenId = tokenId_example; // Token Identifier (GUID format).
String *roleName = roleName_example; // The accepted role name will be "User" or "Admin".
String *xIDPrimeVirtualIsNewPasswordEncrypted = xIDPrimeVirtualIsNewPasswordEncrypted_example; // Specify true if the provided new user/admin password is encrypted with tenant exchange public key Otherwise false. The default value is false. (optional) (default to False)

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

// Resets the token user/admin password.
[apiInstance iDPrimeVirtualProvisioningV1TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPostWith:body
    tenantId:tenantId
    userId:userId
    tokenId:tokenId
    roleName:roleName
    xIDPrimeVirtualIsNewPasswordEncrypted:xIDPrimeVirtualIsNewPasswordEncrypted
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var body = ; // {{String}} The new User/Admin password of the token. The value would be encrypted with tenant exchange public key if the header flag 'X-IDPrimeVirtual-IsNewPasswordEncrypted' is true. User Password length must be in between 8-25 characters. Admin password must be of 48 characters(hex) length.
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.
var tokenId = tokenId_example; // {{String}} Token Identifier (GUID format).
var roleName = roleName_example; // {{String}} The accepted role name will be "User" or "Admin".
var opts = { 
  'xIDPrimeVirtualIsNewPasswordEncrypted': xIDPrimeVirtualIsNewPasswordEncrypted_example // {{String}} Specify true if the provided new user/admin password is encrypted with tenant exchange public key Otherwise false. The default value is false.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost(bodytenantIduserIdtokenIdroleName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProvisioningApi();
            var body = new String(); // String | The new User/Admin password of the token. The value would be encrypted with tenant exchange public key if the header flag 'X-IDPrimeVirtual-IsNewPasswordEncrypted' is true. User Password length must be in between 8-25 characters. Admin password must be of 48 characters(hex) length.
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.
            var tokenId = tokenId_example;  // String | Token Identifier (GUID format).
            var roleName = roleName_example;  // String | The accepted role name will be "User" or "Admin".
            var xIDPrimeVirtualIsNewPasswordEncrypted = xIDPrimeVirtualIsNewPasswordEncrypted_example;  // String | Specify true if the provided new user/admin password is encrypted with tenant exchange public key Otherwise false. The default value is false. (optional)  (default to False)

            try
            {
                // Resets the token user/admin password.
                apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost(body, tenantId, userId, tokenId, roleName, xIDPrimeVirtualIsNewPasswordEncrypted);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiProvisioningApi();
$body = ; // String | The new User/Admin password of the token. The value would be encrypted with tenant exchange public key if the header flag 'X-IDPrimeVirtual-IsNewPasswordEncrypted' is true. User Password length must be in between 8-25 characters. Admin password must be of 48 characters(hex) length.
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.
$tokenId = tokenId_example; // String | Token Identifier (GUID format).
$roleName = roleName_example; // String | The accepted role name will be "User" or "Admin".
$xIDPrimeVirtualIsNewPasswordEncrypted = xIDPrimeVirtualIsNewPasswordEncrypted_example; // String | Specify true if the provided new user/admin password is encrypted with tenant exchange public key Otherwise false. The default value is false.

try {
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost($body, $tenantId, $userId, $tokenId, $roleName, $xIDPrimeVirtualIsNewPasswordEncrypted);
} catch (Exception $e) {
    echo 'Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProvisioningApi;

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | The new User/Admin password of the token. The value would be encrypted with tenant exchange public key if the header flag 'X-IDPrimeVirtual-IsNewPasswordEncrypted' is true. User Password length must be in between 8-25 characters. Admin password must be of 48 characters(hex) length.
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.
my $tokenId = tokenId_example; # String | Token Identifier (GUID format).
my $roleName = roleName_example; # String | The accepted role name will be "User" or "Admin".
my $xIDPrimeVirtualIsNewPasswordEncrypted = xIDPrimeVirtualIsNewPasswordEncrypted_example; # String | Specify true if the provided new user/admin password is encrypted with tenant exchange public key Otherwise false. The default value is false.

eval { 
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost(body => $body, tenantId => $tenantId, userId => $userId, tokenId => $tokenId, roleName => $roleName, xIDPrimeVirtualIsNewPasswordEncrypted => $xIDPrimeVirtualIsNewPasswordEncrypted);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
body =  # String | The new User/Admin password of the token. The value would be encrypted with tenant exchange public key if the header flag 'X-IDPrimeVirtual-IsNewPasswordEncrypted' is true. User Password length must be in between 8-25 characters. Admin password must be of 48 characters(hex) length.
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.
tokenId = tokenId_example # String | Token Identifier (GUID format).
roleName = roleName_example # String | The accepted role name will be "User" or "Admin".
xIDPrimeVirtualIsNewPasswordEncrypted = xIDPrimeVirtualIsNewPasswordEncrypted_example # String | Specify true if the provided new user/admin password is encrypted with tenant exchange public key Otherwise false. The default value is false. (optional) (default to False)

try: 
    # Resets the token user/admin password.
    api_instance.i_d_prime_virtual_provisioning_v1_tenants_tenant_id_users_user_id_tokens_token_id_role_role_name_reset_pin_post(body, tenantId, userId, tokenId, roleName, xIDPrimeVirtualIsNewPasswordEncrypted=xIDPrimeVirtualIsNewPasswordEncrypted)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdRoleRoleNameResetPinPost: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required
tokenId*
String
Token Identifier (GUID format).
Required
roleName*
String
The accepted role name will be "User" or "Admin".
Required
Header parameters
Name Description
X-IDPrimeVirtual-IsNewPasswordEncrypted
String
Specify true if the provided new user/admin password is encrypted with tenant exchange public key, Otherwise false. The default value is false.
Body parameters
Name Description
body *

Responses

Status: 204 - Success

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User/Token/RoleName Not Found!

Status: 500 - Internal Server Error!


GenerateCertificateSigningRequest

Generate Key Pair and CSR for the user


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/CertificateSigningRequest

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/CertificateSigningRequest"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier.
        String userId = userId_example; // String | User Identifier.
        CSRTemplateInfo body = ; // CSRTemplateInfo  
        try {
            CertificateSigningRequest result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost(tenantId, userId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier.
        String userId = userId_example; // String | User Identifier.
        CSRTemplateInfo body = ; // CSRTemplateInfo 
        try {
            CertificateSigningRequest result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost(tenantId, userId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier.
String *userId = userId_example; // User Identifier.
CSRTemplateInfo *body = ; 

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

// Generate Key Pair and CSR
[apiInstance iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPostWith:tenantId
    userId:userId
    body:body
              completionHandler: ^(CertificateSigningRequest output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier.
var userId = userId_example; // {{String}} User Identifier.

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

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier.
            var userId = userId_example;  // String | User Identifier.
            var body = new CSRTemplateInfo(); // CSRTemplateInfo

            try
            {
                // Generate Key Pair and CSR
                CertificateSigningRequest result = apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost(tenantId, userId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api{{classname}}();
$tenantId = tenantId_example; // String | Tenant Identifier.
$userId = userId_example; // String | User Identifier.
$body = ; // CSRTemplateInfo  

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

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier.
my $userId = userId_example; # String | User Identifier.
my $body = WWW::SwaggerClient::Object::CSRTemplateInfo->new(); # CSRTemplateInfo

eval { 
    my $result = $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost(tenantId => $tenantId, userId => $userId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier.
userId = userId_example # String | User Identifier.
body =  # CSRTemplateInfo 

try: 
    # Generate Key Pair and CSR
    api_response = api_instance.i_d_prime_virtual_provisioning_v10_tenants_tenant_id_users_user_id_certificate_signing_request_post(tenantId, userId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdCertificateSigningRequestPost: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required
Body parameters
Name Description
body
CSRTemplateInfo {
"generateKeyPairAlgorithm": "1.2.840.113549.1.1.1",
"signAlgorithm": "1.2.840.113549.1.1.11",
Note: For Keysecure HSM only signAlgorithm supported is SHA1_RSA(1.2.840.113549.1.1.5).
"subjectDistinguishedName": "string",
Example: CN=John Smith,OU=Test,O=THALES, C=GB
"keyUsage": [int],
Example: [ 128 ]
"extendedKeyUsage": ["string"],
Example: [ "1.3.6.1.5.5.7.3.2" , "1.3.6.1.4.1.311.20.2.2"]
"subjectAlternativeName": "string"
Example: "email:john.smith@thalesgroup.com,otherName:msUPN;UTF8:john.smith@thalesgroup.com"
"rsaKeySize": "string"
Example: "4096"
}
Name Supported Data/Format
SupportedKeyUsage
Decipher Only - 32768
Digital Signature - 128
Non Repudiation - 64
Key Encipherment - 32
Data Encipherment - 16
Key Agreement - 8
Encipher Only - 1
SupportedExtendedKeyUsageOids
Server Auth - "1.3.6.1.5.5.7.3.1"
Client Auth - "1.3.6.1.5.5.7.3.2"
Code Signing - "1.3.6.1.5.5.7.3.3"
Email Protection - "1.3.6.1.5.5.7.3.4"
IpsecEndSystem - "1.3.6.1.5.5.7.3.5"
IpsecTunnel - "1.3.6.1.5.5.7.3.6"
IpsecUser - "1.3.6.1.5.5.7.3.7"
TimeStamping - "1.3.6.1.5.5.7.3.8"
OcspSigning - "1.3.6.1.5.5.7.3.9"
Mac Address - "1.3.6.1.1.1.1.22"
Microsoft Smartcard Logon - "1.3.6.1.4.1.311.20.2.2"
subjectAlternativeName
Inclusion is must in order for a certificate to be issued for the use of "Microsoft Smartcard Logon"
Format:
email:<email>,otherName:msUPN;Key Format for msUPN:<msUPN value>

Note:For now, only UTF8 format is supported for ms-upn in othername field. For any other format or any other key under othername field, the value will be simply ignored while creating CSR.
subjectDistinguishedName
CN is mandatory in subjectDistinguishedName to generate CSR.
Required
rsaKeySize
Use this field to create CSR of different Key size. You may pass 2048, 3072 and 4096.
Note: Default value of this field is 2048.

Responses

Status: 200 - Success - Returns Key Object and CSR

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User/Token not found!

Status: 500 - Internal Server Error!

Status: 501 - Not Implemented!


UpdateCertificate

Update the certificate(created with the help of CSR generated by GenerateCertificateSigningRequest API) in the user's token.


/IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Keys/{KeyId}/Certificate

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "//IDPrimeVirtual/Provisioning/V1.0/Tenants/{tenantId}/Users/{userId}/Tokens/{tokenId}/Keys/{KeyId}/Certificate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvisioningApi;

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

public class ProvisioningApiExample {

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

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

        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        byte[] signedCertificate = signedCertificate_example; // byte[] 
        String keyId = keyId_example; // String | Key Identifier (GUID format).
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut(tenantId, userId, tokenId, signedCertificate, keyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvisioningApi;

public class ProvisioningApiExample {

    public static void main(String[] args) {
        ProvisioningApi apiInstance = new ProvisioningApi();
        String tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
        String userId = userId_example; // String | User Identifier.
        String tokenId = tokenId_example; // String | Token Identifier (GUID format).
        byte[] signedCertificate = signedCertificate_example; // byte[] 
        String keyId = keyId_example; // String | Key Identifier (GUID format).
        try {
            apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut(tenantId, userId, tokenId, signedCertificate, keyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvisioningApi#iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *tenantId = tenantId_example; // Tenant Identifier (GUID format).
String *userId = userId_example; // User Identifier.
String *tokenId = tokenId_example; // Token Identifier (GUID format).
byte[] *signedCertificate = signedCertificate_example; // byte[]
String *keyId = keyId_example; // Key Identifier (GUID format).

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

// UpdateCertificate
[apiInstance iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePutWith:tenantId
    userId:userId
    tokenId:tokenId
    signedCertificate:signedCertificate
    keyId:keyId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ProvisioningApIs = require('provisioning_ap_is');
var defaultClient = ProvisioningApIs.ApiClient.instance;

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

var api = new ProvisioningApIs.ProvisioningApi()
var tenantId = tenantId_example; // {{String}} Tenant Identifier (GUID format).
var userId = userId_example; // {{String}} User Identifier.
var tokenId = tokenId_example; // {{String}} Token Identifier (GUID format).
var opts = { 
  'signedCertificate': signedCertificate_example, // {{byte[]}} 
  'keyId': keyId_example // {{String}} Key Identifier (GUID format).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut(tenantId, userId, tokenId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProvisioningApi();
            var tenantId = tenantId_example;  // String | Tenant Identifier (GUID format).
            var userId = userId_example;  // String | User Identifier.
            var tokenId = tokenId_example;  // String | Token Identifier (GUID format).
            var signedCertificate = signedCertificate_example;  // byte[]
            var keyId = keyId_example;  // String | Key Identifier (GUID format).

            try
            {
                // UpdateCertificate
                apiInstance.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut(tenantId, userId, tokenId, signedCertificate, keyId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvisioningApi.iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut: " + e.Message );
            }
        }
    }
}
<?php require_once(__DIR__ . '/vendor/autoload.php' );
                                                                                              // Configure API key authorization: Bearer
                                                                                              Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api{{classname}}();
$tenantId = tenantId_example; // String | Tenant Identifier (GUID format).
$userId = userId_example; // String | User Identifier.
$tokenId = tokenId_example; // String | Token Identifier (GUID format).
$signedCertificate = signedCertificate_example; // byte[]
$keyId = keyId_example; // String | Key Identifier (GUID format).

try {
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut($tenantId, $userId, $tokenId, $signedCertificate, $keyId);
} catch (Exception $e) {
    echo 'Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProvisioningApi;

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

my $api_instance = WWW::SwaggerClient::ProvisioningApi->new();
my $tenantId = tenantId_example; # String | Tenant Identifier (GUID format).
my $userId = userId_example; # String | User Identifier.
my $tokenId = tokenId_example; # String | Token Identifier (GUID format).
my $signedCertificate = signedCertificate_example; # byte[]
my $keyId = keyId_example; # String | Key Identifier (GUID format).

eval { 
    $api_instance->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut(tenantId => $tenantId, userId => $userId, tokenId => $tokenId, signedCertificate => $signedCertificate, keyId => $keyId);
};
if ($@) {
    warn "Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProvisioningApi()
tenantId = tenantId_example # String | Tenant Identifier (GUID format).
userId = userId_example # String | User Identifier.
tokenId = tokenId_example # String | Token Identifier (GUID format).
signedCertificate = signedCertificate_example # byte[]
keyId = keyId_example # String | Key Identifier (GUID format).

try: 
    # UpdateCertificate
    api_instance.i_d_prime_virtual_provisioning_v10_tenants_tenant_id_users_user_id_tokens_token_id_keys_key_id_certificate_put(tenantId, userId, tokenId, signedCertificate=signedCertificate, keyId=keyId)
except ApiException as e:
    print("Exception when calling ProvisioningApi->iDPrimeVirtualProvisioningV10TenantsTenantIdUsersUserIdTokensTokenIdKeysKeyIdCertificatePut: %s\n" % e)

Parameters

Path parameters
Name Description
tenantId*
String
Tenant Identifier (GUID format).
Required
userId*
String
User Identifier.
Required
tokenId*
String
Token Identifier (GUID format).
Required
keyId*
String
Key Identifier (GUID format).
Required
Note: The value is returned as a part of succcessful response from Generate CSR API. Please refer to GenerateCertificateSigningRequest for more information.
Form parameters
Name Description
signedCertificate
byte[] (binary)

Responses

Status: 204 - Success - No response body.

Status: 400 - Bad Request - Client Side Error!

Status: 401 - Unauthorized Access!

Status: 404 - Tenant/User/Token Not Found!

Status: 405 - Bad Request - Client Side Error!

Status: 409 - Conflict

Status: 500 - Internal Server Error!