uCentral Security API

APITokens

createApiKey

Retrieve all the APIKeys for a given user UUID


/apiKey/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/apiKey/{uuid}" \
 -d '{
  "lastUse" : 6,
  "salt" : "salt",
  "apiKey" : "apiKey",
  "rights" : {
    "acls" : [ {
      "access" : "read",
      "service" : "service"
    }, {
      "access" : "read",
      "service" : "service"
    } ]
  },
  "userUuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "description" : "description",
  "expiresOn" : 0,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.APITokensApi;

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

public class APITokensApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        APITokensApi apiInstance = new APITokensApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ApiKeyEntry apiKeyEntry = ; // ApiKeyEntry | 

        try {
            apiInstance.createApiKey(uuid, apiKeyEntry);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#createApiKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.APITokensApi;

public class APITokensApiExample {
    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ApiKeyEntry apiKeyEntry = ; // ApiKeyEntry | 

        try {
            apiInstance.createApiKey(uuid, apiKeyEntry);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#createApiKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
APITokensApi *apiInstance = [[APITokensApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
ApiKeyEntry *apiKeyEntry = ; //  (optional)

// Retrieve all the APIKeys for a given user UUID
[apiInstance createApiKeyWith:uuid
    apiKeyEntry:apiKeyEntry
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.APITokensApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'apiKeyEntry':  // {ApiKeyEntry} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createApiKey(uuid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createApiKeyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new APITokensApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var apiKeyEntry = new ApiKeyEntry(); // ApiKeyEntry |  (optional) 

            try {
                // Retrieve all the APIKeys for a given user UUID
                apiInstance.createApiKey(uuid, apiKeyEntry);
            } catch (Exception e) {
                Debug.Print("Exception when calling APITokensApi.createApiKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\APITokensApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$apiKeyEntry = ; // ApiKeyEntry | 

try {
    $api_instance->createApiKey($uuid, $apiKeyEntry);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->createApiKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::APITokensApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::APITokensApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $apiKeyEntry = WWW::OPenAPIClient::Object::ApiKeyEntry->new(); # ApiKeyEntry | 

eval {
    $api_instance->createApiKey(uuid => $uuid, apiKeyEntry => $apiKeyEntry);
};
if ($@) {
    warn "Exception when calling APITokensApi->createApiKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.APITokensApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
apiKeyEntry =  # ApiKeyEntry |  (optional)

try:
    # Retrieve all the APIKeys for a given user UUID
    api_instance.create_api_key(uuid, apiKeyEntry=apiKeyEntry)
except ApiException as e:
    print("Exception when calling APITokensApi->createApiKey: %s\n" % e)
extern crate APITokensApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let apiKeyEntry = ; // ApiKeyEntry

    let mut context = APITokensApi::Context::default();
    let result = client.createApiKey(uuid, apiKeyEntry, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
apiKeyEntry

Responses


deleteApiKey

Retrieve all the APIKeys for a given user UUID


/apiKey/{uuid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/apiKey/{uuid}?keyUuid=keyUuid_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.APITokensApi;

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

public class APITokensApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        APITokensApi apiInstance = new APITokensApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String keyUuid = keyUuid_example; // String | 

        try {
            deleteUser_204_response result = apiInstance.deleteApiKey(uuid, keyUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#deleteApiKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.APITokensApi;

public class APITokensApiExample {
    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String keyUuid = keyUuid_example; // String | 

        try {
            deleteUser_204_response result = apiInstance.deleteApiKey(uuid, keyUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#deleteApiKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
APITokensApi *apiInstance = [[APITokensApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
String *keyUuid = keyUuid_example; //  (default to null)

// Retrieve all the APIKeys for a given user UUID
[apiInstance deleteApiKeyWith:uuid
    keyUuid:keyUuid
              completionHandler: ^(deleteUser_204_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.APITokensApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var keyUuid = keyUuid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteApiKey(uuid, keyUuid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteApiKeyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new APITokensApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var keyUuid = keyUuid_example;  // String |  (default to null)

            try {
                // Retrieve all the APIKeys for a given user UUID
                deleteUser_204_response result = apiInstance.deleteApiKey(uuid, keyUuid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling APITokensApi.deleteApiKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\APITokensApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$keyUuid = keyUuid_example; // String | 

try {
    $result = $api_instance->deleteApiKey($uuid, $keyUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->deleteApiKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::APITokensApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::APITokensApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $keyUuid = keyUuid_example; # String | 

eval {
    my $result = $api_instance->deleteApiKey(uuid => $uuid, keyUuid => $keyUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APITokensApi->deleteApiKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.APITokensApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
keyUuid = keyUuid_example # String |  (default to null)

try:
    # Retrieve all the APIKeys for a given user UUID
    api_response = api_instance.delete_api_key(uuid, keyUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APITokensApi->deleteApiKey: %s\n" % e)
extern crate APITokensApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let keyUuid = keyUuid_example; // String

    let mut context = APITokensApi::Context::default();
    let result = client.deleteApiKey(uuid, keyUuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
keyUuid*
String
Required

Responses


getApiKeyList

Retrieve all the APIKeys for a given user UUID


/apiKey/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/apiKey/{uuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.APITokensApi;

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

public class APITokensApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        APITokensApi apiInstance = new APITokensApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.getApiKeyList(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#getApiKeyList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.APITokensApi;

public class APITokensApiExample {
    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.getApiKeyList(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#getApiKeyList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
APITokensApi *apiInstance = [[APITokensApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve all the APIKeys for a given user UUID
[apiInstance getApiKeyListWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.APITokensApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getApiKeyList(uuid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getApiKeyListExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new APITokensApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve all the APIKeys for a given user UUID
                apiInstance.getApiKeyList(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling APITokensApi.getApiKeyList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\APITokensApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $api_instance->getApiKeyList($uuid);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->getApiKeyList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::APITokensApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::APITokensApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getApiKeyList(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling APITokensApi->getApiKeyList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.APITokensApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve all the APIKeys for a given user UUID
    api_instance.get_api_key_list(uuid)
except ApiException as e:
    print("Exception when calling APITokensApi->getApiKeyList: %s\n" % e)
extern crate APITokensApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = APITokensApi::Context::default();
    let result = client.getApiKeyList(uuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


modifyApiKey

Retrieve all the APIKeys for a given user UUID


/apiKey/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/apiKey/{uuid}?name=name_example" \
 -d '{
  "lastUse" : 6,
  "salt" : "salt",
  "apiKey" : "apiKey",
  "rights" : {
    "acls" : [ {
      "access" : "read",
      "service" : "service"
    }, {
      "access" : "read",
      "service" : "service"
    } ]
  },
  "userUuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "description" : "description",
  "expiresOn" : 0,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.APITokensApi;

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

public class APITokensApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        APITokensApi apiInstance = new APITokensApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String name = name_example; // String | 
        ApiKeyEntry apiKeyEntry = ; // ApiKeyEntry | 

        try {
            apiInstance.modifyApiKey(uuid, name, apiKeyEntry);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#modifyApiKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.APITokensApi;

public class APITokensApiExample {
    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String name = name_example; // String | 
        ApiKeyEntry apiKeyEntry = ; // ApiKeyEntry | 

        try {
            apiInstance.modifyApiKey(uuid, name, apiKeyEntry);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#modifyApiKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
APITokensApi *apiInstance = [[APITokensApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
String *name = name_example; //  (default to null)
ApiKeyEntry *apiKeyEntry = ; //  (optional)

// Retrieve all the APIKeys for a given user UUID
[apiInstance modifyApiKeyWith:uuid
    name:name
    apiKeyEntry:apiKeyEntry
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.APITokensApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var name = name_example; // {String} 
var opts = {
  'apiKeyEntry':  // {ApiKeyEntry} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifyApiKey(uuid, name, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyApiKeyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new APITokensApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var name = name_example;  // String |  (default to null)
            var apiKeyEntry = new ApiKeyEntry(); // ApiKeyEntry |  (optional) 

            try {
                // Retrieve all the APIKeys for a given user UUID
                apiInstance.modifyApiKey(uuid, name, apiKeyEntry);
            } catch (Exception e) {
                Debug.Print("Exception when calling APITokensApi.modifyApiKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\APITokensApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$name = name_example; // String | 
$apiKeyEntry = ; // ApiKeyEntry | 

try {
    $api_instance->modifyApiKey($uuid, $name, $apiKeyEntry);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->modifyApiKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::APITokensApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::APITokensApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $name = name_example; # String | 
my $apiKeyEntry = WWW::OPenAPIClient::Object::ApiKeyEntry->new(); # ApiKeyEntry | 

eval {
    $api_instance->modifyApiKey(uuid => $uuid, name => $name, apiKeyEntry => $apiKeyEntry);
};
if ($@) {
    warn "Exception when calling APITokensApi->modifyApiKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.APITokensApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
name = name_example # String |  (default to null)
apiKeyEntry =  # ApiKeyEntry |  (optional)

try:
    # Retrieve all the APIKeys for a given user UUID
    api_instance.modify_api_key(uuid, name, apiKeyEntry=apiKeyEntry)
except ApiException as e:
    print("Exception when calling APITokensApi->modifyApiKey: %s\n" % e)
extern crate APITokensApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let name = name_example; // String
    let apiKeyEntry = ; // ApiKeyEntry

    let mut context = APITokensApi::Context::default();
    let result = client.modifyApiKey(uuid, name, apiKeyEntry, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
apiKeyEntry

Query parameters
Name Description
name*
String
Required

Responses


Authentication

getAccessToken

Get access token - to be used as Bearer token header for all other API requests.


/oauth2

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/oauth2?newPassword=newPassword_example&forgotPassword=true&requirements=true&resendMFACode=true&completeMFAChallenge=true&grant_type=refresh_token" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AuthenticationApi apiInstance = new AuthenticationApi();
        GetAccessTokenRequest getAccessTokenRequest = ; // GetAccessTokenRequest | 
        String newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
        Boolean forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean requirements = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean resendMFACode = true; // Boolean | 
        Boolean completeMFAChallenge = true; // Boolean | 
        String grantType = refresh_token; // String | 

        try {
            getAccessToken_200_response result = apiInstance.getAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getAccessToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthenticationApi;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        GetAccessTokenRequest getAccessTokenRequest = ; // GetAccessTokenRequest | 
        String newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
        Boolean forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean requirements = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean resendMFACode = true; // Boolean | 
        Boolean completeMFAChallenge = true; // Boolean | 
        String grantType = refresh_token; // String | 

        try {
            getAccessToken_200_response result = apiInstance.getAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getAccessToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];
GetAccessTokenRequest *getAccessTokenRequest = ; // 
String *newPassword = newPassword_example; // used when a user is trying to change her password. This will be the new password. (optional) (default to null)
Boolean *forgotPassword = true; // A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
Boolean *requirements = true; // A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
Boolean *resendMFACode = true; //  (optional) (default to null)
Boolean *completeMFAChallenge = true; //  (optional) (default to null)
String *grantType = refresh_token; //  (optional) (default to null)

// Get access token - to be used as Bearer token header for all other API requests.
[apiInstance getAccessTokenWith:getAccessTokenRequest
    newPassword:newPassword
    forgotPassword:forgotPassword
    requirements:requirements
    resendMFACode:resendMFACode
    completeMFAChallenge:completeMFAChallenge
    grantType:grantType
              completionHandler: ^(getAccessToken_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.AuthenticationApi()
var getAccessTokenRequest = ; // {GetAccessTokenRequest} 
var opts = {
  'newPassword': newPassword_example, // {String} used when a user is trying to change her password. This will be the new password.
  'forgotPassword': true, // {Boolean} A user forgot her password. She needs to present her e-mail address in the userId and set this to true
  'requirements': true, // {Boolean} A user forgot her password. She needs to present her e-mail address in the userId and set this to true
  'resendMFACode': true, // {Boolean} 
  'completeMFAChallenge': true, // {Boolean} 
  'grantType': refresh_token // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccessToken(getAccessTokenRequest, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAccessTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AuthenticationApi();
            var getAccessTokenRequest = new GetAccessTokenRequest(); // GetAccessTokenRequest | 
            var newPassword = newPassword_example;  // String | used when a user is trying to change her password. This will be the new password. (optional)  (default to null)
            var forgotPassword = true;  // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional)  (default to null)
            var requirements = true;  // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional)  (default to null)
            var resendMFACode = true;  // Boolean |  (optional)  (default to null)
            var completeMFAChallenge = true;  // Boolean |  (optional)  (default to null)
            var grantType = refresh_token;  // String |  (optional)  (default to null)

            try {
                // Get access token - to be used as Bearer token header for all other API requests.
                getAccessToken_200_response result = apiInstance.getAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthenticationApi.getAccessToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthenticationApi();
$getAccessTokenRequest = ; // GetAccessTokenRequest | 
$newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
$forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
$requirements = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
$resendMFACode = true; // Boolean | 
$completeMFAChallenge = true; // Boolean | 
$grantType = refresh_token; // String | 

try {
    $result = $api_instance->getAccessToken($getAccessTokenRequest, $newPassword, $forgotPassword, $requirements, $resendMFACode, $completeMFAChallenge, $grantType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->getAccessToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthenticationApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthenticationApi->new();
my $getAccessTokenRequest = WWW::OPenAPIClient::Object::GetAccessTokenRequest->new(); # GetAccessTokenRequest | 
my $newPassword = newPassword_example; # String | used when a user is trying to change her password. This will be the new password.
my $forgotPassword = true; # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
my $requirements = true; # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
my $resendMFACode = true; # Boolean | 
my $completeMFAChallenge = true; # Boolean | 
my $grantType = refresh_token; # String | 

eval {
    my $result = $api_instance->getAccessToken(getAccessTokenRequest => $getAccessTokenRequest, newPassword => $newPassword, forgotPassword => $forgotPassword, requirements => $requirements, resendMFACode => $resendMFACode, completeMFAChallenge => $completeMFAChallenge, grantType => $grantType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->getAccessToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AuthenticationApi()
getAccessTokenRequest =  # GetAccessTokenRequest | 
newPassword = newPassword_example # String | used when a user is trying to change her password. This will be the new password. (optional) (default to null)
forgotPassword = true # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
requirements = true # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
resendMFACode = true # Boolean |  (optional) (default to null)
completeMFAChallenge = true # Boolean |  (optional) (default to null)
grantType = refresh_token # String |  (optional) (default to null)

try:
    # Get access token - to be used as Bearer token header for all other API requests.
    api_response = api_instance.get_access_token(getAccessTokenRequest, newPassword=newPassword, forgotPassword=forgotPassword, requirements=requirements, resendMFACode=resendMFACode, completeMFAChallenge=completeMFAChallenge, grantType=grantType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->getAccessToken: %s\n" % e)
extern crate AuthenticationApi;

pub fn main() {
    let getAccessTokenRequest = ; // GetAccessTokenRequest
    let newPassword = newPassword_example; // String
    let forgotPassword = true; // Boolean
    let requirements = true; // Boolean
    let resendMFACode = true; // Boolean
    let completeMFAChallenge = true; // Boolean
    let grantType = refresh_token; // String

    let mut context = AuthenticationApi::Context::default();
    let result = client.getAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
getAccessTokenRequest *

User id and password

Query parameters
Name Description
newPassword
String
used when a user is trying to change her password. This will be the new password.
forgotPassword
Boolean
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
requirements
Boolean
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
resendMFACode
Boolean
completeMFAChallenge
Boolean
grant_type
String

Responses


getSubAccessToken

Get access token - to be used as Bearer token header for all other API requests.


/suboauth2

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/suboauth2?newPassword=newPassword_example&forgotPassword=true&requirements=true&resendMFACode=true&completeMFAChallenge=true&grant_type=refresh_token" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AuthenticationApi apiInstance = new AuthenticationApi();
        GetAccessTokenRequest getAccessTokenRequest = ; // GetAccessTokenRequest | 
        String newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
        Boolean forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean requirements = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean resendMFACode = true; // Boolean | 
        Boolean completeMFAChallenge = true; // Boolean | 
        String grantType = refresh_token; // String | 

        try {
            getAccessToken_200_response result = apiInstance.getSubAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getSubAccessToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthenticationApi;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        GetAccessTokenRequest getAccessTokenRequest = ; // GetAccessTokenRequest | 
        String newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
        Boolean forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean requirements = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
        Boolean resendMFACode = true; // Boolean | 
        Boolean completeMFAChallenge = true; // Boolean | 
        String grantType = refresh_token; // String | 

        try {
            getAccessToken_200_response result = apiInstance.getSubAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getSubAccessToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];
GetAccessTokenRequest *getAccessTokenRequest = ; // 
String *newPassword = newPassword_example; // used when a user is trying to change her password. This will be the new password. (optional) (default to null)
Boolean *forgotPassword = true; // A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
Boolean *requirements = true; // A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
Boolean *resendMFACode = true; //  (optional) (default to null)
Boolean *completeMFAChallenge = true; //  (optional) (default to null)
String *grantType = refresh_token; //  (optional) (default to null)

// Get access token - to be used as Bearer token header for all other API requests.
[apiInstance getSubAccessTokenWith:getAccessTokenRequest
    newPassword:newPassword
    forgotPassword:forgotPassword
    requirements:requirements
    resendMFACode:resendMFACode
    completeMFAChallenge:completeMFAChallenge
    grantType:grantType
              completionHandler: ^(getAccessToken_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.AuthenticationApi()
var getAccessTokenRequest = ; // {GetAccessTokenRequest} 
var opts = {
  'newPassword': newPassword_example, // {String} used when a user is trying to change her password. This will be the new password.
  'forgotPassword': true, // {Boolean} A user forgot her password. She needs to present her e-mail address in the userId and set this to true
  'requirements': true, // {Boolean} A user forgot her password. She needs to present her e-mail address in the userId and set this to true
  'resendMFACode': true, // {Boolean} 
  'completeMFAChallenge': true, // {Boolean} 
  'grantType': refresh_token // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSubAccessToken(getAccessTokenRequest, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSubAccessTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AuthenticationApi();
            var getAccessTokenRequest = new GetAccessTokenRequest(); // GetAccessTokenRequest | 
            var newPassword = newPassword_example;  // String | used when a user is trying to change her password. This will be the new password. (optional)  (default to null)
            var forgotPassword = true;  // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional)  (default to null)
            var requirements = true;  // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional)  (default to null)
            var resendMFACode = true;  // Boolean |  (optional)  (default to null)
            var completeMFAChallenge = true;  // Boolean |  (optional)  (default to null)
            var grantType = refresh_token;  // String |  (optional)  (default to null)

            try {
                // Get access token - to be used as Bearer token header for all other API requests.
                getAccessToken_200_response result = apiInstance.getSubAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthenticationApi.getSubAccessToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthenticationApi();
$getAccessTokenRequest = ; // GetAccessTokenRequest | 
$newPassword = newPassword_example; // String | used when a user is trying to change her password. This will be the new password.
$forgotPassword = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
$requirements = true; // Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
$resendMFACode = true; // Boolean | 
$completeMFAChallenge = true; // Boolean | 
$grantType = refresh_token; // String | 

try {
    $result = $api_instance->getSubAccessToken($getAccessTokenRequest, $newPassword, $forgotPassword, $requirements, $resendMFACode, $completeMFAChallenge, $grantType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->getSubAccessToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthenticationApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthenticationApi->new();
my $getAccessTokenRequest = WWW::OPenAPIClient::Object::GetAccessTokenRequest->new(); # GetAccessTokenRequest | 
my $newPassword = newPassword_example; # String | used when a user is trying to change her password. This will be the new password.
my $forgotPassword = true; # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
my $requirements = true; # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true
my $resendMFACode = true; # Boolean | 
my $completeMFAChallenge = true; # Boolean | 
my $grantType = refresh_token; # String | 

eval {
    my $result = $api_instance->getSubAccessToken(getAccessTokenRequest => $getAccessTokenRequest, newPassword => $newPassword, forgotPassword => $forgotPassword, requirements => $requirements, resendMFACode => $resendMFACode, completeMFAChallenge => $completeMFAChallenge, grantType => $grantType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->getSubAccessToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AuthenticationApi()
getAccessTokenRequest =  # GetAccessTokenRequest | 
newPassword = newPassword_example # String | used when a user is trying to change her password. This will be the new password. (optional) (default to null)
forgotPassword = true # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
requirements = true # Boolean | A user forgot her password. She needs to present her e-mail address in the userId and set this to true (optional) (default to null)
resendMFACode = true # Boolean |  (optional) (default to null)
completeMFAChallenge = true # Boolean |  (optional) (default to null)
grantType = refresh_token # String |  (optional) (default to null)

try:
    # Get access token - to be used as Bearer token header for all other API requests.
    api_response = api_instance.get_sub_access_token(getAccessTokenRequest, newPassword=newPassword, forgotPassword=forgotPassword, requirements=requirements, resendMFACode=resendMFACode, completeMFAChallenge=completeMFAChallenge, grantType=grantType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->getSubAccessToken: %s\n" % e)
extern crate AuthenticationApi;

pub fn main() {
    let getAccessTokenRequest = ; // GetAccessTokenRequest
    let newPassword = newPassword_example; // String
    let forgotPassword = true; // Boolean
    let requirements = true; // Boolean
    let resendMFACode = true; // Boolean
    let completeMFAChallenge = true; // Boolean
    let grantType = refresh_token; // String

    let mut context = AuthenticationApi::Context::default();
    let result = client.getSubAccessToken(getAccessTokenRequest, newPassword, forgotPassword, requirements, resendMFACode, completeMFAChallenge, grantType, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
getAccessTokenRequest *

User id and password

Query parameters
Name Description
newPassword
String
used when a user is trying to change her password. This will be the new password.
forgotPassword
Boolean
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
requirements
Boolean
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
resendMFACode
Boolean
completeMFAChallenge
Boolean
grant_type
String

Responses


removeAccessToken

Revoke a token.


/oauth2/{token}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/oauth2/{token}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AuthenticationApi apiInstance = new AuthenticationApi();
        String token = token_example; // String | 

        try {
            Success result = apiInstance.removeAccessToken(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#removeAccessToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthenticationApi;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        String token = token_example; // String | 

        try {
            Success result = apiInstance.removeAccessToken(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#removeAccessToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];
String *token = token_example; //  (default to null)

// Revoke a token.
[apiInstance removeAccessTokenWith:token
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.AuthenticationApi()
var token = token_example; // {String} 

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

namespace Example
{
    public class removeAccessTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AuthenticationApi();
            var token = token_example;  // String |  (default to null)

            try {
                // Revoke a token.
                Success result = apiInstance.removeAccessToken(token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthenticationApi.removeAccessToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthenticationApi();
$token = token_example; // String | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthenticationApi->new();
my $token = token_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AuthenticationApi()
token = token_example # String |  (default to null)

try:
    # Revoke a token.
    api_response = api_instance.remove_access_token(token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->removeAccessToken: %s\n" % e)
extern crate AuthenticationApi;

pub fn main() {
    let token = token_example; // String

    let mut context = AuthenticationApi::Context::default();
    let result = client.removeAccessToken(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
token*
String
Required

Responses


removeSubAccessToken

Revoke a token.


/suboauth2/{token}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/suboauth2/{token}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AuthenticationApi apiInstance = new AuthenticationApi();
        String token = token_example; // String | 

        try {
            Success result = apiInstance.removeSubAccessToken(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#removeSubAccessToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthenticationApi;

public class AuthenticationApiExample {
    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        String token = token_example; // String | 

        try {
            Success result = apiInstance.removeSubAccessToken(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#removeSubAccessToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];
String *token = token_example; //  (default to null)

// Revoke a token.
[apiInstance removeSubAccessTokenWith:token
              completionHandler: ^(Success output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.AuthenticationApi()
var token = token_example; // {String} 

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

namespace Example
{
    public class removeSubAccessTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AuthenticationApi();
            var token = token_example;  // String |  (default to null)

            try {
                // Revoke a token.
                Success result = apiInstance.removeSubAccessToken(token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthenticationApi.removeSubAccessToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthenticationApi();
$token = token_example; // String | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthenticationApi->new();
my $token = token_example; # String | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AuthenticationApi()
token = token_example # String |  (default to null)

try:
    # Revoke a token.
    api_response = api_instance.remove_sub_access_token(token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->removeSubAccessToken: %s\n" % e)
extern crate AuthenticationApi;

pub fn main() {
    let token = token_example; // String

    let mut context = AuthenticationApi::Context::default();
    let result = client.removeSubAccessToken(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
token*
String
Required

Responses


Avatar

createAvatar

Create an avatar associated with a user ID.


/avatar/{id}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: image/jpeg,image/png,image/svg+xml" \
 "https://localhost:16001/api/v1/avatar/{id}" \
 -d 'Custom MIME type example not yet supported: image/jpeg' \
 -d 'Custom MIME type example not yet supported: image/png' \
 -d 'Custom MIME type example not yet supported: image/svg+xml'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvatarApi;

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

public class AvatarApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AvatarApi apiInstance = new AvatarApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        File body = BINARY_DATA_HERE; // File | 

        try {
            deleteUser_204_response result = apiInstance.createAvatar(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvatarApi#createAvatar");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvatarApi;

public class AvatarApiExample {
    public static void main(String[] args) {
        AvatarApi apiInstance = new AvatarApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        File body = BINARY_DATA_HERE; // File | 

        try {
            deleteUser_204_response result = apiInstance.createAvatar(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvatarApi#createAvatar");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AvatarApi *apiInstance = [[AvatarApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
File *body = BINARY_DATA_HERE; // 

// Create an avatar associated with a user ID.
[apiInstance createAvatarWith:id
    body:body
              completionHandler: ^(deleteUser_204_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.AvatarApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var body = BINARY_DATA_HERE; // {File} 

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

namespace Example
{
    public class createAvatarExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AvatarApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var body = BINARY_DATA_HERE;  // File | 

            try {
                // Create an avatar associated with a user ID.
                deleteUser_204_response result = apiInstance.createAvatar(id, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvatarApi.createAvatar: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvatarApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$body = BINARY_DATA_HERE; // File | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvatarApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $body = WWW::OPenAPIClient::Object::File->new(); # File | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AvatarApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
body = BINARY_DATA_HERE # File | 

try:
    # Create an avatar associated with a user ID.
    api_response = api_instance.create_avatar(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvatarApi->createAvatar: %s\n" % e)
extern crate AvatarApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let body = BINARY_DATA_HERE; // File

    let mut context = AvatarApi::Context::default();
    let result = client.createAvatar(id, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required
Body parameters
Name Description
body *

User id and password

Responses


deleteAvatar

Remove an avatar associated with a user ID.


/avatar/{id}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/avatar/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvatarApi;

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

public class AvatarApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AvatarApi apiInstance = new AvatarApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            deleteUser_204_response result = apiInstance.deleteAvatar(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvatarApi#deleteAvatar");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvatarApi;

public class AvatarApiExample {
    public static void main(String[] args) {
        AvatarApi apiInstance = new AvatarApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            deleteUser_204_response result = apiInstance.deleteAvatar(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvatarApi#deleteAvatar");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AvatarApi *apiInstance = [[AvatarApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Remove an avatar associated with a user ID.
[apiInstance deleteAvatarWith:id
              completionHandler: ^(deleteUser_204_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.AvatarApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteAvatarExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AvatarApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Remove an avatar associated with a user ID.
                deleteUser_204_response result = apiInstance.deleteAvatar(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvatarApi.deleteAvatar: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvatarApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvatarApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AvatarApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Remove an avatar associated with a user ID.
    api_response = api_instance.delete_avatar(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvatarApi->deleteAvatar: %s\n" % e)
extern crate AvatarApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = AvatarApi::Context::default();
    let result = client.deleteAvatar(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required

Responses


getAvatar

Retrieve the avatar associated with a user ID.


/avatar/{id}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: image/jpeg,image/png,image/svg+xml,application/json" \
 "https://localhost:16001/api/v1/avatar/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AvatarApi;

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

public class AvatarApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AvatarApi apiInstance = new AvatarApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            File result = apiInstance.getAvatar(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvatarApi#getAvatar");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AvatarApi;

public class AvatarApiExample {
    public static void main(String[] args) {
        AvatarApi apiInstance = new AvatarApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            File result = apiInstance.getAvatar(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AvatarApi#getAvatar");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AvatarApi *apiInstance = [[AvatarApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve the avatar associated with a user ID.
[apiInstance getAvatarWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.AvatarApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class getAvatarExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AvatarApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve the avatar associated with a user ID.
                File result = apiInstance.getAvatar(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AvatarApi.getAvatar: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AvatarApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AvatarApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AvatarApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve the avatar associated with a user ID.
    api_response = api_instance.get_avatar(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AvatarApi->getAvatar: %s\n" % e)
extern crate AvatarApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = AvatarApi::Context::default();
    let result = client.getAvatar(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required

Responses


MFA

getMFS

Retrieve the cyrrent setting for MFA


/submfa

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16001/api/v1/submfa"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MFAApi;

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

public class MFAApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        MFAApi apiInstance = new MFAApi();

        try {
            apiInstance.getMFS();
        } catch (ApiException e) {
            System.err.println("Exception when calling MFAApi#getMFS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MFAApi;

public class MFAApiExample {
    public static void main(String[] args) {
        MFAApi apiInstance = new MFAApi();

        try {
            apiInstance.getMFS();
        } catch (ApiException e) {
            System.err.println("Exception when calling MFAApi#getMFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
MFAApi *apiInstance = [[MFAApi alloc] init];

// Retrieve the cyrrent setting for MFA
[apiInstance getMFSWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.MFAApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getMFS(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new MFAApi();

            try {
                // Retrieve the cyrrent setting for MFA
                apiInstance.getMFS();
            } catch (Exception e) {
                Debug.Print("Exception when calling MFAApi.getMFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MFAApi();

try {
    $api_instance->getMFS();
} catch (Exception $e) {
    echo 'Exception when calling MFAApi->getMFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MFAApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MFAApi->new();

eval {
    $api_instance->getMFS();
};
if ($@) {
    warn "Exception when calling MFAApi->getMFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.MFAApi()

try:
    # Retrieve the cyrrent setting for MFA
    api_instance.get_mfs()
except ApiException as e:
    print("Exception when calling MFAApi->getMFS: %s\n" % e)
extern crate MFAApi;

pub fn main() {

    let mut context = MFAApi::Context::default();
    let result = client.getMFS(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


modifyMFS

Retrieve the cyrrent setting for MFA


/submfa

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/submfa?startValidation=true&completeValidation=true&challengeCode=challengeCode_example" \
 -d '{
  "sms" : "sms",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "disabled",
  "email" : "email"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MFAApi;

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

public class MFAApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        MFAApi apiInstance = new MFAApi();
        Boolean startValidation = true; // Boolean | 
        Boolean completeValidation = true; // Boolean | 
        String challengeCode = challengeCode_example; // String | 
        SubMfaConfig subMfaConfig = ; // SubMfaConfig | 

        try {
            apiInstance.modifyMFS(startValidation, completeValidation, challengeCode, subMfaConfig);
        } catch (ApiException e) {
            System.err.println("Exception when calling MFAApi#modifyMFS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MFAApi;

public class MFAApiExample {
    public static void main(String[] args) {
        MFAApi apiInstance = new MFAApi();
        Boolean startValidation = true; // Boolean | 
        Boolean completeValidation = true; // Boolean | 
        String challengeCode = challengeCode_example; // String | 
        SubMfaConfig subMfaConfig = ; // SubMfaConfig | 

        try {
            apiInstance.modifyMFS(startValidation, completeValidation, challengeCode, subMfaConfig);
        } catch (ApiException e) {
            System.err.println("Exception when calling MFAApi#modifyMFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
MFAApi *apiInstance = [[MFAApi alloc] init];
Boolean *startValidation = true; //  (optional) (default to null)
Boolean *completeValidation = true; //  (optional) (default to null)
String *challengeCode = challengeCode_example; //  (optional) (default to null)
SubMfaConfig *subMfaConfig = ; //  (optional)

// Retrieve the cyrrent setting for MFA
[apiInstance modifyMFSWith:startValidation
    completeValidation:completeValidation
    challengeCode:challengeCode
    subMfaConfig:subMfaConfig
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.MFAApi()
var opts = {
  'startValidation': true, // {Boolean} 
  'completeValidation': true, // {Boolean} 
  'challengeCode': challengeCode_example, // {String} 
  'subMfaConfig':  // {SubMfaConfig} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifyMFS(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyMFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new MFAApi();
            var startValidation = true;  // Boolean |  (optional)  (default to null)
            var completeValidation = true;  // Boolean |  (optional)  (default to null)
            var challengeCode = challengeCode_example;  // String |  (optional)  (default to null)
            var subMfaConfig = new SubMfaConfig(); // SubMfaConfig |  (optional) 

            try {
                // Retrieve the cyrrent setting for MFA
                apiInstance.modifyMFS(startValidation, completeValidation, challengeCode, subMfaConfig);
            } catch (Exception e) {
                Debug.Print("Exception when calling MFAApi.modifyMFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MFAApi();
$startValidation = true; // Boolean | 
$completeValidation = true; // Boolean | 
$challengeCode = challengeCode_example; // String | 
$subMfaConfig = ; // SubMfaConfig | 

try {
    $api_instance->modifyMFS($startValidation, $completeValidation, $challengeCode, $subMfaConfig);
} catch (Exception $e) {
    echo 'Exception when calling MFAApi->modifyMFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MFAApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MFAApi->new();
my $startValidation = true; # Boolean | 
my $completeValidation = true; # Boolean | 
my $challengeCode = challengeCode_example; # String | 
my $subMfaConfig = WWW::OPenAPIClient::Object::SubMfaConfig->new(); # SubMfaConfig | 

eval {
    $api_instance->modifyMFS(startValidation => $startValidation, completeValidation => $completeValidation, challengeCode => $challengeCode, subMfaConfig => $subMfaConfig);
};
if ($@) {
    warn "Exception when calling MFAApi->modifyMFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.MFAApi()
startValidation = true # Boolean |  (optional) (default to null)
completeValidation = true # Boolean |  (optional) (default to null)
challengeCode = challengeCode_example # String |  (optional) (default to null)
subMfaConfig =  # SubMfaConfig |  (optional)

try:
    # Retrieve the cyrrent setting for MFA
    api_instance.modify_mfs(startValidation=startValidation, completeValidation=completeValidation, challengeCode=challengeCode, subMfaConfig=subMfaConfig)
except ApiException as e:
    print("Exception when calling MFAApi->modifyMFS: %s\n" % e)
extern crate MFAApi;

pub fn main() {
    let startValidation = true; // Boolean
    let completeValidation = true; // Boolean
    let challengeCode = challengeCode_example; // String
    let subMfaConfig = ; // SubMfaConfig

    let mut context = MFAApi::Context::default();
    let result = client.modifyMFS(startValidation, completeValidation, challengeCode, subMfaConfig, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
subMfaConfig

Query parameters
Name Description
startValidation
Boolean
completeValidation
Boolean
challengeCode
String

Responses


Messaging

send a test SMS

Send test email with the system.


/sms

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/sms?validateNumber=true&completeValidation=true&validationCode=validationCode_example" \
 -d '{
  "from" : "from",
  "to" : "to",
  "text" : "text"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MessagingApi;

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

public class MessagingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        MessagingApi apiInstance = new MessagingApi();
        Boolean validateNumber = true; // Boolean | 
        Boolean completeValidation = true; // Boolean | 
        String validationCode = validationCode_example; // String | 
        SMSInfo sMSInfo = ; // SMSInfo | 

        try {
            deleteUser_204_response result = apiInstance.send a test SMS(validateNumber, completeValidation, validationCode, sMSInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagingApi#send a test SMS");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MessagingApi;

public class MessagingApiExample {
    public static void main(String[] args) {
        MessagingApi apiInstance = new MessagingApi();
        Boolean validateNumber = true; // Boolean | 
        Boolean completeValidation = true; // Boolean | 
        String validationCode = validationCode_example; // String | 
        SMSInfo sMSInfo = ; // SMSInfo | 

        try {
            deleteUser_204_response result = apiInstance.send a test SMS(validateNumber, completeValidation, validationCode, sMSInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagingApi#send a test SMS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
MessagingApi *apiInstance = [[MessagingApi alloc] init];
Boolean *validateNumber = true; //  (optional) (default to null)
Boolean *completeValidation = true; //  (optional) (default to null)
String *validationCode = validationCode_example; //  (optional) (default to null)
SMSInfo *sMSInfo = ; //  (optional)

// Send test email with the system.
[apiInstance send a test SMSWith:validateNumber
    completeValidation:completeValidation
    validationCode:validationCode
    sMSInfo:sMSInfo
              completionHandler: ^(deleteUser_204_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.MessagingApi()
var opts = {
  'validateNumber': true, // {Boolean} 
  'completeValidation': true, // {Boolean} 
  'validationCode': validationCode_example, // {String} 
  'sMSInfo':  // {SMSInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.send a test SMS(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class send a test SMSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new MessagingApi();
            var validateNumber = true;  // Boolean |  (optional)  (default to null)
            var completeValidation = true;  // Boolean |  (optional)  (default to null)
            var validationCode = validationCode_example;  // String |  (optional)  (default to null)
            var sMSInfo = new SMSInfo(); // SMSInfo |  (optional) 

            try {
                // Send test email with the system.
                deleteUser_204_response result = apiInstance.send a test SMS(validateNumber, completeValidation, validationCode, sMSInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MessagingApi.send a test SMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MessagingApi();
$validateNumber = true; // Boolean | 
$completeValidation = true; // Boolean | 
$validationCode = validationCode_example; // String | 
$sMSInfo = ; // SMSInfo | 

try {
    $result = $api_instance->send a test SMS($validateNumber, $completeValidation, $validationCode, $sMSInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagingApi->send a test SMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MessagingApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MessagingApi->new();
my $validateNumber = true; # Boolean | 
my $completeValidation = true; # Boolean | 
my $validationCode = validationCode_example; # String | 
my $sMSInfo = WWW::OPenAPIClient::Object::SMSInfo->new(); # SMSInfo | 

eval {
    my $result = $api_instance->send a test SMS(validateNumber => $validateNumber, completeValidation => $completeValidation, validationCode => $validationCode, sMSInfo => $sMSInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagingApi->send a test SMS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.MessagingApi()
validateNumber = true # Boolean |  (optional) (default to null)
completeValidation = true # Boolean |  (optional) (default to null)
validationCode = validationCode_example # String |  (optional) (default to null)
sMSInfo =  # SMSInfo |  (optional)

try:
    # Send test email with the system.
    api_response = api_instance.send_a_test_sms(validateNumber=validateNumber, completeValidation=completeValidation, validationCode=validationCode, sMSInfo=sMSInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->send a test SMS: %s\n" % e)
extern crate MessagingApi;

pub fn main() {
    let validateNumber = true; // Boolean
    let completeValidation = true; // Boolean
    let validationCode = validationCode_example; // String
    let sMSInfo = ; // SMSInfo

    let mut context = MessagingApi::Context::default();
    let result = client.send a test SMS(validateNumber, completeValidation, validationCode, sMSInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
sMSInfo

The requested message

Query parameters
Name Description
validateNumber
Boolean
completeValidation
Boolean
validationCode
String

Responses


send a test email

Send test email with the system.


/email

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/email" \
 -d '{
  "subject" : "subject",
  "recipients" : [ "recipients", "recipients" ],
  "from" : "from",
  "text" : "text"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MessagingApi;

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

public class MessagingApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        MessagingApi apiInstance = new MessagingApi();
        EMailInfo eMailInfo = ; // EMailInfo | 

        try {
            deleteUser_204_response result = apiInstance.send a test email(eMailInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagingApi#send a test email");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MessagingApi;

public class MessagingApiExample {
    public static void main(String[] args) {
        MessagingApi apiInstance = new MessagingApi();
        EMailInfo eMailInfo = ; // EMailInfo | 

        try {
            deleteUser_204_response result = apiInstance.send a test email(eMailInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagingApi#send a test email");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
MessagingApi *apiInstance = [[MessagingApi alloc] init];
EMailInfo *eMailInfo = ; //  (optional)

// Send test email with the system.
[apiInstance send a test emailWith:eMailInfo
              completionHandler: ^(deleteUser_204_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.MessagingApi()
var opts = {
  'eMailInfo':  // {EMailInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.send a test email(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class send a test emailExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new MessagingApi();
            var eMailInfo = new EMailInfo(); // EMailInfo |  (optional) 

            try {
                // Send test email with the system.
                deleteUser_204_response result = apiInstance.send a test email(eMailInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MessagingApi.send a test email: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MessagingApi();
$eMailInfo = ; // EMailInfo | 

try {
    $result = $api_instance->send a test email($eMailInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagingApi->send a test email: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MessagingApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MessagingApi->new();
my $eMailInfo = WWW::OPenAPIClient::Object::EMailInfo->new(); # EMailInfo | 

eval {
    my $result = $api_instance->send a test email(eMailInfo => $eMailInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagingApi->send a test email: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.MessagingApi()
eMailInfo =  # EMailInfo |  (optional)

try:
    # Send test email with the system.
    api_response = api_instance.send_a_test_email(eMailInfo=eMailInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->send a test email: %s\n" % e)
extern crate MessagingApi;

pub fn main() {
    let eMailInfo = ; // EMailInfo

    let mut context = MessagingApi::Context::default();
    let result = client.send a test email(eMailInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
eMailInfo

The requested message

Responses


Preferences

getUserPreferences

Get the list of recorded preferences for a user


/userPreferences

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/userPreferences"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PreferencesApi;

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

public class PreferencesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PreferencesApi apiInstance = new PreferencesApi();

        try {
            apiInstance.getUserPreferences();
        } catch (ApiException e) {
            System.err.println("Exception when calling PreferencesApi#getUserPreferences");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PreferencesApi;

public class PreferencesApiExample {
    public static void main(String[] args) {
        PreferencesApi apiInstance = new PreferencesApi();

        try {
            apiInstance.getUserPreferences();
        } catch (ApiException e) {
            System.err.println("Exception when calling PreferencesApi#getUserPreferences");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PreferencesApi *apiInstance = [[PreferencesApi alloc] init];

// Get the list of recorded preferences for a user
[apiInstance getUserPreferencesWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.PreferencesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getUserPreferences(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserPreferencesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PreferencesApi();

            try {
                // Get the list of recorded preferences for a user
                apiInstance.getUserPreferences();
            } catch (Exception e) {
                Debug.Print("Exception when calling PreferencesApi.getUserPreferences: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PreferencesApi();

try {
    $api_instance->getUserPreferences();
} catch (Exception $e) {
    echo 'Exception when calling PreferencesApi->getUserPreferences: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PreferencesApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PreferencesApi->new();

eval {
    $api_instance->getUserPreferences();
};
if ($@) {
    warn "Exception when calling PreferencesApi->getUserPreferences: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PreferencesApi()

try:
    # Get the list of recorded preferences for a user
    api_instance.get_user_preferences()
except ApiException as e:
    print("Exception when calling PreferencesApi->getUserPreferences: %s\n" % e)
extern crate PreferencesApi;

pub fn main() {

    let mut context = PreferencesApi::Context::default();
    let result = client.getUserPreferences(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


setUserPreferences

Set the list of recorded preferences for a user


/userPreferences

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/userPreferences" \
 -d '{
  "data" : [ {
    "tag" : "tag",
    "value" : "value"
  }, {
    "tag" : "tag",
    "value" : "value"
  } ],
  "modified" : 0
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PreferencesApi;

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

public class PreferencesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PreferencesApi apiInstance = new PreferencesApi();
        Preferences preferences = ; // Preferences | 

        try {
            apiInstance.setUserPreferences(preferences);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreferencesApi#setUserPreferences");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PreferencesApi;

public class PreferencesApiExample {
    public static void main(String[] args) {
        PreferencesApi apiInstance = new PreferencesApi();
        Preferences preferences = ; // Preferences | 

        try {
            apiInstance.setUserPreferences(preferences);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreferencesApi#setUserPreferences");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PreferencesApi *apiInstance = [[PreferencesApi alloc] init];
Preferences *preferences = ; //  (optional)

// Set the list of recorded preferences for a user
[apiInstance setUserPreferencesWith:preferences
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.PreferencesApi()
var opts = {
  'preferences':  // {Preferences} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setUserPreferences(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class setUserPreferencesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PreferencesApi();
            var preferences = new Preferences(); // Preferences |  (optional) 

            try {
                // Set the list of recorded preferences for a user
                apiInstance.setUserPreferences(preferences);
            } catch (Exception e) {
                Debug.Print("Exception when calling PreferencesApi.setUserPreferences: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PreferencesApi();
$preferences = ; // Preferences | 

try {
    $api_instance->setUserPreferences($preferences);
} catch (Exception $e) {
    echo 'Exception when calling PreferencesApi->setUserPreferences: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PreferencesApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PreferencesApi->new();
my $preferences = WWW::OPenAPIClient::Object::Preferences->new(); # Preferences | 

eval {
    $api_instance->setUserPreferences(preferences => $preferences);
};
if ($@) {
    warn "Exception when calling PreferencesApi->setUserPreferences: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PreferencesApi()
preferences =  # Preferences |  (optional)

try:
    # Set the list of recorded preferences for a user
    api_instance.set_user_preferences(preferences=preferences)
except ApiException as e:
    print("Exception when calling PreferencesApi->setUserPreferences: %s\n" % e)
extern crate PreferencesApi;

pub fn main() {
    let preferences = ; // Preferences

    let mut context = PreferencesApi::Context::default();
    let result = client.setUserPreferences(preferences, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
preferences

Setting the list of preferences

Responses


Security

getSecurituProfiles

Retrieve the list of security profiles for a specific service type.


/securityProfiles

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/securityProfiles?offset=56&limit=56&filter=filter_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

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

public class SecurityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results

        try {
            apiInstance.getSecurituProfiles(offset, limit, filter);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getSecurituProfiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results

        try {
            apiInstance.getSecurituProfiles(offset, limit, filter);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getSecurituProfiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
Integer *offset = 56; // Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
Integer *limit = 56; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
String *filter = filter_example; // Filter the results (optional) (default to null)

// Retrieve the list of security profiles for a specific service type.
[apiInstance getSecurituProfilesWith:offset
    limit:limit
    filter:filter
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SecurityApi()
var opts = {
  'offset': 56, // {Integer} Pagination start (starts at 1. If not specified, 1 is assumed)
  'limit': 56, // {Integer} Maximum number of entries to return (if absent, no limit is assumed)
  'filter': filter_example // {String} Filter the results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSecurituProfiles(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSecurituProfilesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var offset = 56;  // Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional)  (default to null)
            var limit = 56;  // Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)
            var filter = filter_example;  // String | Filter the results (optional)  (default to null)

            try {
                // Retrieve the list of security profiles for a specific service type.
                apiInstance.getSecurituProfiles(offset, limit, filter);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getSecurituProfiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
$limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
$filter = filter_example; // String | Filter the results

try {
    $api_instance->getSecurituProfiles($offset, $limit, $filter);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getSecurituProfiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $offset = 56; # Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
my $limit = 56; # Integer | Maximum number of entries to return (if absent, no limit is assumed)
my $filter = filter_example; # String | Filter the results

eval {
    $api_instance->getSecurituProfiles(offset => $offset, limit => $limit, filter => $filter);
};
if ($@) {
    warn "Exception when calling SecurityApi->getSecurituProfiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
offset = 56 # Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
limit = 56 # Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
filter = filter_example # String | Filter the results (optional) (default to null)

try:
    # Retrieve the list of security profiles for a specific service type.
    api_instance.get_securitu_profiles(offset=offset, limit=limit, filter=filter)
except ApiException as e:
    print("Exception when calling SecurityApi->getSecurituProfiles: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String

    let mut context = SecurityApi::Context::default();
    let result = client.getSecurituProfiles(offset, limit, filter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
offset
Integer
Pagination start (starts at 1. If not specified, 1 is assumed)
limit
Integer
Maximum number of entries to return (if absent, no limit is assumed)
filter
String
Filter the results

Responses


getSystemServices

Retrieve the basic system information. This information is used between services only.


/systemServices

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/systemServices"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

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

public class SecurityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();

        try {
            apiInstance.getSystemServices();
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getSystemServices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();

        try {
            apiInstance.getSystemServices();
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getSystemServices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];

// Retrieve the basic system information. This information is used between services only.
[apiInstance getSystemServicesWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SecurityApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSystemServices(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSystemServicesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SecurityApi();

            try {
                // Retrieve the basic system information. This information is used between services only.
                apiInstance.getSystemServices();
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getSystemServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();

try {
    $api_instance->getSystemServices();
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getSystemServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();

eval {
    $api_instance->getSystemServices();
};
if ($@) {
    warn "Exception when calling SecurityApi->getSystemServices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()

try:
    # Retrieve the basic system information. This information is used between services only.
    api_instance.get_system_services()
except ApiException as e:
    print("Exception when calling SecurityApi->getSystemServices: %s\n" % e)
extern crate SecurityApi;

pub fn main() {

    let mut context = SecurityApi::Context::default();
    let result = client.getSystemServices(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getTotpQrCode

Retrieve the Authenticator QR Code


/totp

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: image/svg+xml,application/json" \
 "https://localhost:16001/api/v1/totp?reset=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

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

public class SecurityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        Boolean reset = true; // Boolean | 

        try {
            File result = apiInstance.getTotpQrCode(reset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getTotpQrCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        Boolean reset = true; // Boolean | 

        try {
            File result = apiInstance.getTotpQrCode(reset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getTotpQrCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
Boolean *reset = true; //  (optional) (default to false)

// Retrieve the Authenticator QR Code
[apiInstance getTotpQrCodeWith:reset
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SecurityApi()
var opts = {
  'reset': true // {Boolean} 
};

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

namespace Example
{
    public class getTotpQrCodeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var reset = true;  // Boolean |  (optional)  (default to false)

            try {
                // Retrieve the Authenticator QR Code
                File result = apiInstance.getTotpQrCode(reset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.getTotpQrCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$reset = true; // Boolean | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $reset = true; # Boolean | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
reset = true # Boolean |  (optional) (default to false)

try:
    # Retrieve the Authenticator QR Code
    api_response = api_instance.get_totp_qr_code(reset=reset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getTotpQrCode: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let reset = true; // Boolean

    let mut context = SecurityApi::Context::default();
    let result = client.getTotpQrCode(reset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
reset
Boolean

Responses


sendToptTestCode

Send the first security code to validate your setup


/totp

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/totp?value=789&index=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

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

public class SecurityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        Long value = 789; // Long | 
        Long index = 789; // Long | 

        try {
            sendToptTestCode_200_response result = apiInstance.sendToptTestCode(value, index);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#sendToptTestCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        Long value = 789; // Long | 
        Long index = 789; // Long | 

        try {
            sendToptTestCode_200_response result = apiInstance.sendToptTestCode(value, index);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#sendToptTestCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
Long *value = 789; //  (default to null)
Long *index = 789; //  (default to null)

// Send the first security code to validate your setup
[apiInstance sendToptTestCodeWith:value
    index:index
              completionHandler: ^(sendToptTestCode_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SecurityApi()
var value = 789; // {Long} 
var index = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendToptTestCode(value, index, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class sendToptTestCodeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var value = 789;  // Long |  (default to null)
            var index = 789;  // Long |  (default to null)

            try {
                // Send the first security code to validate your setup
                sendToptTestCode_200_response result = apiInstance.sendToptTestCode(value, index);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.sendToptTestCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$value = 789; // Long | 
$index = 789; // Long | 

try {
    $result = $api_instance->sendToptTestCode($value, $index);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->sendToptTestCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $value = 789; # Long | 
my $index = 789; # Long | 

eval {
    my $result = $api_instance->sendToptTestCode(value => $value, index => $index);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->sendToptTestCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
value = 789 # Long |  (default to null)
index = 789 # Long |  (default to null)

try:
    # Send the first security code to validate your setup
    api_response = api_instance.send_topt_test_code(value, index)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->sendToptTestCode: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let value = 789; // Long
    let index = 789; // Long

    let mut context = SecurityApi::Context::default();
    let result = client.sendToptTestCode(value, index, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
value*
Long (int64)
Required
index*
Long (int64)
Required

Responses


validateApiKey

Allows an application to validate an API Key.


/validateApiKey

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/validateApiKey?token=token_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

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

public class SecurityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String token = token_example; // String | 

        try {
            apiInstance.validateApiKey(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#validateApiKey");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String token = token_example; // String | 

        try {
            apiInstance.validateApiKey(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#validateApiKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *token = token_example; //  (default to null)

// Allows an application to validate an API Key.
[apiInstance validateApiKeyWith:token
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SecurityApi()
var token = token_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateApiKey(token, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class validateApiKeyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var token = token_example;  // String |  (default to null)

            try {
                // Allows an application to validate an API Key.
                apiInstance.validateApiKey(token);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.validateApiKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$token = token_example; // String | 

try {
    $api_instance->validateApiKey($token);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->validateApiKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $token = token_example; # String | 

eval {
    $api_instance->validateApiKey(token => $token);
};
if ($@) {
    warn "Exception when calling SecurityApi->validateApiKey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
token = token_example # String |  (default to null)

try:
    # Allows an application to validate an API Key.
    api_instance.validate_api_key(token)
except ApiException as e:
    print("Exception when calling SecurityApi->validateApiKey: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let token = token_example; // String

    let mut context = SecurityApi::Context::default();
    let result = client.validateApiKey(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
token*
String
Required

Responses


validateSubToken

Allows any microservice to validate a token and get security policy for a specific user.


/validateSubToken

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/validateSubToken?token=token_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

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

public class SecurityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String token = token_example; // String | 

        try {
            apiInstance.validateSubToken(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#validateSubToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String token = token_example; // String | 

        try {
            apiInstance.validateSubToken(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#validateSubToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *token = token_example; //  (default to null)

// Allows any microservice to validate a token and get security policy for a specific user.
[apiInstance validateSubTokenWith:token
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SecurityApi()
var token = token_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateSubToken(token, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class validateSubTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var token = token_example;  // String |  (default to null)

            try {
                // Allows any microservice to validate a token and get security policy for a specific user.
                apiInstance.validateSubToken(token);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.validateSubToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$token = token_example; // String | 

try {
    $api_instance->validateSubToken($token);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->validateSubToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $token = token_example; # String | 

eval {
    $api_instance->validateSubToken(token => $token);
};
if ($@) {
    warn "Exception when calling SecurityApi->validateSubToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
token = token_example # String |  (default to null)

try:
    # Allows any microservice to validate a token and get security policy for a specific user.
    api_instance.validate_sub_token(token)
except ApiException as e:
    print("Exception when calling SecurityApi->validateSubToken: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let token = token_example; // String

    let mut context = SecurityApi::Context::default();
    let result = client.validateSubToken(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
token*
String
Required

Responses


validateToken

Allows any microservice to validate a token and get security policy for a specific user.


/validateToken

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/validateToken?token=token_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SecurityApi;

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

public class SecurityApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SecurityApi apiInstance = new SecurityApi();
        String token = token_example; // String | 

        try {
            apiInstance.validateToken(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#validateToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SecurityApi;

public class SecurityApiExample {
    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String token = token_example; // String | 

        try {
            apiInstance.validateToken(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#validateToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SecurityApi *apiInstance = [[SecurityApi alloc] init];
String *token = token_example; //  (default to null)

// Allows any microservice to validate a token and get security policy for a specific user.
[apiInstance validateTokenWith:token
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SecurityApi()
var token = token_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateToken(token, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class validateTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SecurityApi();
            var token = token_example;  // String |  (default to null)

            try {
                // Allows any microservice to validate a token and get security policy for a specific user.
                apiInstance.validateToken(token);
            } catch (Exception e) {
                Debug.Print("Exception when calling SecurityApi.validateToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SecurityApi();
$token = token_example; // String | 

try {
    $api_instance->validateToken($token);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->validateToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SecurityApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SecurityApi->new();
my $token = token_example; # String | 

eval {
    $api_instance->validateToken(token => $token);
};
if ($@) {
    warn "Exception when calling SecurityApi->validateToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SecurityApi()
token = token_example # String |  (default to null)

try:
    # Allows any microservice to validate a token and get security policy for a specific user.
    api_instance.validate_token(token)
except ApiException as e:
    print("Exception when calling SecurityApi->validateToken: %s\n" % e)
extern crate SecurityApi;

pub fn main() {
    let token = token_example; // String

    let mut context = SecurityApi::Context::default();
    let result = client.validateToken(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
token*
String
Required

Responses


SubscriberRegistration

modifySignup

modify the signup command in play


/signup

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/signup?signupUUID=38400000-8cf0-11bd-b23e-10b96e4ef00d&operation=operation_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

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

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String operation = operation_example; // String | 
        ModifySignupRequest modifySignupRequest = ; // ModifySignupRequest | 

        try {
            deleteUser_204_response result = apiInstance.modifySignup(signupUUID, operation, modifySignupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#modifySignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String operation = operation_example; // String | 
        ModifySignupRequest modifySignupRequest = ; // ModifySignupRequest | 

        try {
            deleteUser_204_response result = apiInstance.modifySignup(signupUUID, operation, modifySignupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#modifySignup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
UUID *signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
String *operation = operation_example; //  (default to null)
ModifySignupRequest *modifySignupRequest = ; //  (optional)

// modify the signup command in play
[apiInstance modifySignupWith:signupUUID
    operation:operation
    modifySignupRequest:modifySignupRequest
              completionHandler: ^(deleteUser_204_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SubscriberRegistrationApi()
var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var operation = operation_example; // {String} 
var opts = {
  'modifySignupRequest':  // {ModifySignupRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.modifySignup(signupUUID, operation, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifySignupExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberRegistrationApi();
            var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operation = operation_example;  // String |  (default to null)
            var modifySignupRequest = new ModifySignupRequest(); // ModifySignupRequest |  (optional) 

            try {
                // modify the signup command in play
                deleteUser_204_response result = apiInstance.modifySignup(signupUUID, operation, modifySignupRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.modifySignup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberRegistrationApi();
$signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operation = operation_example; // String | 
$modifySignupRequest = ; // ModifySignupRequest | 

try {
    $result = $api_instance->modifySignup($signupUUID, $operation, $modifySignupRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->modifySignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberRegistrationApi->new();
my $signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operation = operation_example; # String | 
my $modifySignupRequest = WWW::OPenAPIClient::Object::ModifySignupRequest->new(); # ModifySignupRequest | 

eval {
    my $result = $api_instance->modifySignup(signupUUID => $signupUUID, operation => $operation, modifySignupRequest => $modifySignupRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->modifySignup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberRegistrationApi()
signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operation = operation_example # String |  (default to null)
modifySignupRequest =  # ModifySignupRequest |  (optional)

try:
    # modify the signup command in play
    api_response = api_instance.modify_signup(signupUUID, operation, modifySignupRequest=modifySignupRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->modifySignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let operation = operation_example; // String
    let modifySignupRequest = ; // ModifySignupRequest

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.modifySignup(signupUUID, operation, modifySignupRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
modifySignupRequest

Query parameters
Name Description
signupUUID*
UUID (uuid)
Required
operation*
String
Required

Responses


postSignup

This call allows a new subscriber to register themselves and their devices.


/signup

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/signup?email=email_example&signupUUID=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

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

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.postSignup(email, signupUUID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#postSignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.postSignup(email, signupUUID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#postSignup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
String *email = email_example; //  (default to null)
UUID *signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// This call allows a new subscriber to register themselves and their devices.
[apiInstance postSignupWith:email
    signupUUID:signupUUID
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SubscriberRegistrationApi()
var email = email_example; // {String} 
var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postSignup(email, signupUUID, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postSignupExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscriberRegistrationApi();
            var email = email_example;  // String |  (default to null)
            var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // This call allows a new subscriber to register themselves and their devices.
                apiInstance.postSignup(email, signupUUID);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.postSignup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriberRegistrationApi();
$email = email_example; // String | 
$signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $api_instance->postSignup($email, $signupUUID);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->postSignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriberRegistrationApi->new();
my $email = email_example; # String | 
my $signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->postSignup(email => $email, signupUUID => $signupUUID);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->postSignup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscriberRegistrationApi()
email = email_example # String |  (default to null)
signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # This call allows a new subscriber to register themselves and their devices.
    api_instance.post_signup(email, signupUUID)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->postSignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let email = email_example; // String
    let signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.postSignup(email, signupUUID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
email*
String (email)
Required
signupUUID*
UUID (uuid)
Required

Responses


Subscribers

createSubUser

Create a single user.


/subuser/{id}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/subuser/{id}?email_verification=true" \
 -d '{
  "lastLogin" : 1,
  "lastEmailCheck" : 5,
  "notes" : [ {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 2
  }, {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 2
  } ],
  "description" : "description",
  "validationDate" : 0,
  "locale" : "locale",
  "validated" : true,
  "securityPolicyChange" : 7,
  "waitingForEmailCheck" : true,
  "modified" : 9,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "signupUUID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "email" : "email",
  "validationURI" : "validationURI",
  "owner" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "created" : 6,
  "userTypeProprietaryInfo" : {
    "mobiles" : [ {
      "number" : "number",
      "verified" : true,
      "primary" : true
    }, {
      "number" : "number",
      "verified" : true,
      "primary" : true
    } ],
    "mfa" : {
      "method" : "sms",
      "enabled" : true
    },
    "authenticatorSecret" : "authenticatorSecret"
  },
  "avatar" : "https://openapi-generator.tech",
  "securityPolicy" : "securityPolicy",
  "suspended" : true,
  "changePassword" : true,
  "currentPassword" : "currentPassword",
  "blackListed" : true,
  "name" : "name",
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "lastPasswordChange" : 5,
  "lastPasswords" : [ "lastPasswords", "lastPasswords" ],
  "oauthType" : "internal",
  "validationEmail" : "validationEmail",
  "userRole" : "root",
  "oauthUserInfo" : "oauthUserInfo",
  "currentLoginURI" : "currentLoginURI"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscribersApi;

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

public class SubscribersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscribersApi apiInstance = new SubscribersApi();
        Long id = 789; // Long | 
        Boolean emailVerification = true; // Boolean | 
        UserInfo userInfo = ; // UserInfo | 

        try {
            apiInstance.createSubUser(id, emailVerification, userInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#createSubUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscribersApi;

public class SubscribersApiExample {
    public static void main(String[] args) {
        SubscribersApi apiInstance = new SubscribersApi();
        Long id = 789; // Long | 
        Boolean emailVerification = true; // Boolean | 
        UserInfo userInfo = ; // UserInfo | 

        try {
            apiInstance.createSubUser(id, emailVerification, userInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#createSubUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscribersApi *apiInstance = [[SubscribersApi alloc] init];
Long *id = 789; //  (default to null)
Boolean *emailVerification = true; //  (optional) (default to null)
UserInfo *userInfo = ; //  (optional)

// Create a single user.
[apiInstance createSubUserWith:id
    emailVerification:emailVerification
    userInfo:userInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SubscribersApi()
var id = 789; // {Long} 
var opts = {
  'emailVerification': true, // {Boolean} 
  'userInfo':  // {UserInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createSubUser(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createSubUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscribersApi();
            var id = 789;  // Long |  (default to null)
            var emailVerification = true;  // Boolean |  (optional)  (default to null)
            var userInfo = new UserInfo(); // UserInfo |  (optional) 

            try {
                // Create a single user.
                apiInstance.createSubUser(id, emailVerification, userInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscribersApi.createSubUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscribersApi();
$id = 789; // Long | 
$emailVerification = true; // Boolean | 
$userInfo = ; // UserInfo | 

try {
    $api_instance->createSubUser($id, $emailVerification, $userInfo);
} catch (Exception $e) {
    echo 'Exception when calling SubscribersApi->createSubUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscribersApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscribersApi->new();
my $id = 789; # Long | 
my $emailVerification = true; # Boolean | 
my $userInfo = WWW::OPenAPIClient::Object::UserInfo->new(); # UserInfo | 

eval {
    $api_instance->createSubUser(id => $id, emailVerification => $emailVerification, userInfo => $userInfo);
};
if ($@) {
    warn "Exception when calling SubscribersApi->createSubUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscribersApi()
id = 789 # Long |  (default to null)
emailVerification = true # Boolean |  (optional) (default to null)
userInfo =  # UserInfo |  (optional)

try:
    # Create a single user.
    api_instance.create_sub_user(id, emailVerification=emailVerification, userInfo=userInfo)
except ApiException as e:
    print("Exception when calling SubscribersApi->createSubUser: %s\n" % e)
extern crate SubscribersApi;

pub fn main() {
    let id = 789; // Long
    let emailVerification = true; // Boolean
    let userInfo = ; // UserInfo

    let mut context = SubscribersApi::Context::default();
    let result = client.createSubUser(id, emailVerification, userInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Body parameters
Name Description
userInfo

User details (some fields are ignored during creation)

Query parameters
Name Description
email_verification
Boolean

Responses


deleteSubUser

Delete a single user.


/subuser/{id}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/subuser/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscribersApi;

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

public class SubscribersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscribersApi apiInstance = new SubscribersApi();
        Long id = 789; // Long | 

        try {
            deleteUser_204_response result = apiInstance.deleteSubUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#deleteSubUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscribersApi;

public class SubscribersApiExample {
    public static void main(String[] args) {
        SubscribersApi apiInstance = new SubscribersApi();
        Long id = 789; // Long | 

        try {
            deleteUser_204_response result = apiInstance.deleteSubUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#deleteSubUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscribersApi *apiInstance = [[SubscribersApi alloc] init];
Long *id = 789; //  (default to null)

// Delete a single user.
[apiInstance deleteSubUserWith:id
              completionHandler: ^(deleteUser_204_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SubscribersApi()
var id = 789; // {Long} 

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

namespace Example
{
    public class deleteSubUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscribersApi();
            var id = 789;  // Long |  (default to null)

            try {
                // Delete a single user.
                deleteUser_204_response result = apiInstance.deleteSubUser(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscribersApi.deleteSubUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscribersApi();
$id = 789; // Long | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscribersApi->new();
my $id = 789; # Long | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscribersApi()
id = 789 # Long |  (default to null)

try:
    # Delete a single user.
    api_response = api_instance.delete_sub_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscribersApi->deleteSubUser: %s\n" % e)
extern crate SubscribersApi;

pub fn main() {
    let id = 789; // Long

    let mut context = SubscribersApi::Context::default();
    let result = client.deleteSubUser(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses


getSubUser

Retrieve the information for a single user.


/subuser/{id}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/subuser/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscribersApi;

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

public class SubscribersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscribersApi apiInstance = new SubscribersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.getSubUser(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#getSubUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscribersApi;

public class SubscribersApiExample {
    public static void main(String[] args) {
        SubscribersApi apiInstance = new SubscribersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.getSubUser(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#getSubUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscribersApi *apiInstance = [[SubscribersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve the information for a single user.
[apiInstance getSubUserWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SubscribersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSubUser(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSubUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscribersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve the information for a single user.
                apiInstance.getSubUser(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscribersApi.getSubUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscribersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $api_instance->getSubUser($id);
} catch (Exception $e) {
    echo 'Exception when calling SubscribersApi->getSubUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscribersApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscribersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getSubUser(id => $id);
};
if ($@) {
    warn "Exception when calling SubscribersApi->getSubUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscribersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve the information for a single user.
    api_instance.get_sub_user(id)
except ApiException as e:
    print("Exception when calling SubscribersApi->getSubUser: %s\n" % e)
extern crate SubscribersApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = SubscribersApi::Context::default();
    let result = client.getSubUser(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required

Responses


getSubUsers

Retrieve a list of existing users as well as some information about them.


/subusers

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/subusers?offset=789&limit=789&filter=filter_example&idOnly=true&select=id1,id2,id3,id4,id5&nameSearch=nameSearch_example&emailSearch=emailSearch_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscribersApi;

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

public class SubscribersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscribersApi apiInstance = new SubscribersApi();
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        String filter = filter_example; // String | Selecting this option means the newest record will be returned. Use limit to select how many.
        Boolean idOnly = true; // Boolean | Return only the ids.
        String select = id1,id2,id3,id4,id5; // String | Return only the ids.
        String nameSearch = nameSearch_example; // String | Name matching
        String emailSearch = emailSearch_example; // String | Name matching

        try {
            apiInstance.getSubUsers(offset, limit, filter, idOnly, select, nameSearch, emailSearch);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#getSubUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscribersApi;

public class SubscribersApiExample {
    public static void main(String[] args) {
        SubscribersApi apiInstance = new SubscribersApi();
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        String filter = filter_example; // String | Selecting this option means the newest record will be returned. Use limit to select how many.
        Boolean idOnly = true; // Boolean | Return only the ids.
        String select = id1,id2,id3,id4,id5; // String | Return only the ids.
        String nameSearch = nameSearch_example; // String | Name matching
        String emailSearch = emailSearch_example; // String | Name matching

        try {
            apiInstance.getSubUsers(offset, limit, filter, idOnly, select, nameSearch, emailSearch);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#getSubUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscribersApi *apiInstance = [[SubscribersApi alloc] init];
Long *offset = 789; //  (optional) (default to null)
Long *limit = 789; //  (optional) (default to null)
String *filter = filter_example; // Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)
Boolean *idOnly = true; // Return only the ids. (optional) (default to null)
String *select = id1,id2,id3,id4,id5; // Return only the ids. (optional) (default to null)
String *nameSearch = nameSearch_example; // Name matching (optional) (default to null)
String *emailSearch = emailSearch_example; // Name matching (optional) (default to null)

// Retrieve a list of existing users as well as some information about them.
[apiInstance getSubUsersWith:offset
    limit:limit
    filter:filter
    idOnly:idOnly
    select:select
    nameSearch:nameSearch
    emailSearch:emailSearch
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SubscribersApi()
var opts = {
  'offset': 789, // {Long} 
  'limit': 789, // {Long} 
  'filter': filter_example, // {String} Selecting this option means the newest record will be returned. Use limit to select how many.
  'idOnly': true, // {Boolean} Return only the ids.
  'select': id1,id2,id3,id4,id5, // {String} Return only the ids.
  'nameSearch': nameSearch_example, // {String} Name matching
  'emailSearch': emailSearch_example // {String} Name matching
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSubUsers(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSubUsersExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscribersApi();
            var offset = 789;  // Long |  (optional)  (default to null)
            var limit = 789;  // Long |  (optional)  (default to null)
            var filter = filter_example;  // String | Selecting this option means the newest record will be returned. Use limit to select how many. (optional)  (default to null)
            var idOnly = true;  // Boolean | Return only the ids. (optional)  (default to null)
            var select = id1,id2,id3,id4,id5;  // String | Return only the ids. (optional)  (default to null)
            var nameSearch = nameSearch_example;  // String | Name matching (optional)  (default to null)
            var emailSearch = emailSearch_example;  // String | Name matching (optional)  (default to null)

            try {
                // Retrieve a list of existing users as well as some information about them.
                apiInstance.getSubUsers(offset, limit, filter, idOnly, select, nameSearch, emailSearch);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscribersApi.getSubUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscribersApi();
$offset = 789; // Long | 
$limit = 789; // Long | 
$filter = filter_example; // String | Selecting this option means the newest record will be returned. Use limit to select how many.
$idOnly = true; // Boolean | Return only the ids.
$select = id1,id2,id3,id4,id5; // String | Return only the ids.
$nameSearch = nameSearch_example; // String | Name matching
$emailSearch = emailSearch_example; // String | Name matching

try {
    $api_instance->getSubUsers($offset, $limit, $filter, $idOnly, $select, $nameSearch, $emailSearch);
} catch (Exception $e) {
    echo 'Exception when calling SubscribersApi->getSubUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscribersApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscribersApi->new();
my $offset = 789; # Long | 
my $limit = 789; # Long | 
my $filter = filter_example; # String | Selecting this option means the newest record will be returned. Use limit to select how many.
my $idOnly = true; # Boolean | Return only the ids.
my $select = id1,id2,id3,id4,id5; # String | Return only the ids.
my $nameSearch = nameSearch_example; # String | Name matching
my $emailSearch = emailSearch_example; # String | Name matching

eval {
    $api_instance->getSubUsers(offset => $offset, limit => $limit, filter => $filter, idOnly => $idOnly, select => $select, nameSearch => $nameSearch, emailSearch => $emailSearch);
};
if ($@) {
    warn "Exception when calling SubscribersApi->getSubUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscribersApi()
offset = 789 # Long |  (optional) (default to null)
limit = 789 # Long |  (optional) (default to null)
filter = filter_example # String | Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)
idOnly = true # Boolean | Return only the ids. (optional) (default to null)
select = id1,id2,id3,id4,id5 # String | Return only the ids. (optional) (default to null)
nameSearch = nameSearch_example # String | Name matching (optional) (default to null)
emailSearch = emailSearch_example # String | Name matching (optional) (default to null)

try:
    # Retrieve a list of existing users as well as some information about them.
    api_instance.get_sub_users(offset=offset, limit=limit, filter=filter, idOnly=idOnly, select=select, nameSearch=nameSearch, emailSearch=emailSearch)
except ApiException as e:
    print("Exception when calling SubscribersApi->getSubUsers: %s\n" % e)
extern crate SubscribersApi;

pub fn main() {
    let offset = 789; // Long
    let limit = 789; // Long
    let filter = filter_example; // String
    let idOnly = true; // Boolean
    let select = id1,id2,id3,id4,id5; // String
    let nameSearch = nameSearch_example; // String
    let emailSearch = emailSearch_example; // String

    let mut context = SubscribersApi::Context::default();
    let result = client.getSubUsers(offset, limit, filter, idOnly, select, nameSearch, emailSearch, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
offset
Long (int64)
limit
Long (int64)
filter
String
Selecting this option means the newest record will be returned. Use limit to select how many.
idOnly
Boolean
Return only the ids.
select
String
Return only the ids.
nameSearch
String
Name matching
emailSearch
String
Name matching

Responses


updateSubUser

Modify a single user.


/subuser/{id}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/subuser/{id}?email_verification=true&forgotPassword=true&resetMFA=true" \
 -d '{
  "lastLogin" : 1,
  "lastEmailCheck" : 5,
  "notes" : [ {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 2
  }, {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 2
  } ],
  "description" : "description",
  "validationDate" : 0,
  "locale" : "locale",
  "validated" : true,
  "securityPolicyChange" : 7,
  "waitingForEmailCheck" : true,
  "modified" : 9,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "signupUUID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "email" : "email",
  "validationURI" : "validationURI",
  "owner" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "created" : 6,
  "userTypeProprietaryInfo" : {
    "mobiles" : [ {
      "number" : "number",
      "verified" : true,
      "primary" : true
    }, {
      "number" : "number",
      "verified" : true,
      "primary" : true
    } ],
    "mfa" : {
      "method" : "sms",
      "enabled" : true
    },
    "authenticatorSecret" : "authenticatorSecret"
  },
  "avatar" : "https://openapi-generator.tech",
  "securityPolicy" : "securityPolicy",
  "suspended" : true,
  "changePassword" : true,
  "currentPassword" : "currentPassword",
  "blackListed" : true,
  "name" : "name",
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "lastPasswordChange" : 5,
  "lastPasswords" : [ "lastPasswords", "lastPasswords" ],
  "oauthType" : "internal",
  "validationEmail" : "validationEmail",
  "userRole" : "root",
  "oauthUserInfo" : "oauthUserInfo",
  "currentLoginURI" : "currentLoginURI"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscribersApi;

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

public class SubscribersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscribersApi apiInstance = new SubscribersApi();
        Long id = 789; // Long | 
        Boolean emailVerification = true; // Boolean | 
        Boolean forgotPassword = true; // Boolean | 
        Boolean resetMFA = true; // Boolean | 
        UserInfo userInfo = ; // UserInfo | 

        try {
            apiInstance.updateSubUser(id, emailVerification, forgotPassword, resetMFA, userInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#updateSubUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscribersApi;

public class SubscribersApiExample {
    public static void main(String[] args) {
        SubscribersApi apiInstance = new SubscribersApi();
        Long id = 789; // Long | 
        Boolean emailVerification = true; // Boolean | 
        Boolean forgotPassword = true; // Boolean | 
        Boolean resetMFA = true; // Boolean | 
        UserInfo userInfo = ; // UserInfo | 

        try {
            apiInstance.updateSubUser(id, emailVerification, forgotPassword, resetMFA, userInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#updateSubUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscribersApi *apiInstance = [[SubscribersApi alloc] init];
Long *id = 789; //  (default to null)
Boolean *emailVerification = true; //  (optional) (default to null)
Boolean *forgotPassword = true; //  (optional) (default to false)
Boolean *resetMFA = true; //  (optional) (default to false)
UserInfo *userInfo = ; //  (optional)

// Modify a single user.
[apiInstance updateSubUserWith:id
    emailVerification:emailVerification
    forgotPassword:forgotPassword
    resetMFA:resetMFA
    userInfo:userInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SubscribersApi()
var id = 789; // {Long} 
var opts = {
  'emailVerification': true, // {Boolean} 
  'forgotPassword': true, // {Boolean} 
  'resetMFA': true, // {Boolean} 
  'userInfo':  // {UserInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateSubUser(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateSubUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscribersApi();
            var id = 789;  // Long |  (default to null)
            var emailVerification = true;  // Boolean |  (optional)  (default to null)
            var forgotPassword = true;  // Boolean |  (optional)  (default to false)
            var resetMFA = true;  // Boolean |  (optional)  (default to false)
            var userInfo = new UserInfo(); // UserInfo |  (optional) 

            try {
                // Modify a single user.
                apiInstance.updateSubUser(id, emailVerification, forgotPassword, resetMFA, userInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscribersApi.updateSubUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscribersApi();
$id = 789; // Long | 
$emailVerification = true; // Boolean | 
$forgotPassword = true; // Boolean | 
$resetMFA = true; // Boolean | 
$userInfo = ; // UserInfo | 

try {
    $api_instance->updateSubUser($id, $emailVerification, $forgotPassword, $resetMFA, $userInfo);
} catch (Exception $e) {
    echo 'Exception when calling SubscribersApi->updateSubUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscribersApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscribersApi->new();
my $id = 789; # Long | 
my $emailVerification = true; # Boolean | 
my $forgotPassword = true; # Boolean | 
my $resetMFA = true; # Boolean | 
my $userInfo = WWW::OPenAPIClient::Object::UserInfo->new(); # UserInfo | 

eval {
    $api_instance->updateSubUser(id => $id, emailVerification => $emailVerification, forgotPassword => $forgotPassword, resetMFA => $resetMFA, userInfo => $userInfo);
};
if ($@) {
    warn "Exception when calling SubscribersApi->updateSubUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscribersApi()
id = 789 # Long |  (default to null)
emailVerification = true # Boolean |  (optional) (default to null)
forgotPassword = true # Boolean |  (optional) (default to false)
resetMFA = true # Boolean |  (optional) (default to false)
userInfo =  # UserInfo |  (optional)

try:
    # Modify a single user.
    api_instance.update_sub_user(id, emailVerification=emailVerification, forgotPassword=forgotPassword, resetMFA=resetMFA, userInfo=userInfo)
except ApiException as e:
    print("Exception when calling SubscribersApi->updateSubUser: %s\n" % e)
extern crate SubscribersApi;

pub fn main() {
    let id = 789; // Long
    let emailVerification = true; // Boolean
    let forgotPassword = true; // Boolean
    let resetMFA = true; // Boolean
    let userInfo = ; // UserInfo

    let mut context = SubscribersApi::Context::default();
    let result = client.updateSubUser(id, emailVerification, forgotPassword, resetMFA, userInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Body parameters
Name Description
userInfo

User details (some fields are ignored during update)

Query parameters
Name Description
email_verification
Boolean
forgotPassword
Boolean
resetMFA
Boolean

Responses


validateSubToken

Allows any microservice to validate a token and get security policy for a specific user.


/validateSubToken

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/validateSubToken?token=token_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscribersApi;

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

public class SubscribersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubscribersApi apiInstance = new SubscribersApi();
        String token = token_example; // String | 

        try {
            apiInstance.validateSubToken(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#validateSubToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscribersApi;

public class SubscribersApiExample {
    public static void main(String[] args) {
        SubscribersApi apiInstance = new SubscribersApi();
        String token = token_example; // String | 

        try {
            apiInstance.validateSubToken(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscribersApi#validateSubToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubscribersApi *apiInstance = [[SubscribersApi alloc] init];
String *token = token_example; //  (default to null)

// Allows any microservice to validate a token and get security policy for a specific user.
[apiInstance validateSubTokenWith:token
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SubscribersApi()
var token = token_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateSubToken(token, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class validateSubTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubscribersApi();
            var token = token_example;  // String |  (default to null)

            try {
                // Allows any microservice to validate a token and get security policy for a specific user.
                apiInstance.validateSubToken(token);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscribersApi.validateSubToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscribersApi();
$token = token_example; // String | 

try {
    $api_instance->validateSubToken($token);
} catch (Exception $e) {
    echo 'Exception when calling SubscribersApi->validateSubToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscribersApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscribersApi->new();
my $token = token_example; # String | 

eval {
    $api_instance->validateSubToken(token => $token);
};
if ($@) {
    warn "Exception when calling SubscribersApi->validateSubToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubscribersApi()
token = token_example # String |  (default to null)

try:
    # Allows any microservice to validate a token and get security policy for a specific user.
    api_instance.validate_sub_token(token)
except ApiException as e:
    print("Exception when calling SubscribersApi->validateSubToken: %s\n" % e)
extern crate SubscribersApi;

pub fn main() {
    let token = token_example; // String

    let mut context = SubscribersApi::Context::default();
    let result = client.validateSubToken(token, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
token*
String
Required

Responses


SystemCommands

getSystemCommand

Retrieve different values from the running service.


/system

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/system?command=command_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

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

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        String command = command_example; // String | Get a value

        try {
            getSystemCommand_200_response result = apiInstance.getSystemCommand(command);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        String command = command_example; // String | Get a value

        try {
            getSystemCommand_200_response result = apiInstance.getSystemCommand(command);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];
String *command = command_example; // Get a value (default to null)

// Retrieve different values from the running service.
[apiInstance getSystemCommandWith:command
              completionHandler: ^(getSystemCommand_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SystemCommandsApi()
var command = command_example; // {String} Get a value

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

namespace Example
{
    public class getSystemCommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();
            var command = command_example;  // String | Get a value (default to null)

            try {
                // Retrieve different values from the running service.
                getSystemCommand_200_response result = apiInstance.getSystemCommand(command);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.getSystemCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();
$command = command_example; // String | Get a value

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();
my $command = command_example; # String | Get a value

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()
command = command_example # String | Get a value (default to null)

try:
    # Retrieve different values from the running service.
    api_response = api_instance.get_system_command(command)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->getSystemCommand: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {
    let command = command_example; // String

    let mut context = SystemCommandsApi::Context::default();
    let result = client.getSystemCommand(command, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
command*
String
Get a value
Required

Responses


getSystemInfo

Retrieve the system layout.


/systemEndpoints

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/systemEndpoints"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

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

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();

        try {
            SystemEndpointList result = apiInstance.getSystemInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();

        try {
            SystemEndpointList result = apiInstance.getSystemInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];

// Retrieve the system layout.
[apiInstance getSystemInfoWithCompletionHandler: 
              ^(SystemEndpointList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SystemCommandsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSystemInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSystemInfoExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();

            try {
                // Retrieve the system layout.
                SystemEndpointList result = apiInstance.getSystemInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.getSystemInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()

try:
    # Retrieve the system layout.
    api_response = api_instance.get_system_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->getSystemInfo: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {

    let mut context = SystemCommandsApi::Context::default();
    let result = client.getSystemInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


systemCommand

Perform some system wide commands.


/system

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/system" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

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

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        SystemCommandRequest systemCommandRequest = ; // SystemCommandRequest | 

        try {
            systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#systemCommand");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        SystemCommandRequest systemCommandRequest = ; // SystemCommandRequest | 

        try {
            systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#systemCommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];
SystemCommandRequest *systemCommandRequest = ; //  (optional)

// Perform some system wide commands.
[apiInstance systemCommandWith:systemCommandRequest
              completionHandler: ^(systemCommand_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.SystemCommandsApi()
var opts = {
  'systemCommandRequest':  // {SystemCommandRequest} 
};

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

namespace Example
{
    public class systemCommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();
            var systemCommandRequest = new SystemCommandRequest(); // SystemCommandRequest |  (optional) 

            try {
                // Perform some system wide commands.
                systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.systemCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();
$systemCommandRequest = ; // SystemCommandRequest | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();
my $systemCommandRequest = WWW::OPenAPIClient::Object::SystemCommandRequest->new(); # SystemCommandRequest | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()
systemCommandRequest =  # SystemCommandRequest |  (optional)

try:
    # Perform some system wide commands.
    api_response = api_instance.system_command(systemCommandRequest=systemCommandRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->systemCommand: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {
    let systemCommandRequest = ; // SystemCommandRequest

    let mut context = SystemCommandsApi::Context::default();
    let result = client.systemCommand(systemCommandRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
systemCommandRequest

Command details

Responses


UserManagement

createUser

Create a single user.


/user/{id}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/user/{id}?email_verification=true" \
 -d '{
  "lastLogin" : 1,
  "lastEmailCheck" : 5,
  "notes" : [ {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 2
  }, {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 2
  } ],
  "description" : "description",
  "validationDate" : 0,
  "locale" : "locale",
  "validated" : true,
  "securityPolicyChange" : 7,
  "waitingForEmailCheck" : true,
  "modified" : 9,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "signupUUID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "email" : "email",
  "validationURI" : "validationURI",
  "owner" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "created" : 6,
  "userTypeProprietaryInfo" : {
    "mobiles" : [ {
      "number" : "number",
      "verified" : true,
      "primary" : true
    }, {
      "number" : "number",
      "verified" : true,
      "primary" : true
    } ],
    "mfa" : {
      "method" : "sms",
      "enabled" : true
    },
    "authenticatorSecret" : "authenticatorSecret"
  },
  "avatar" : "https://openapi-generator.tech",
  "securityPolicy" : "securityPolicy",
  "suspended" : true,
  "changePassword" : true,
  "currentPassword" : "currentPassword",
  "blackListed" : true,
  "name" : "name",
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "lastPasswordChange" : 5,
  "lastPasswords" : [ "lastPasswords", "lastPasswords" ],
  "oauthType" : "internal",
  "validationEmail" : "validationEmail",
  "userRole" : "root",
  "oauthUserInfo" : "oauthUserInfo",
  "currentLoginURI" : "currentLoginURI"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserManagementApi;

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

public class UserManagementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserManagementApi apiInstance = new UserManagementApi();
        Long id = 789; // Long | 
        Boolean emailVerification = true; // Boolean | 
        UserInfo userInfo = ; // UserInfo | 

        try {
            apiInstance.createUser(id, emailVerification, userInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#createUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserManagementApi;

public class UserManagementApiExample {
    public static void main(String[] args) {
        UserManagementApi apiInstance = new UserManagementApi();
        Long id = 789; // Long | 
        Boolean emailVerification = true; // Boolean | 
        UserInfo userInfo = ; // UserInfo | 

        try {
            apiInstance.createUser(id, emailVerification, userInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#createUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserManagementApi *apiInstance = [[UserManagementApi alloc] init];
Long *id = 789; //  (default to null)
Boolean *emailVerification = true; //  (optional) (default to null)
UserInfo *userInfo = ; //  (optional)

// Create a single user.
[apiInstance createUserWith:id
    emailVerification:emailVerification
    userInfo:userInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.UserManagementApi()
var id = 789; // {Long} 
var opts = {
  'emailVerification': true, // {Boolean} 
  'userInfo':  // {UserInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUser(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserManagementApi();
            var id = 789;  // Long |  (default to null)
            var emailVerification = true;  // Boolean |  (optional)  (default to null)
            var userInfo = new UserInfo(); // UserInfo |  (optional) 

            try {
                // Create a single user.
                apiInstance.createUser(id, emailVerification, userInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserManagementApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserManagementApi();
$id = 789; // Long | 
$emailVerification = true; // Boolean | 
$userInfo = ; // UserInfo | 

try {
    $api_instance->createUser($id, $emailVerification, $userInfo);
} catch (Exception $e) {
    echo 'Exception when calling UserManagementApi->createUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserManagementApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserManagementApi->new();
my $id = 789; # Long | 
my $emailVerification = true; # Boolean | 
my $userInfo = WWW::OPenAPIClient::Object::UserInfo->new(); # UserInfo | 

eval {
    $api_instance->createUser(id => $id, emailVerification => $emailVerification, userInfo => $userInfo);
};
if ($@) {
    warn "Exception when calling UserManagementApi->createUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserManagementApi()
id = 789 # Long |  (default to null)
emailVerification = true # Boolean |  (optional) (default to null)
userInfo =  # UserInfo |  (optional)

try:
    # Create a single user.
    api_instance.create_user(id, emailVerification=emailVerification, userInfo=userInfo)
except ApiException as e:
    print("Exception when calling UserManagementApi->createUser: %s\n" % e)
extern crate UserManagementApi;

pub fn main() {
    let id = 789; // Long
    let emailVerification = true; // Boolean
    let userInfo = ; // UserInfo

    let mut context = UserManagementApi::Context::default();
    let result = client.createUser(id, emailVerification, userInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Body parameters
Name Description
userInfo

User details (some fields are ignored during creation)

Query parameters
Name Description
email_verification
Boolean

Responses


deleteUser

Delete a single user.


/user/{id}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/user/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserManagementApi;

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

public class UserManagementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserManagementApi apiInstance = new UserManagementApi();
        Long id = 789; // Long | 

        try {
            deleteUser_204_response result = apiInstance.deleteUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserManagementApi;

public class UserManagementApiExample {
    public static void main(String[] args) {
        UserManagementApi apiInstance = new UserManagementApi();
        Long id = 789; // Long | 

        try {
            deleteUser_204_response result = apiInstance.deleteUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#deleteUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserManagementApi *apiInstance = [[UserManagementApi alloc] init];
Long *id = 789; //  (default to null)

// Delete a single user.
[apiInstance deleteUserWith:id
              completionHandler: ^(deleteUser_204_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.UserManagementApi()
var id = 789; // {Long} 

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

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserManagementApi();
            var id = 789;  // Long |  (default to null)

            try {
                // Delete a single user.
                deleteUser_204_response result = apiInstance.deleteUser(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserManagementApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserManagementApi();
$id = 789; // Long | 

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

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserManagementApi->new();
my $id = 789; # Long | 

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

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserManagementApi()
id = 789 # Long |  (default to null)

try:
    # Delete a single user.
    api_response = api_instance.delete_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserManagementApi->deleteUser: %s\n" % e)
extern crate UserManagementApi;

pub fn main() {
    let id = 789; // Long

    let mut context = UserManagementApi::Context::default();
    let result = client.deleteUser(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses


getUser

Retrieve the information for a single user.


/user/{id}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/user/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserManagementApi;

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

public class UserManagementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserManagementApi apiInstance = new UserManagementApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.getUser(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#getUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserManagementApi;

public class UserManagementApiExample {
    public static void main(String[] args) {
        UserManagementApi apiInstance = new UserManagementApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.getUser(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#getUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserManagementApi *apiInstance = [[UserManagementApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve the information for a single user.
[apiInstance getUserWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.UserManagementApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getUser(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserManagementApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve the information for a single user.
                apiInstance.getUser(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserManagementApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserManagementApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $api_instance->getUser($id);
} catch (Exception $e) {
    echo 'Exception when calling UserManagementApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserManagementApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserManagementApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getUser(id => $id);
};
if ($@) {
    warn "Exception when calling UserManagementApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserManagementApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve the information for a single user.
    api_instance.get_user(id)
except ApiException as e:
    print("Exception when calling UserManagementApi->getUser: %s\n" % e)
extern crate UserManagementApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = UserManagementApi::Context::default();
    let result = client.getUser(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required

Responses


getUsers

Retrieve a list of existing users as well as some information about them.


/users

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16001/api/v1/users?offset=789&limit=789&filter=filter_example&idOnly=true&select=id1,id2,id3,id4,id5&nameSearch=nameSearch_example&emailSearch=emailSearch_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserManagementApi;

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

public class UserManagementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserManagementApi apiInstance = new UserManagementApi();
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        String filter = filter_example; // String | Selecting this option means the newest record will be returned. Use limit to select how many.
        Boolean idOnly = true; // Boolean | Return only the ids.
        String select = id1,id2,id3,id4,id5; // String | Return only the ids.
        String nameSearch = nameSearch_example; // String | Name matching
        String emailSearch = emailSearch_example; // String | Name matching

        try {
            apiInstance.getUsers(offset, limit, filter, idOnly, select, nameSearch, emailSearch);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#getUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserManagementApi;

public class UserManagementApiExample {
    public static void main(String[] args) {
        UserManagementApi apiInstance = new UserManagementApi();
        Long offset = 789; // Long | 
        Long limit = 789; // Long | 
        String filter = filter_example; // String | Selecting this option means the newest record will be returned. Use limit to select how many.
        Boolean idOnly = true; // Boolean | Return only the ids.
        String select = id1,id2,id3,id4,id5; // String | Return only the ids.
        String nameSearch = nameSearch_example; // String | Name matching
        String emailSearch = emailSearch_example; // String | Name matching

        try {
            apiInstance.getUsers(offset, limit, filter, idOnly, select, nameSearch, emailSearch);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#getUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserManagementApi *apiInstance = [[UserManagementApi alloc] init];
Long *offset = 789; //  (optional) (default to null)
Long *limit = 789; //  (optional) (default to null)
String *filter = filter_example; // Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)
Boolean *idOnly = true; // Return only the ids. (optional) (default to null)
String *select = id1,id2,id3,id4,id5; // Return only the ids. (optional) (default to null)
String *nameSearch = nameSearch_example; // Name matching (optional) (default to null)
String *emailSearch = emailSearch_example; // Name matching (optional) (default to null)

// Retrieve a list of existing users as well as some information about them.
[apiInstance getUsersWith:offset
    limit:limit
    filter:filter
    idOnly:idOnly
    select:select
    nameSearch:nameSearch
    emailSearch:emailSearch
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.UserManagementApi()
var opts = {
  'offset': 789, // {Long} 
  'limit': 789, // {Long} 
  'filter': filter_example, // {String} Selecting this option means the newest record will be returned. Use limit to select how many.
  'idOnly': true, // {Boolean} Return only the ids.
  'select': id1,id2,id3,id4,id5, // {String} Return only the ids.
  'nameSearch': nameSearch_example, // {String} Name matching
  'emailSearch': emailSearch_example // {String} Name matching
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getUsers(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUsersExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserManagementApi();
            var offset = 789;  // Long |  (optional)  (default to null)
            var limit = 789;  // Long |  (optional)  (default to null)
            var filter = filter_example;  // String | Selecting this option means the newest record will be returned. Use limit to select how many. (optional)  (default to null)
            var idOnly = true;  // Boolean | Return only the ids. (optional)  (default to null)
            var select = id1,id2,id3,id4,id5;  // String | Return only the ids. (optional)  (default to null)
            var nameSearch = nameSearch_example;  // String | Name matching (optional)  (default to null)
            var emailSearch = emailSearch_example;  // String | Name matching (optional)  (default to null)

            try {
                // Retrieve a list of existing users as well as some information about them.
                apiInstance.getUsers(offset, limit, filter, idOnly, select, nameSearch, emailSearch);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserManagementApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserManagementApi();
$offset = 789; // Long | 
$limit = 789; // Long | 
$filter = filter_example; // String | Selecting this option means the newest record will be returned. Use limit to select how many.
$idOnly = true; // Boolean | Return only the ids.
$select = id1,id2,id3,id4,id5; // String | Return only the ids.
$nameSearch = nameSearch_example; // String | Name matching
$emailSearch = emailSearch_example; // String | Name matching

try {
    $api_instance->getUsers($offset, $limit, $filter, $idOnly, $select, $nameSearch, $emailSearch);
} catch (Exception $e) {
    echo 'Exception when calling UserManagementApi->getUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserManagementApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserManagementApi->new();
my $offset = 789; # Long | 
my $limit = 789; # Long | 
my $filter = filter_example; # String | Selecting this option means the newest record will be returned. Use limit to select how many.
my $idOnly = true; # Boolean | Return only the ids.
my $select = id1,id2,id3,id4,id5; # String | Return only the ids.
my $nameSearch = nameSearch_example; # String | Name matching
my $emailSearch = emailSearch_example; # String | Name matching

eval {
    $api_instance->getUsers(offset => $offset, limit => $limit, filter => $filter, idOnly => $idOnly, select => $select, nameSearch => $nameSearch, emailSearch => $emailSearch);
};
if ($@) {
    warn "Exception when calling UserManagementApi->getUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserManagementApi()
offset = 789 # Long |  (optional) (default to null)
limit = 789 # Long |  (optional) (default to null)
filter = filter_example # String | Selecting this option means the newest record will be returned. Use limit to select how many. (optional) (default to null)
idOnly = true # Boolean | Return only the ids. (optional) (default to null)
select = id1,id2,id3,id4,id5 # String | Return only the ids. (optional) (default to null)
nameSearch = nameSearch_example # String | Name matching (optional) (default to null)
emailSearch = emailSearch_example # String | Name matching (optional) (default to null)

try:
    # Retrieve a list of existing users as well as some information about them.
    api_instance.get_users(offset=offset, limit=limit, filter=filter, idOnly=idOnly, select=select, nameSearch=nameSearch, emailSearch=emailSearch)
except ApiException as e:
    print("Exception when calling UserManagementApi->getUsers: %s\n" % e)
extern crate UserManagementApi;

pub fn main() {
    let offset = 789; // Long
    let limit = 789; // Long
    let filter = filter_example; // String
    let idOnly = true; // Boolean
    let select = id1,id2,id3,id4,id5; // String
    let nameSearch = nameSearch_example; // String
    let emailSearch = emailSearch_example; // String

    let mut context = UserManagementApi::Context::default();
    let result = client.getUsers(offset, limit, filter, idOnly, select, nameSearch, emailSearch, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
offset
Long (int64)
limit
Long (int64)
filter
String
Selecting this option means the newest record will be returned. Use limit to select how many.
idOnly
Boolean
Return only the ids.
select
String
Return only the ids.
nameSearch
String
Name matching
emailSearch
String
Name matching

Responses


updateUser

Modify a single user.


/user/{id}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
-H "X-API-TOKEN: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16001/api/v1/user/{id}?email_verification=true&forgotPassword=true&resetMFA=true" \
 -d '{
  "lastLogin" : 1,
  "lastEmailCheck" : 5,
  "notes" : [ {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 2
  }, {
    "note" : "note",
    "createdBy" : "createdBy",
    "created" : 2
  } ],
  "description" : "description",
  "validationDate" : 0,
  "locale" : "locale",
  "validated" : true,
  "securityPolicyChange" : 7,
  "waitingForEmailCheck" : true,
  "modified" : 9,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "signupUUID" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "email" : "email",
  "validationURI" : "validationURI",
  "owner" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "created" : 6,
  "userTypeProprietaryInfo" : {
    "mobiles" : [ {
      "number" : "number",
      "verified" : true,
      "primary" : true
    }, {
      "number" : "number",
      "verified" : true,
      "primary" : true
    } ],
    "mfa" : {
      "method" : "sms",
      "enabled" : true
    },
    "authenticatorSecret" : "authenticatorSecret"
  },
  "avatar" : "https://openapi-generator.tech",
  "securityPolicy" : "securityPolicy",
  "suspended" : true,
  "changePassword" : true,
  "currentPassword" : "currentPassword",
  "blackListed" : true,
  "name" : "name",
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "lastPasswordChange" : 5,
  "lastPasswords" : [ "lastPasswords", "lastPasswords" ],
  "oauthType" : "internal",
  "validationEmail" : "validationEmail",
  "userRole" : "root",
  "oauthUserInfo" : "oauthUserInfo",
  "currentLoginURI" : "currentLoginURI"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserManagementApi;

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

public class UserManagementApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure API key authorization: ApiToken
        ApiKeyAuth ApiToken = (ApiKeyAuth) defaultClient.getAuthentication("ApiToken");
        ApiToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiToken.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserManagementApi apiInstance = new UserManagementApi();
        Long id = 789; // Long | 
        Boolean emailVerification = true; // Boolean | 
        Boolean forgotPassword = true; // Boolean | 
        Boolean resetMFA = true; // Boolean | 
        UserInfo userInfo = ; // UserInfo | 

        try {
            apiInstance.updateUser(id, emailVerification, forgotPassword, resetMFA, userInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#updateUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserManagementApi;

public class UserManagementApiExample {
    public static void main(String[] args) {
        UserManagementApi apiInstance = new UserManagementApi();
        Long id = 789; // Long | 
        Boolean emailVerification = true; // Boolean | 
        Boolean forgotPassword = true; // Boolean | 
        Boolean resetMFA = true; // Boolean | 
        UserInfo userInfo = ; // UserInfo | 

        try {
            apiInstance.updateUser(id, emailVerification, forgotPassword, resetMFA, userInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserManagementApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserManagementApi *apiInstance = [[UserManagementApi alloc] init];
Long *id = 789; //  (default to null)
Boolean *emailVerification = true; //  (optional) (default to null)
Boolean *forgotPassword = true; //  (optional) (default to false)
Boolean *resetMFA = true; //  (optional) (default to false)
UserInfo *userInfo = ; //  (optional)

// Modify a single user.
[apiInstance updateUserWith:id
    emailVerification:emailVerification
    forgotPassword:forgotPassword
    resetMFA:resetMFA
    userInfo:userInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var UCentralSecurityApi = require('u_central_security_api');
var defaultClient = UCentralSecurityApi.ApiClient.instance;

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new UCentralSecurityApi.UserManagementApi()
var id = 789; // {Long} 
var opts = {
  'emailVerification': true, // {Boolean} 
  'forgotPassword': true, // {Boolean} 
  'resetMFA': true, // {Boolean} 
  'userInfo':  // {UserInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUser(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure API key authorization: ApiToken
            Configuration.Default.ApiKey.Add("X-API-TOKEN", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-TOKEN", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserManagementApi();
            var id = 789;  // Long |  (default to null)
            var emailVerification = true;  // Boolean |  (optional)  (default to null)
            var forgotPassword = true;  // Boolean |  (optional)  (default to false)
            var resetMFA = true;  // Boolean |  (optional)  (default to false)
            var userInfo = new UserInfo(); // UserInfo |  (optional) 

            try {
                // Modify a single user.
                apiInstance.updateUser(id, emailVerification, forgotPassword, resetMFA, userInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserManagementApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserManagementApi();
$id = 789; // Long | 
$emailVerification = true; // Boolean | 
$forgotPassword = true; // Boolean | 
$resetMFA = true; // Boolean | 
$userInfo = ; // UserInfo | 

try {
    $api_instance->updateUser($id, $emailVerification, $forgotPassword, $resetMFA, $userInfo);
} catch (Exception $e) {
    echo 'Exception when calling UserManagementApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserManagementApi;

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

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

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserManagementApi->new();
my $id = 789; # Long | 
my $emailVerification = true; # Boolean | 
my $forgotPassword = true; # Boolean | 
my $resetMFA = true; # Boolean | 
my $userInfo = WWW::OPenAPIClient::Object::UserInfo->new(); # UserInfo | 

eval {
    $api_instance->updateUser(id => $id, emailVerification => $emailVerification, forgotPassword => $forgotPassword, resetMFA => $resetMFA, userInfo => $userInfo);
};
if ($@) {
    warn "Exception when calling UserManagementApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure API key authorization: ApiToken
openapi_client.configuration.api_key['X-API-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-TOKEN'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserManagementApi()
id = 789 # Long |  (default to null)
emailVerification = true # Boolean |  (optional) (default to null)
forgotPassword = true # Boolean |  (optional) (default to false)
resetMFA = true # Boolean |  (optional) (default to false)
userInfo =  # UserInfo |  (optional)

try:
    # Modify a single user.
    api_instance.update_user(id, emailVerification=emailVerification, forgotPassword=forgotPassword, resetMFA=resetMFA, userInfo=userInfo)
except ApiException as e:
    print("Exception when calling UserManagementApi->updateUser: %s\n" % e)
extern crate UserManagementApi;

pub fn main() {
    let id = 789; // Long
    let emailVerification = true; // Boolean
    let forgotPassword = true; // Boolean
    let resetMFA = true; // Boolean
    let userInfo = ; // UserInfo

    let mut context = UserManagementApi::Context::default();
    let result = client.updateUser(id, emailVerification, forgotPassword, resetMFA, userInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Body parameters
Name Description
userInfo

User details (some fields are ignored during update)

Query parameters
Name Description
email_verification
Boolean
forgotPassword
Boolean
resetMFA
Boolean

Responses