Genian ZTNA REST API

Admins

changePassword

Reset a specific user's password

Resets the password of the user specified.


/admins/{adminId}/password

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/admins/{adminId}/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Username (ADM_ID)
        String oldPw = oldPw_example; // String | Old password
        String newPw = newPw_example; // String | New password
        Boolean isEncrytion = true; // Boolean | Password encryption
        try {
            apiInstance.changePassword(adminId, oldPw, newPw, isEncrytion);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#changePassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Username (ADM_ID)
        String oldPw = oldPw_example; // String | Old password
        String newPw = newPw_example; // String | New password
        Boolean isEncrytion = true; // Boolean | Password encryption
        try {
            apiInstance.changePassword(adminId, oldPw, newPw, isEncrytion);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#changePassword");
            e.printStackTrace();
        }
    }
}
String *adminId = adminId_example; // Username (ADM_ID)
String *oldPw = oldPw_example; // Old password
String *newPw = newPw_example; // New password
Boolean *isEncrytion = true; // Password encryption (optional)

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

// Reset a specific user's password
[apiInstance changePasswordWith:adminId
    oldPw:oldPw
    newPw:newPw
    isEncrytion:isEncrytion
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.AdminsApi()

var adminId = adminId_example; // {String} Username (ADM_ID)

var oldPw = oldPw_example; // {String} Old password

var newPw = newPw_example; // {String} New password

var opts = { 
  'isEncrytion': true // {Boolean} Password encryption
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.changePassword(adminId, oldPw, newPw, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class changePasswordExample
    {
        public void main()
        {
            
            var apiInstance = new AdminsApi();
            var adminId = adminId_example;  // String | Username (ADM_ID)
            var oldPw = oldPw_example;  // String | Old password
            var newPw = newPw_example;  // String | New password
            var isEncrytion = true;  // Boolean | Password encryption (optional) 

            try
            {
                // Reset a specific user's password
                apiInstance.changePassword(adminId, oldPw, newPw, isEncrytion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdminsApi();
$adminId = adminId_example; // String | Username (ADM_ID)
$oldPw = oldPw_example; // String | Old password
$newPw = newPw_example; // String | New password
$isEncrytion = true; // Boolean | Password encryption

try {
    $api_instance->changePassword($adminId, $oldPw, $newPw, $isEncrytion);
} catch (Exception $e) {
    echo 'Exception when calling AdminsApi->changePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminsApi;

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $adminId = adminId_example; # String | Username (ADM_ID)
my $oldPw = oldPw_example; # String | Old password
my $newPw = newPw_example; # String | New password
my $isEncrytion = true; # Boolean | Password encryption

eval { 
    $api_instance->changePassword(adminId => $adminId, oldPw => $oldPw, newPw => $newPw, isEncrytion => $isEncrytion);
};
if ($@) {
    warn "Exception when calling AdminsApi->changePassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdminsApi()
adminId = adminId_example # String | Username (ADM_ID)
oldPw = oldPw_example # String | Old password
newPw = newPw_example # String | New password
isEncrytion = true # Boolean | Password encryption (optional)

try: 
    # Reset a specific user's password
    api_instance.change_password(adminId, oldPw, newPw, isEncrytion=isEncrytion)
except ApiException as e:
    print("Exception when calling AdminsApi->changePassword: %s\n" % e)

Parameters

Path parameters
Name Description
adminId*
String
Username (ADM_ID)
Required
Form parameters
Name Description
oldPw*
String
Old password
Required
newPw*
String
New password
Required
isEncrytion
Boolean
Password encryption

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


createAdmin

Create an administrator

Create an administrator.


/admins/{adminId}

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/admins/{adminId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        AdminVo body = ; // AdminVo | AdminVo JSON Data
        try {
            apiInstance.createAdmin(adminId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#createAdmin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        AdminVo body = ; // AdminVo | AdminVo JSON Data
        try {
            apiInstance.createAdmin(adminId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#createAdmin");
            e.printStackTrace();
        }
    }
}
String *adminId = adminId_example; // Admin Username (ADM_ID)
AdminVo *body = ; // AdminVo JSON Data

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

// Create an administrator
[apiInstance createAdminWith:adminId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.AdminsApi()

var adminId = adminId_example; // {String} Admin Username (ADM_ID)

var body = ; // {AdminVo} AdminVo JSON Data


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

namespace Example
{
    public class createAdminExample
    {
        public void main()
        {
            
            var apiInstance = new AdminsApi();
            var adminId = adminId_example;  // String | Admin Username (ADM_ID)
            var body = new AdminVo(); // AdminVo | AdminVo JSON Data

            try
            {
                // Create an administrator
                apiInstance.createAdmin(adminId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.createAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdminsApi();
$adminId = adminId_example; // String | Admin Username (ADM_ID)
$body = ; // AdminVo | AdminVo JSON Data

try {
    $api_instance->createAdmin($adminId, $body);
} catch (Exception $e) {
    echo 'Exception when calling AdminsApi->createAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminsApi;

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $adminId = adminId_example; # String | Admin Username (ADM_ID)
my $body = WWW::SwaggerClient::Object::AdminVo->new(); # AdminVo | AdminVo JSON Data

eval { 
    $api_instance->createAdmin(adminId => $adminId, body => $body);
};
if ($@) {
    warn "Exception when calling AdminsApi->createAdmin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdminsApi()
adminId = adminId_example # String | Admin Username (ADM_ID)
body =  # AdminVo | AdminVo JSON Data

try: 
    # Create an administrator
    api_instance.create_admin(adminId, body)
except ApiException as e:
    print("Exception when calling AdminsApi->createAdmin: %s\n" % e)

Parameters

Path parameters
Name Description
adminId*
String
Admin Username (ADM_ID)
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteAdmin

Delete a specific admin

Deletes the admin specified.


/admins/{adminId}

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/admins/{adminId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Username (ADM_ID)
        try {
            apiInstance.deleteAdmin(adminId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#deleteAdmin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Username (ADM_ID)
        try {
            apiInstance.deleteAdmin(adminId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#deleteAdmin");
            e.printStackTrace();
        }
    }
}
String *adminId = adminId_example; // Username (ADM_ID)

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

// Delete a specific admin
[apiInstance deleteAdminWith:adminId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.AdminsApi()

var adminId = adminId_example; // {String} Username (ADM_ID)


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

namespace Example
{
    public class deleteAdminExample
    {
        public void main()
        {
            
            var apiInstance = new AdminsApi();
            var adminId = adminId_example;  // String | Username (ADM_ID)

            try
            {
                // Delete a specific admin
                apiInstance.deleteAdmin(adminId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.deleteAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdminsApi();
$adminId = adminId_example; // String | Username (ADM_ID)

try {
    $api_instance->deleteAdmin($adminId);
} catch (Exception $e) {
    echo 'Exception when calling AdminsApi->deleteAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminsApi;

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $adminId = adminId_example; # String | Username (ADM_ID)

eval { 
    $api_instance->deleteAdmin(adminId => $adminId);
};
if ($@) {
    warn "Exception when calling AdminsApi->deleteAdmin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdminsApi()
adminId = adminId_example # String | Username (ADM_ID)

try: 
    # Delete a specific admin
    api_instance.delete_admin(adminId)
except ApiException as e:
    print("Exception when calling AdminsApi->deleteAdmin: %s\n" % e)

Parameters

Path parameters
Name Description
adminId*
String
Username (ADM_ID)
Required

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getAdmin

Retrieve a specific administrator's information

Retrieves the information of the administrator specified.


/admins/{adminId}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/admins/{adminId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        try {
            AdminVo result = apiInstance.getAdmin(adminId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#getAdmin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        try {
            AdminVo result = apiInstance.getAdmin(adminId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#getAdmin");
            e.printStackTrace();
        }
    }
}
String *adminId = adminId_example; // Admin Username (ADM_ID)

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

// Retrieve a specific administrator's information
[apiInstance getAdminWith:adminId
              completionHandler: ^(AdminVo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.AdminsApi()

var adminId = adminId_example; // {String} Admin Username (ADM_ID)


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

namespace Example
{
    public class getAdminExample
    {
        public void main()
        {
            
            var apiInstance = new AdminsApi();
            var adminId = adminId_example;  // String | Admin Username (ADM_ID)

            try
            {
                // Retrieve a specific administrator's information
                AdminVo result = apiInstance.getAdmin(adminId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.getAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdminsApi();
$adminId = adminId_example; // String | Admin Username (ADM_ID)

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

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $adminId = adminId_example; # String | Admin Username (ADM_ID)

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

# create an instance of the API class
api_instance = swagger_client.AdminsApi()
adminId = adminId_example # String | Admin Username (ADM_ID)

try: 
    # Retrieve a specific administrator's information
    api_response = api_instance.get_admin(adminId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->getAdmin: %s\n" % e)

Parameters

Path parameters
Name Description
adminId*
String
Admin Username (ADM_ID)
Required

Responses

Status: 200 - successful operation

Status: 401 - Unauthorized

Status: 404 - Not Found


getAdminRestriction

Retrieve a restriction of management scope

Retrieves the restriction of management scope for the node/user of the administrator.


/admins/{adminId}/restriction

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/admins/{adminId}/restriction"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        try {
            AdminRestrictionVo result = apiInstance.getAdminRestriction(adminId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#getAdminRestriction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        try {
            AdminRestrictionVo result = apiInstance.getAdminRestriction(adminId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#getAdminRestriction");
            e.printStackTrace();
        }
    }
}
String *adminId = adminId_example; // Admin Username (ADM_ID)

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

// Retrieve a restriction of management scope
[apiInstance getAdminRestrictionWith:adminId
              completionHandler: ^(AdminRestrictionVo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.AdminsApi()

var adminId = adminId_example; // {String} Admin Username (ADM_ID)


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

namespace Example
{
    public class getAdminRestrictionExample
    {
        public void main()
        {
            
            var apiInstance = new AdminsApi();
            var adminId = adminId_example;  // String | Admin Username (ADM_ID)

            try
            {
                // Retrieve a restriction of management scope
                AdminRestrictionVo result = apiInstance.getAdminRestriction(adminId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.getAdminRestriction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdminsApi();
$adminId = adminId_example; // String | Admin Username (ADM_ID)

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

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $adminId = adminId_example; # String | Admin Username (ADM_ID)

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

# create an instance of the API class
api_instance = swagger_client.AdminsApi()
adminId = adminId_example # String | Admin Username (ADM_ID)

try: 
    # Retrieve a restriction of management scope
    api_response = api_instance.get_admin_restriction(adminId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->getAdminRestriction: %s\n" % e)

Parameters

Path parameters
Name Description
adminId*
String
Admin Username (ADM_ID)
Required

Responses

Status: 200 - successful operation

Status: 400 - Bad Request

Status: 401 - Forbidden

Status: 500 - Internal Server Error


updateAdmin

Update an existing administrator

Updates an existing administrator.


/admins/{adminId}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/admins/{adminId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        AdminVo body = ; // AdminVo | AdminVo JSON Data
        try {
            apiInstance.updateAdmin(adminId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#updateAdmin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        AdminVo body = ; // AdminVo | AdminVo JSON Data
        try {
            apiInstance.updateAdmin(adminId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#updateAdmin");
            e.printStackTrace();
        }
    }
}
String *adminId = adminId_example; // Admin Username (ADM_ID)
AdminVo *body = ; // AdminVo JSON Data

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

// Update an existing administrator
[apiInstance updateAdminWith:adminId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.AdminsApi()

var adminId = adminId_example; // {String} Admin Username (ADM_ID)

var body = ; // {AdminVo} AdminVo JSON Data


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

namespace Example
{
    public class updateAdminExample
    {
        public void main()
        {
            
            var apiInstance = new AdminsApi();
            var adminId = adminId_example;  // String | Admin Username (ADM_ID)
            var body = new AdminVo(); // AdminVo | AdminVo JSON Data

            try
            {
                // Update an existing administrator
                apiInstance.updateAdmin(adminId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.updateAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdminsApi();
$adminId = adminId_example; // String | Admin Username (ADM_ID)
$body = ; // AdminVo | AdminVo JSON Data

try {
    $api_instance->updateAdmin($adminId, $body);
} catch (Exception $e) {
    echo 'Exception when calling AdminsApi->updateAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminsApi;

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $adminId = adminId_example; # String | Admin Username (ADM_ID)
my $body = WWW::SwaggerClient::Object::AdminVo->new(); # AdminVo | AdminVo JSON Data

eval { 
    $api_instance->updateAdmin(adminId => $adminId, body => $body);
};
if ($@) {
    warn "Exception when calling AdminsApi->updateAdmin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdminsApi()
adminId = adminId_example # String | Admin Username (ADM_ID)
body =  # AdminVo | AdminVo JSON Data

try: 
    # Update an existing administrator
    api_instance.update_admin(adminId, body)
except ApiException as e:
    print("Exception when calling AdminsApi->updateAdmin: %s\n" % e)

Parameters

Path parameters
Name Description
adminId*
String
Admin Username (ADM_ID)
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


updateAdminRestriction

Setting restriction of management scope

Restricts the scope of management for the node/user of the administrator.


/admins/{adminId}/restriction

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/admins/{adminId}/restriction"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        AdminRestrictionVo body = ; // AdminRestrictionVo | AdminRestrictionVo JSON Data
        try {
            apiInstance.updateAdminRestriction(adminId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#updateAdminRestriction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        String adminId = adminId_example; // String | Admin Username (ADM_ID)
        AdminRestrictionVo body = ; // AdminRestrictionVo | AdminRestrictionVo JSON Data
        try {
            apiInstance.updateAdminRestriction(adminId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#updateAdminRestriction");
            e.printStackTrace();
        }
    }
}
String *adminId = adminId_example; // Admin Username (ADM_ID)
AdminRestrictionVo *body = ; // AdminRestrictionVo JSON Data

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

// Setting restriction of management scope
[apiInstance updateAdminRestrictionWith:adminId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.AdminsApi()

var adminId = adminId_example; // {String} Admin Username (ADM_ID)

var body = ; // {AdminRestrictionVo} AdminRestrictionVo JSON Data


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

namespace Example
{
    public class updateAdminRestrictionExample
    {
        public void main()
        {
            
            var apiInstance = new AdminsApi();
            var adminId = adminId_example;  // String | Admin Username (ADM_ID)
            var body = new AdminRestrictionVo(); // AdminRestrictionVo | AdminRestrictionVo JSON Data

            try
            {
                // Setting restriction of management scope
                apiInstance.updateAdminRestriction(adminId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.updateAdminRestriction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdminsApi();
$adminId = adminId_example; // String | Admin Username (ADM_ID)
$body = ; // AdminRestrictionVo | AdminRestrictionVo JSON Data

try {
    $api_instance->updateAdminRestriction($adminId, $body);
} catch (Exception $e) {
    echo 'Exception when calling AdminsApi->updateAdminRestriction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminsApi;

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $adminId = adminId_example; # String | Admin Username (ADM_ID)
my $body = WWW::SwaggerClient::Object::AdminRestrictionVo->new(); # AdminRestrictionVo | AdminRestrictionVo JSON Data

eval { 
    $api_instance->updateAdminRestriction(adminId => $adminId, body => $body);
};
if ($@) {
    warn "Exception when calling AdminsApi->updateAdminRestriction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdminsApi()
adminId = adminId_example # String | Admin Username (ADM_ID)
body =  # AdminRestrictionVo | AdminRestrictionVo JSON Data

try: 
    # Setting restriction of management scope
    api_instance.update_admin_restriction(adminId, body)
except ApiException as e:
    print("Exception when calling AdminsApi->updateAdminRestriction: %s\n" % e)

Parameters

Path parameters
Name Description
adminId*
String
Admin Username (ADM_ID)
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Forbidden

Status: 500 - Internal Server Error


updateMyinfoOfAdmin

Edit my information

Modify the information of the currently connected admin.


/admins/myinfo

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/admins/myinfo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        AdminVo body = ; // AdminVo | AdminVo JSON Data
        try {
            apiInstance.updateMyinfoOfAdmin(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#updateMyinfoOfAdmin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        AdminVo body = ; // AdminVo | AdminVo JSON Data
        try {
            apiInstance.updateMyinfoOfAdmin(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#updateMyinfoOfAdmin");
            e.printStackTrace();
        }
    }
}
AdminVo *body = ; // AdminVo JSON Data

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

// Edit my information
[apiInstance updateMyinfoOfAdminWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.AdminsApi()

var body = ; // {AdminVo} AdminVo JSON Data


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

namespace Example
{
    public class updateMyinfoOfAdminExample
    {
        public void main()
        {
            
            var apiInstance = new AdminsApi();
            var body = new AdminVo(); // AdminVo | AdminVo JSON Data

            try
            {
                // Edit my information
                apiInstance.updateMyinfoOfAdmin(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.updateMyinfoOfAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AdminsApi();
$body = ; // AdminVo | AdminVo JSON Data

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

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $body = WWW::SwaggerClient::Object::AdminVo->new(); # AdminVo | AdminVo JSON Data

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

# create an instance of the API class
api_instance = swagger_client.AdminsApi()
body =  # AdminVo | AdminVo JSON Data

try: 
    # Edit my information
    api_instance.update_myinfo_of_admin(body)
except ApiException as e:
    print("Exception when calling AdminsApi->updateMyinfoOfAdmin: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


Applications

createIpApplications

Add a new IP Request

Adds a new IP Request.


/applications/ips

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/applications/ips"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        array[IpAppVo] body = ; // array[IpAppVo] | IP Request
        try {
            apiInstance.createIpApplications(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#createIpApplications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        array[IpAppVo] body = ; // array[IpAppVo] | IP Request
        try {
            apiInstance.createIpApplications(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#createIpApplications");
            e.printStackTrace();
        }
    }
}
array[IpAppVo] *body = ; // IP Request

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

// Add a new IP Request
[apiInstance createIpApplicationsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var body = ; // {array[IpAppVo]} IP Request


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

namespace Example
{
    public class createIpApplicationsExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var body = new array[IpAppVo](); // array[IpAppVo] | IP Request

            try
            {
                // Add a new IP Request
                apiInstance.createIpApplications(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.createIpApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$body = ; // array[IpAppVo] | IP Request

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

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $body = [WWW::SwaggerClient::Object::array[IpAppVo]->new()]; # array[IpAppVo] | IP Request

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

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
body =  # array[IpAppVo] | IP Request

try: 
    # Add a new IP Request
    api_instance.create_ip_applications(body)
except ApiException as e:
    print("Exception when calling ApplicationsApi->createIpApplications: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


getCountOfIps

Retrieve the number of IP Requests

Retrieves the number of IP Requests submitted.


/applications/ips/count

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/ips/count"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getCountOfIps();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getCountOfIps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getCountOfIps();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getCountOfIps");
            e.printStackTrace();
        }
    }
}

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

// Retrieve the number of IP Requests
[apiInstance getCountOfIpsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

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

namespace Example
{
    public class getCountOfIpsExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();

            try
            {
                // Retrieve the number of IP Requests
                apiInstance.getCountOfIps();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getCountOfIps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();

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

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

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

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

try: 
    # Retrieve the number of IP Requests
    api_instance.get_count_of_ips()
except ApiException as e:
    print("Exception when calling ApplicationsApi->getCountOfIps: %s\n" % e)

Parameters

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getCountOfMediaApplications

Rertrieve the number of the External Device Requests

Retrieves the number of the External Device Requests.


/applications/medias/count

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/medias/count?application="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Boolean application = true; // Boolean | Approval status (true: Submitted, false: Approved)
        try {
            apiInstance.getCountOfMediaApplications(application);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getCountOfMediaApplications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Boolean application = true; // Boolean | Approval status (true: Submitted, false: Approved)
        try {
            apiInstance.getCountOfMediaApplications(application);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getCountOfMediaApplications");
            e.printStackTrace();
        }
    }
}
Boolean *application = true; // Approval status (true: Submitted, false: Approved)

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

// Rertrieve the number of the External Device Requests
[apiInstance getCountOfMediaApplicationsWith:application
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var application = true; // {Boolean} Approval status (true: Submitted, false: Approved)


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

namespace Example
{
    public class getCountOfMediaApplicationsExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var application = true;  // Boolean | Approval status (true: Submitted, false: Approved)

            try
            {
                // Rertrieve the number of the External Device Requests
                apiInstance.getCountOfMediaApplications(application);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getCountOfMediaApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$application = true; // Boolean | Approval status (true: Submitted, false: Approved)

try {
    $api_instance->getCountOfMediaApplications($application);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->getCountOfMediaApplications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $application = true; # Boolean | Approval status (true: Submitted, false: Approved)

eval { 
    $api_instance->getCountOfMediaApplications(application => $application);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->getCountOfMediaApplications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
application = true # Boolean | Approval status (true: Submitted, false: Approved)

try: 
    # Rertrieve the number of the External Device Requests
    api_instance.get_count_of_media_applications(application)
except ApiException as e:
    print("Exception when calling ApplicationsApi->getCountOfMediaApplications: %s\n" % e)

Parameters

Query parameters
Name Description
application*
Boolean
Approval status (true: Submitted, false: Approved)
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getCountOfUserApplications

Retrieve the number of User Account Requests

Retrieves the number of User Account Requests submitted.


/applications/users/count

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/users/count"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getCountOfUserApplications();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getCountOfUserApplications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getCountOfUserApplications();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getCountOfUserApplications");
            e.printStackTrace();
        }
    }
}

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

// Retrieve the number of User Account Requests
[apiInstance getCountOfUserApplicationsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

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

namespace Example
{
    public class getCountOfUserApplicationsExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();

            try
            {
                // Retrieve the number of User Account Requests
                apiInstance.getCountOfUserApplications();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getCountOfUserApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();

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

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

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

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

try: 
    # Retrieve the number of User Account Requests
    api_instance.get_count_of_user_applications()
except ApiException as e:
    print("Exception when calling ApplicationsApi->getCountOfUserApplications: %s\n" % e)

Parameters

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getIpAppPurposeList

Retrieve purpose list for IP Application


/applications/ips/purposes

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/ips/purposes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getIpAppPurposeList();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getIpAppPurposeList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getIpAppPurposeList();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getIpAppPurposeList");
            e.printStackTrace();
        }
    }
}

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

// Retrieve purpose list for IP Application
[apiInstance getIpAppPurposeListWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

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

namespace Example
{
    public class getIpAppPurposeListExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();

            try
            {
                // Retrieve purpose list for IP Application
                apiInstance.getIpAppPurposeList();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getIpAppPurposeList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();

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

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

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

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

try: 
    # Retrieve purpose list for IP Application
    api_instance.get_ip_app_purpose_list()
except ApiException as e:
    print("Exception when calling ApplicationsApi->getIpAppPurposeList: %s\n" % e)

Parameters

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getIpApplication

Retrieve a specific IP Request's information

Retrieves the information of the IP Request specified.


/applications/ips/{idx}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/ips/{idx}?idx="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer idx = 56; // Integer | idx
        try {
            apiInstance.getIpApplication(idx);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getIpApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer idx = 56; // Integer | idx
        try {
            apiInstance.getIpApplication(idx);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getIpApplication");
            e.printStackTrace();
        }
    }
}
Integer *idx = 56; // idx

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

// Retrieve a specific IP Request's information
[apiInstance getIpApplicationWith:idx
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var idx = 56; // {Integer} idx


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

namespace Example
{
    public class getIpApplicationExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var idx = 56;  // Integer | idx

            try
            {
                // Retrieve a specific IP Request's information
                apiInstance.getIpApplication(idx);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getIpApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$idx = 56; // Integer | idx

try {
    $api_instance->getIpApplication($idx);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->getIpApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $idx = 56; # Integer | idx

eval { 
    $api_instance->getIpApplication(idx => $idx);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->getIpApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
idx = 56 # Integer | idx

try: 
    # Retrieve a specific IP Request's information
    api_instance.get_ip_application(idx)
except ApiException as e:
    print("Exception when calling ApplicationsApi->getIpApplication: %s\n" % e)

Parameters

Query parameters
Name Description
idx*
Integer (int32)
idx
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getIpApplications

Retrieve a specific IP Request's information

Retrieves the information of the IP Request specified.


/applications/ips

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/ips?page=&pageSize=&sort=&confirmStatus=&appType=&qsearch=&appTypeCode=&applicantUser=&applicantDept=&user=&userDept=&purpose=&os=&isGuestUser=&ip=&mac=&pcName=&confirmAppType=&dateRangeType=&fromDate=&toDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String confirmStatus = confirmStatus_example; // String | Hierarchical Approval status (ready, complete, confirm, reject, progress)
        String appType = appType_example; // String | Request Type (newreturn, new, return, devchange, userchange)
        String qsearch = qsearch_example; // String | Search string
        String appTypeCode = appTypeCode_example; // String | appTypeCode
        String applicantUser = applicantUser_example; // String | Requester
        String applicantDept = applicantDept_example; // String | Requester department (applicantDept)
        String user = user_example; // String | User
        String userDept = userDept_example; // String | User department (userDept)
        String purpose = purpose_example; // String | Purpose
        String os = os_example; // String | OS
        Boolean isGuestUser = true; // Boolean | Guest enabled
        String ip = ip_example; // String | IP
        String mac = mac_example; // String | MAC
        String pcName = pcName_example; // String | Hostname
        String confirmAppType = confirmAppType_example; // String | Approval Type (prevapp: Submitted, nextapp: Approved)
        String dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date) String fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) String toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { apiInstance.getIpApplications(page, pageSize, sort, confirmStatus, appType, qsearch, appTypeCode, applicantUser, applicantDept, user, userDept, purpose, os, isGuestUser, ip, mac, pcName, confirmAppType, dateRangeType, fromDate, toDate); } catch (ApiException e) { System.err.println("Exception when calling ApplicationsApi#getIpApplications"); e.printStackTrace(); } } }
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String confirmStatus = confirmStatus_example; // String | Hierarchical Approval status (ready, complete, confirm, reject, progress)
        String appType = appType_example; // String | Request Type (newreturn, new, return, devchange, userchange)
        String qsearch = qsearch_example; // String | Search string
        String appTypeCode = appTypeCode_example; // String | appTypeCode
        String applicantUser = applicantUser_example; // String | Requester
        String applicantDept = applicantDept_example; // String | Requester department (applicantDept)
        String user = user_example; // String | User
        String userDept = userDept_example; // String | User department (userDept)
        String purpose = purpose_example; // String | Purpose
        String os = os_example; // String | OS
        Boolean isGuestUser = true; // Boolean | Guest enabled
        String ip = ip_example; // String | IP
        String mac = mac_example; // String | MAC
        String pcName = pcName_example; // String | Hostname
        String confirmAppType = confirmAppType_example; // String | Approval Type (prevapp: Submitted, nextapp: Approved)
        String dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date) String fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) String toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { apiInstance.getIpApplications(page, pageSize, sort, confirmStatus, appType, qsearch, appTypeCode, applicantUser, applicantDept, user, userDept, purpose, os, isGuestUser, ip, mac, pcName, confirmAppType, dateRangeType, fromDate, toDate); } catch (ApiException e) { System.err.println("Exception when calling ApplicationsApi#getIpApplications"); e.printStackTrace(); } } }
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *confirmStatus = confirmStatus_example; // Hierarchical Approval status (ready, complete, confirm, reject, progress) (optional)
String *appType = appType_example; // Request Type (newreturn, new, return, devchange, userchange) (optional)
String *qsearch = qsearch_example; // Search string (optional)
String *appTypeCode = appTypeCode_example; // appTypeCode (optional)
String *applicantUser = applicantUser_example; // Requester (optional)
String *applicantDept = applicantDept_example; // Requester department (applicantDept) (optional)
String *user = user_example; // User (optional)
String *userDept = userDept_example; // User department (userDept) (optional)
String *purpose = purpose_example; // Purpose (optional)
String *os = os_example; // OS (optional)
Boolean *isGuestUser = true; // Guest enabled (optional)
String *ip = ip_example; // IP (optional)
String *mac = mac_example; // MAC (optional)
String *pcName = pcName_example; // Hostname (optional)
String *confirmAppType = confirmAppType_example; // Approval Type (prevapp: Submitted, nextapp: Approved) (optional)
String *dateRangeType = dateRangeType_example; // Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date) (optional) String *fromDate = fromDate_example; // Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) String *toDate = toDate_example; // End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) ApplicationsApi *apiInstance = [[ApplicationsApi alloc] init]; // Retrieve a specific IP Request's information [apiInstance getIpApplicationsWith:page pageSize:pageSize sort:sort confirmStatus:confirmStatus appType:appType qsearch:qsearch appTypeCode:appTypeCode applicantUser:applicantUser applicantDept:applicantDept user:user userDept:userDept purpose:purpose os:os isGuestUser:isGuestUser ip:ip mac:mac pcName:pcName confirmAppType:confirmAppType dateRangeType:dateRangeType fromDate:fromDate toDate:toDate completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'confirmStatus': confirmStatus_example, // {String} Hierarchical Approval status (ready, complete, confirm, reject, progress)
  'appType': appType_example, // {String} Request Type (newreturn, new, return, devchange, userchange)
  'qsearch': qsearch_example, // {String} Search string
  'appTypeCode': appTypeCode_example, // {String} appTypeCode
  'applicantUser': applicantUser_example, // {String} Requester
  'applicantDept': applicantDept_example, // {String} Requester department (applicantDept)
  'user': user_example, // {String} User
  'userDept': userDept_example, // {String} User department (userDept)
  'purpose': purpose_example, // {String} Purpose
  'os': os_example, // {String} OS
  'isGuestUser': true, // {Boolean} Guest enabled
  'ip': ip_example, // {String} IP
  'mac': mac_example, // {String} MAC
  'pcName': pcName_example, // {String} Hostname
  'confirmAppType': confirmAppType_example, // {String} Approval Type (prevapp: Submitted, nextapp: Approved)
  'dateRangeType': dateRangeType_example, // {String} Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date) 'fromDate': fromDate_example, // {String} Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) 'toDate': toDate_example // {String} End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.getIpApplications(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIpApplicationsExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var confirmStatus = confirmStatus_example;  // String | Hierarchical Approval status (ready, complete, confirm, reject, progress) (optional) 
            var appType = appType_example;  // String | Request Type (newreturn, new, return, devchange, userchange) (optional) 
            var qsearch = qsearch_example;  // String | Search string (optional) 
            var appTypeCode = appTypeCode_example;  // String | appTypeCode (optional) 
            var applicantUser = applicantUser_example;  // String | Requester (optional) 
            var applicantDept = applicantDept_example;  // String | Requester department (applicantDept) (optional) 
            var user = user_example;  // String | User (optional) 
            var userDept = userDept_example;  // String | User department (userDept) (optional) 
            var purpose = purpose_example;  // String | Purpose (optional) 
            var os = os_example;  // String | OS (optional) 
            var isGuestUser = true;  // Boolean | Guest enabled (optional) 
            var ip = ip_example;  // String | IP (optional) 
            var mac = mac_example;  // String | MAC (optional) 
            var pcName = pcName_example;  // String | Hostname (optional) 
            var confirmAppType = confirmAppType_example;  // String | Approval Type (prevapp: Submitted, nextapp: Approved) (optional) 
            var dateRangeType = dateRangeType_example;  // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date) (optional) var fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) var toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) try { // Retrieve a specific IP Request's information apiInstance.getIpApplications(page, pageSize, sort, confirmStatus, appType, qsearch, appTypeCode, applicantUser, applicantDept, user, userDept, purpose, os, isGuestUser, ip, mac, pcName, confirmAppType, dateRangeType, fromDate, toDate); } catch (Exception e) { Debug.Print("Exception when calling ApplicationsApi.getIpApplications: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$confirmStatus = confirmStatus_example; // String | Hierarchical Approval status (ready, complete, confirm, reject, progress)
$appType = appType_example; // String | Request Type (newreturn, new, return, devchange, userchange)
$qsearch = qsearch_example; // String | Search string
$appTypeCode = appTypeCode_example; // String | appTypeCode
$applicantUser = applicantUser_example; // String | Requester
$applicantDept = applicantDept_example; // String | Requester department (applicantDept)
$user = user_example; // String | User
$userDept = userDept_example; // String | User department (userDept)
$purpose = purpose_example; // String | Purpose
$os = os_example; // String | OS
$isGuestUser = true; // Boolean | Guest enabled
$ip = ip_example; // String | IP
$mac = mac_example; // String | MAC
$pcName = pcName_example; // String | Hostname
$confirmAppType = confirmAppType_example; // String | Approval Type (prevapp: Submitted, nextapp: Approved)
$dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date) $fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) $toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { $api_instance->getIpApplications($page, $pageSize, $sort, $confirmStatus, $appType, $qsearch, $appTypeCode, $applicantUser, $applicantDept, $user, $userDept, $purpose, $os, $isGuestUser, $ip, $mac, $pcName, $confirmAppType, $dateRangeType, $fromDate, $toDate); } catch (Exception $e) { echo 'Exception when calling ApplicationsApi->getIpApplications: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $confirmStatus = confirmStatus_example; # String | Hierarchical Approval status (ready, complete, confirm, reject, progress)
my $appType = appType_example; # String | Request Type (newreturn, new, return, devchange, userchange)
my $qsearch = qsearch_example; # String | Search string
my $appTypeCode = appTypeCode_example; # String | appTypeCode
my $applicantUser = applicantUser_example; # String | Requester
my $applicantDept = applicantDept_example; # String | Requester department (applicantDept)
my $user = user_example; # String | User
my $userDept = userDept_example; # String | User department (userDept)
my $purpose = purpose_example; # String | Purpose
my $os = os_example; # String | OS
my $isGuestUser = true; # Boolean | Guest enabled
my $ip = ip_example; # String | IP
my $mac = mac_example; # String | MAC
my $pcName = pcName_example; # String | Hostname
my $confirmAppType = confirmAppType_example; # String | Approval Type (prevapp: Submitted, nextapp: Approved)
my $dateRangeType = dateRangeType_example; # String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date) my $fromDate = fromDate_example; # String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) my $toDate = toDate_example; # String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) eval { $api_instance->getIpApplications(page => $page, pageSize => $pageSize, sort => $sort, confirmStatus => $confirmStatus, appType => $appType, qsearch => $qsearch, appTypeCode => $appTypeCode, applicantUser => $applicantUser, applicantDept => $applicantDept, user => $user, userDept => $userDept, purpose => $purpose, os => $os, isGuestUser => $isGuestUser, ip => $ip, mac => $mac, pcName => $pcName, confirmAppType => $confirmAppType, dateRangeType => $dateRangeType, fromDate => $fromDate, toDate => $toDate); }; if ($@) { warn "Exception when calling ApplicationsApi->getIpApplications: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
confirmStatus = confirmStatus_example # String | Hierarchical Approval status (ready, complete, confirm, reject, progress) (optional)
appType = appType_example # String | Request Type (newreturn, new, return, devchange, userchange) (optional)
qsearch = qsearch_example # String | Search string (optional)
appTypeCode = appTypeCode_example # String | appTypeCode (optional)
applicantUser = applicantUser_example # String | Requester (optional)
applicantDept = applicantDept_example # String | Requester department (applicantDept) (optional)
user = user_example # String | User (optional)
userDept = userDept_example # String | User department (userDept) (optional)
purpose = purpose_example # String | Purpose (optional)
os = os_example # String | OS (optional)
isGuestUser = true # Boolean | Guest enabled (optional)
ip = ip_example # String | IP (optional)
mac = mac_example # String | MAC (optional)
pcName = pcName_example # String | Hostname (optional)
confirmAppType = confirmAppType_example # String | Approval Type (prevapp: Submitted, nextapp: Approved) (optional)
dateRangeType = dateRangeType_example # String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date) (optional) fromDate = fromDate_example # String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) toDate = toDate_example # String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) try: # Retrieve a specific IP Request's information api_instance.get_ip_applications(page, pageSize, sort=sort, confirmStatus=confirmStatus, appType=appType, qsearch=qsearch, appTypeCode=appTypeCode, applicantUser=applicantUser, applicantDept=applicantDept, user=user, userDept=userDept, purpose=purpose, os=os, isGuestUser=isGuestUser, ip=ip, mac=mac, pcName=pcName, confirmAppType=confirmAppType, dateRangeType=dateRangeType, fromDate=fromDate, toDate=toDate) except ApiException as e: print("Exception when calling ApplicationsApi->getIpApplications: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
confirmStatus
String
Hierarchical Approval status (ready, complete, confirm, reject, progress)
appType
String
Request Type (newreturn, new, return, devchange, userchange)
qsearch
String
Search string
appTypeCode
String
appTypeCode
applicantUser
String
Requester
applicantDept
String
Requester department (applicantDept)
user
String
User
userDept
String
User department (userDept)
purpose
String
Purpose
os
String
OS
isGuestUser
Boolean
Guest enabled
ip
String
IP
mac
String
MAC
pcName
String
Hostname
confirmAppType
String
Approval Type (prevapp: Submitted, nextapp: Approved)
dateRangeType
String
Period search Type. <b>Please enter the fromDate and toDate when searching for a period.</b><br /> (createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use, ipUseStartDate: Start date of use, ipUsePeriodDate: End date of use, expiredDate: Expiry date)
fromDate
String
Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss)
toDate
String
End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss)

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getMediaApplication

Retrieve a specific External Device Request's information

Retrieves the information of the External Device Request specified.


/applications/medias/{idx}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/medias/{idx}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer idx = 56; // Integer | External Device Request idx
        try {
            apiInstance.getMediaApplication(idx);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getMediaApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer idx = 56; // Integer | External Device Request idx
        try {
            apiInstance.getMediaApplication(idx);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getMediaApplication");
            e.printStackTrace();
        }
    }
}
Integer *idx = 56; // External Device Request idx

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

// Retrieve a specific External Device Request's information
[apiInstance getMediaApplicationWith:idx
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var idx = 56; // {Integer} External Device Request idx


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

namespace Example
{
    public class getMediaApplicationExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var idx = 56;  // Integer | External Device Request idx

            try
            {
                // Retrieve a specific External Device Request's information
                apiInstance.getMediaApplication(idx);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getMediaApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$idx = 56; // Integer | External Device Request idx

try {
    $api_instance->getMediaApplication($idx);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->getMediaApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $idx = 56; # Integer | External Device Request idx

eval { 
    $api_instance->getMediaApplication(idx => $idx);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->getMediaApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
idx = 56 # Integer | External Device Request idx

try: 
    # Retrieve a specific External Device Request's information
    api_instance.get_media_application(idx)
except ApiException as e:
    print("Exception when calling ApplicationsApi->getMediaApplication: %s\n" % e)

Parameters

Path parameters
Name Description
idx*
Integer (int32)
External Device Request idx
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getMediaApplications

List External Device Requests

Retrieves a list of the External Device Requests.


/applications/medias

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/medias?page=&pageSize=&sort=&application=&qsearch=&dateRangeType=&fromDate=&toDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        Boolean application = true; // Boolean | Approval status (true: Submitted, false: Approved)
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | Search string
        String dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date) String fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) String toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { apiInstance.getMediaApplications(page, pageSize, application, sort, qsearch, dateRangeType, fromDate, toDate); } catch (ApiException e) { System.err.println("Exception when calling ApplicationsApi#getMediaApplications"); e.printStackTrace(); } } }
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        Boolean application = true; // Boolean | Approval status (true: Submitted, false: Approved)
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | Search string
        String dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date) String fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) String toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { apiInstance.getMediaApplications(page, pageSize, application, sort, qsearch, dateRangeType, fromDate, toDate); } catch (ApiException e) { System.err.println("Exception when calling ApplicationsApi#getMediaApplications"); e.printStackTrace(); } } }
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
Boolean *application = true; // Approval status (true: Submitted, false: Approved)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *qsearch = qsearch_example; // Search string (optional)
String *dateRangeType = dateRangeType_example; // Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date) (optional) String *fromDate = fromDate_example; // Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) String *toDate = toDate_example; // End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) ApplicationsApi *apiInstance = [[ApplicationsApi alloc] init]; // List External Device Requests [apiInstance getMediaApplicationsWith:page pageSize:pageSize application:application sort:sort qsearch:qsearch dateRangeType:dateRangeType fromDate:fromDate toDate:toDate completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var application = true; // {Boolean} Approval status (true: Submitted, false: Approved)

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'qsearch': qsearch_example, // {String} Search string
  'dateRangeType': dateRangeType_example, // {String} Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date) 'fromDate': fromDate_example, // {String} Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) 'toDate': toDate_example // {String} End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.getMediaApplications(page, pageSize, application, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMediaApplicationsExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var application = true;  // Boolean | Approval status (true: Submitted, false: Approved)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var qsearch = qsearch_example;  // String | Search string (optional) 
            var dateRangeType = dateRangeType_example;  // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date) (optional) var fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) var toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) try { // List External Device Requests apiInstance.getMediaApplications(page, pageSize, application, sort, qsearch, dateRangeType, fromDate, toDate); } catch (Exception e) { Debug.Print("Exception when calling ApplicationsApi.getMediaApplications: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$application = true; // Boolean | Approval status (true: Submitted, false: Approved)
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$qsearch = qsearch_example; // String | Search string
$dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date) $fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) $toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { $api_instance->getMediaApplications($page, $pageSize, $application, $sort, $qsearch, $dateRangeType, $fromDate, $toDate); } catch (Exception $e) { echo 'Exception when calling ApplicationsApi->getMediaApplications: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $application = true; # Boolean | Approval status (true: Submitted, false: Approved)
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $qsearch = qsearch_example; # String | Search string
my $dateRangeType = dateRangeType_example; # String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date) my $fromDate = fromDate_example; # String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) my $toDate = toDate_example; # String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) eval { $api_instance->getMediaApplications(page => $page, pageSize => $pageSize, application => $application, sort => $sort, qsearch => $qsearch, dateRangeType => $dateRangeType, fromDate => $fromDate, toDate => $toDate); }; if ($@) { warn "Exception when calling ApplicationsApi->getMediaApplications: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
application = true # Boolean | Approval status (true: Submitted, false: Approved)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
qsearch = qsearch_example # String | Search string (optional)
dateRangeType = dateRangeType_example # String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date) (optional) fromDate = fromDate_example # String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) toDate = toDate_example # String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) try: # List External Device Requests api_instance.get_media_applications(page, pageSize, application, sort=sort, qsearch=qsearch, dateRangeType=dateRangeType, fromDate=fromDate, toDate=toDate) except ApiException as e: print("Exception when calling ApplicationsApi->getMediaApplications: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
application*
Boolean
Approval status (true: Submitted, false: Approved)
Required
qsearch
String
Search string
dateRangeType
String
Period search Type. <b>Please enter the fromDate and toDate when searching for a period.</b><br /> (createDate: Registration date, confirmDate: Approval date, expiredDate: Expiry date)
fromDate
String
Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss)
toDate
String
End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss)

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getSensorsForPurpose

Retrieve sensor list for purpose


/applications/ips/sensors/{purpose}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/ips/sensors/{purpose}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        String purpose = purpose_example; // String | Purpose code
        try {
            apiInstance.getSensorsForPurpose(purpose);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getSensorsForPurpose");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String purpose = purpose_example; // String | Purpose code
        try {
            apiInstance.getSensorsForPurpose(purpose);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getSensorsForPurpose");
            e.printStackTrace();
        }
    }
}
String *purpose = purpose_example; // Purpose code

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

// Retrieve sensor list for purpose
[apiInstance getSensorsForPurposeWith:purpose
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var purpose = purpose_example; // {String} Purpose code


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

namespace Example
{
    public class getSensorsForPurposeExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var purpose = purpose_example;  // String | Purpose code

            try
            {
                // Retrieve sensor list for purpose
                apiInstance.getSensorsForPurpose(purpose);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getSensorsForPurpose: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$purpose = purpose_example; // String | Purpose code

try {
    $api_instance->getSensorsForPurpose($purpose);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->getSensorsForPurpose: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $purpose = purpose_example; # String | Purpose code

eval { 
    $api_instance->getSensorsForPurpose(purpose => $purpose);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->getSensorsForPurpose: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
purpose = purpose_example # String | Purpose code

try: 
    # Retrieve sensor list for purpose
    api_instance.get_sensors_for_purpose(purpose)
except ApiException as e:
    print("Exception when calling ApplicationsApi->getSensorsForPurpose: %s\n" % e)

Parameters

Path parameters
Name Description
purpose*
String
Purpose code
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getUserApplication

Retrieve a specific User Account Request's information

Retrieves the information of the User Account Request specified.


/applications/users/{idx}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/users/{idx}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Long idx = 789; // Long | User Account Request idx
        try {
            apiInstance.getUserApplication(idx);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getUserApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Long idx = 789; // Long | User Account Request idx
        try {
            apiInstance.getUserApplication(idx);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getUserApplication");
            e.printStackTrace();
        }
    }
}
Long *idx = 789; // User Account Request idx

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

// Retrieve a specific User Account Request's information
[apiInstance getUserApplicationWith:idx
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var idx = 789; // {Long} User Account Request idx


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

namespace Example
{
    public class getUserApplicationExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var idx = 789;  // Long | User Account Request idx

            try
            {
                // Retrieve a specific User Account Request's information
                apiInstance.getUserApplication(idx);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getUserApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$idx = 789; // Long | User Account Request idx

try {
    $api_instance->getUserApplication($idx);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->getUserApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $idx = 789; # Long | User Account Request idx

eval { 
    $api_instance->getUserApplication(idx => $idx);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->getUserApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
idx = 789 # Long | User Account Request idx

try: 
    # Retrieve a specific User Account Request's information
    api_instance.get_user_application(idx)
except ApiException as e:
    print("Exception when calling ApplicationsApi->getUserApplication: %s\n" % e)

Parameters

Path parameters
Name Description
idx*
Long (int64)
User Account Request idx
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getUserApplications

List User Account Requests

Retrieves a list of the User Account Requests.


/applications/users

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/applications/users?page=&pageSize=&sort=&confirmStatus=&appType=&qsearch=&dateRangeType=&fromDate=&toDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String confirmStatus = confirmStatus_example; // String | Hierarchical Approval status
        String appType = appType_example; // String | Request Type (new)
        String qsearch = qsearch_example; // String | Search string
        String dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use) String fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) String toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { apiInstance.getUserApplications(page, pageSize, sort, confirmStatus, appType, qsearch, dateRangeType, fromDate, toDate); } catch (ApiException e) { System.err.println("Exception when calling ApplicationsApi#getUserApplications"); e.printStackTrace(); } } }
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String confirmStatus = confirmStatus_example; // String | Hierarchical Approval status
        String appType = appType_example; // String | Request Type (new)
        String qsearch = qsearch_example; // String | Search string
        String dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use) String fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) String toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { apiInstance.getUserApplications(page, pageSize, sort, confirmStatus, appType, qsearch, dateRangeType, fromDate, toDate); } catch (ApiException e) { System.err.println("Exception when calling ApplicationsApi#getUserApplications"); e.printStackTrace(); } } }
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *confirmStatus = confirmStatus_example; // Hierarchical Approval status (optional)
String *appType = appType_example; // Request Type (new) (optional)
String *qsearch = qsearch_example; // Search string (optional)
String *dateRangeType = dateRangeType_example; // Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use) (optional) String *fromDate = fromDate_example; // Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) String *toDate = toDate_example; // End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) ApplicationsApi *apiInstance = [[ApplicationsApi alloc] init]; // List User Account Requests [apiInstance getUserApplicationsWith:page pageSize:pageSize sort:sort confirmStatus:confirmStatus appType:appType qsearch:qsearch dateRangeType:dateRangeType fromDate:fromDate toDate:toDate completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'confirmStatus': confirmStatus_example, // {String} Hierarchical Approval status
  'appType': appType_example, // {String} Request Type (new)
  'qsearch': qsearch_example, // {String} Search string
  'dateRangeType': dateRangeType_example, // {String} Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use) 'fromDate': fromDate_example, // {String} Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) 'toDate': toDate_example // {String} End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.getUserApplications(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserApplicationsExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var confirmStatus = confirmStatus_example;  // String | Hierarchical Approval status (optional) 
            var appType = appType_example;  // String | Request Type (new) (optional) 
            var qsearch = qsearch_example;  // String | Search string (optional) 
            var dateRangeType = dateRangeType_example;  // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use) (optional) var fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) var toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) try { // List User Account Requests apiInstance.getUserApplications(page, pageSize, sort, confirmStatus, appType, qsearch, dateRangeType, fromDate, toDate); } catch (Exception e) { Debug.Print("Exception when calling ApplicationsApi.getUserApplications: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$confirmStatus = confirmStatus_example; // String | Hierarchical Approval status
$appType = appType_example; // String | Request Type (new)
$qsearch = qsearch_example; // String | Search string
$dateRangeType = dateRangeType_example; // String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use) $fromDate = fromDate_example; // String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) $toDate = toDate_example; // String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) try { $api_instance->getUserApplications($page, $pageSize, $sort, $confirmStatus, $appType, $qsearch, $dateRangeType, $fromDate, $toDate); } catch (Exception $e) { echo 'Exception when calling ApplicationsApi->getUserApplications: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $confirmStatus = confirmStatus_example; # String | Hierarchical Approval status
my $appType = appType_example; # String | Request Type (new)
my $qsearch = qsearch_example; # String | Search string
my $dateRangeType = dateRangeType_example; # String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use) my $fromDate = fromDate_example; # String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) my $toDate = toDate_example; # String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) eval { $api_instance->getUserApplications(page => $page, pageSize => $pageSize, sort => $sort, confirmStatus => $confirmStatus, appType => $appType, qsearch => $qsearch, dateRangeType => $dateRangeType, fromDate => $fromDate, toDate => $toDate); }; if ($@) { warn "Exception when calling ApplicationsApi->getUserApplications: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
confirmStatus = confirmStatus_example # String | Hierarchical Approval status (optional)
appType = appType_example # String | Request Type (new) (optional)
qsearch = qsearch_example # String | Search string (optional)
dateRangeType = dateRangeType_example # String | Period search Type. Please enter the fromDate and toDate when searching for a period.
(createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use) (optional) fromDate = fromDate_example # String | Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) toDate = toDate_example # String | End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss) (optional) try: # List User Account Requests api_instance.get_user_applications(page, pageSize, sort=sort, confirmStatus=confirmStatus, appType=appType, qsearch=qsearch, dateRangeType=dateRangeType, fromDate=fromDate, toDate=toDate) except ApiException as e: print("Exception when calling ApplicationsApi->getUserApplications: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
confirmStatus
String
Hierarchical Approval status
appType
String
Request Type (new)
qsearch
String
Search string
dateRangeType
String
Period search Type. <b>Please enter the fromDate and toDate when searching for a period.</b><br /> (createDate: Registration date, confirmDate: Approval date, userPeriodDate: Period of use)
fromDate
String
Start Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss)
toDate
String
End Date (Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss)

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


updateIpApplication

Update an existing IP Request

Updates an existing IP Request.


/applications/ips/{idx}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/applications/ips/{idx}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Long idx = 789; // Long | IP Request / Return idx
        String cmd = cmd_example; // String | IP Request Approval (approve: Accept, reject: Reject)
        try {
            apiInstance.updateIpApplication(idx, cmd);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#updateIpApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Long idx = 789; // Long | IP Request / Return idx
        String cmd = cmd_example; // String | IP Request Approval (approve: Accept, reject: Reject)
        try {
            apiInstance.updateIpApplication(idx, cmd);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#updateIpApplication");
            e.printStackTrace();
        }
    }
}
Long *idx = 789; // IP Request / Return idx
String *cmd = cmd_example; // IP Request Approval (approve: Accept, reject: Reject)

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

// Update an existing IP Request
[apiInstance updateIpApplicationWith:idx
    cmd:cmd
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var idx = 789; // {Long} IP Request / Return idx

var cmd = cmd_example; // {String} IP Request Approval (approve: Accept, reject: Reject)


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

namespace Example
{
    public class updateIpApplicationExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var idx = 789;  // Long | IP Request / Return idx
            var cmd = cmd_example;  // String | IP Request Approval (approve: Accept, reject: Reject)

            try
            {
                // Update an existing IP Request
                apiInstance.updateIpApplication(idx, cmd);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.updateIpApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$idx = 789; // Long | IP Request / Return idx
$cmd = cmd_example; // String | IP Request Approval (approve: Accept, reject: Reject)

try {
    $api_instance->updateIpApplication($idx, $cmd);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->updateIpApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $idx = 789; # Long | IP Request / Return idx
my $cmd = cmd_example; # String | IP Request Approval (approve: Accept, reject: Reject)

eval { 
    $api_instance->updateIpApplication(idx => $idx, cmd => $cmd);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->updateIpApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
idx = 789 # Long | IP Request / Return idx
cmd = cmd_example # String | IP Request Approval (approve: Accept, reject: Reject)

try: 
    # Update an existing IP Request
    api_instance.update_ip_application(idx, cmd)
except ApiException as e:
    print("Exception when calling ApplicationsApi->updateIpApplication: %s\n" % e)

Parameters

Path parameters
Name Description
idx*
Long (int64)
IP Request / Return idx
Required
Form parameters
Name Description
cmd*
String
IP Request Approval (approve: Accept, reject: Reject)
Enum: approve, reject
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not found

Status: 500 - Internal Server Error


updateMediaApplication

Update an existing External Device Request

Updates an existing External Device Request.


/applications/medias/{idx}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/applications/medias/{idx}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        String cmd = cmd_example; // String | Request Approval (approve: Accept, deny: Reject, expire: Disable)
        Long idx = 789; // Long | External Device Request idx
        String reason = reason_example; // String | Approval Comments (for deny, expire only)
        try {
            apiInstance.updateMediaApplication(cmd, idx, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#updateMediaApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String cmd = cmd_example; // String | Request Approval (approve: Accept, deny: Reject, expire: Disable)
        Long idx = 789; // Long | External Device Request idx
        String reason = reason_example; // String | Approval Comments (for deny, expire only)
        try {
            apiInstance.updateMediaApplication(cmd, idx, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#updateMediaApplication");
            e.printStackTrace();
        }
    }
}
String *cmd = cmd_example; // Request Approval (approve: Accept, deny: Reject, expire: Disable)
Long *idx = 789; // External Device Request idx
String *reason = reason_example; // Approval Comments (for deny, expire only) (optional)

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

// Update an existing External Device Request
[apiInstance updateMediaApplicationWith:cmd
    idx:idx
    reason:reason
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var cmd = cmd_example; // {String} Request Approval (approve: Accept, deny: Reject, expire: Disable)

var idx = 789; // {Long} External Device Request idx

var opts = { 
  'reason': reason_example // {String} Approval Comments (for deny, expire only)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateMediaApplication(cmd, idx, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateMediaApplicationExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var cmd = cmd_example;  // String | Request Approval (approve: Accept, deny: Reject, expire: Disable)
            var idx = 789;  // Long | External Device Request idx
            var reason = reason_example;  // String | Approval Comments (for deny, expire only) (optional) 

            try
            {
                // Update an existing External Device Request
                apiInstance.updateMediaApplication(cmd, idx, reason);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.updateMediaApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$cmd = cmd_example; // String | Request Approval (approve: Accept, deny: Reject, expire: Disable)
$idx = 789; // Long | External Device Request idx
$reason = reason_example; // String | Approval Comments (for deny, expire only)

try {
    $api_instance->updateMediaApplication($cmd, $idx, $reason);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->updateMediaApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $cmd = cmd_example; # String | Request Approval (approve: Accept, deny: Reject, expire: Disable)
my $idx = 789; # Long | External Device Request idx
my $reason = reason_example; # String | Approval Comments (for deny, expire only)

eval { 
    $api_instance->updateMediaApplication(cmd => $cmd, idx => $idx, reason => $reason);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->updateMediaApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
cmd = cmd_example # String | Request Approval (approve: Accept, deny: Reject, expire: Disable)
idx = 789 # Long | External Device Request idx
reason = reason_example # String | Approval Comments (for deny, expire only) (optional)

try: 
    # Update an existing External Device Request
    api_instance.update_media_application(cmd, idx, reason=reason)
except ApiException as e:
    print("Exception when calling ApplicationsApi->updateMediaApplication: %s\n" % e)

Parameters

Path parameters
Name Description
idx*
Long (int64)
External Device Request idx
Required
Form parameters
Name Description
cmd*
String
Request Approval (approve: Accept, deny: Reject, expire: Disable)
Enum: approve, deny, expire
Required
reason
String
Approval Comments (for deny, expire only)

Responses

Status: 401 - Unauthorized

Status: 404 - Data Not Found

Status: 500 - Internal Server Error


updateUserApplication

Update an existing User Account Request

Updates an existing User Account Request.


/applications/users/{idx}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/applications/users/{idx}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        String cmd = cmd_example; // String | User Account Request Approval(approve: Accept, reject: Reject)
        Long idx = 789; // Long | User Account Request idx
        try {
            apiInstance.updateUserApplication(cmd, idx);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#updateUserApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String cmd = cmd_example; // String | User Account Request Approval(approve: Accept, reject: Reject)
        Long idx = 789; // Long | User Account Request idx
        try {
            apiInstance.updateUserApplication(cmd, idx);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#updateUserApplication");
            e.printStackTrace();
        }
    }
}
String *cmd = cmd_example; // User Account Request Approval(approve: Accept, reject: Reject)
Long *idx = 789; // User Account Request idx

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

// Update an existing User Account Request
[apiInstance updateUserApplicationWith:cmd
    idx:idx
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApplicationsApi()

var cmd = cmd_example; // {String} User Account Request Approval(approve: Accept, reject: Reject)

var idx = 789; // {Long} User Account Request idx


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

namespace Example
{
    public class updateUserApplicationExample
    {
        public void main()
        {
            
            var apiInstance = new ApplicationsApi();
            var cmd = cmd_example;  // String | User Account Request Approval(approve: Accept, reject: Reject)
            var idx = 789;  // Long | User Account Request idx

            try
            {
                // Update an existing User Account Request
                apiInstance.updateUserApplication(cmd, idx);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.updateUserApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$cmd = cmd_example; // String | User Account Request Approval(approve: Accept, reject: Reject)
$idx = 789; // Long | User Account Request idx

try {
    $api_instance->updateUserApplication($cmd, $idx);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->updateUserApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $cmd = cmd_example; # String | User Account Request Approval(approve: Accept, reject: Reject)
my $idx = 789; # Long | User Account Request idx

eval { 
    $api_instance->updateUserApplication(cmd => $cmd, idx => $idx);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->updateUserApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
cmd = cmd_example # String | User Account Request Approval(approve: Accept, reject: Reject)
idx = 789 # Long | User Account Request idx

try: 
    # Update an existing User Account Request
    api_instance.update_user_application(cmd, idx)
except ApiException as e:
    print("Exception when calling ApplicationsApi->updateUserApplication: %s\n" % e)

Parameters

Path parameters
Name Description
idx*
Long (int64)
User Account Request idx
Required
Form parameters
Name Description
cmd*
String
User Account Request Approval(approve: Accept, reject: Reject)
Enum: approve, reject
Required

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


Aps

getAPs

List WLANs

Retrieves a list of the WLANs.


/aps

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/aps?page=&pageSize=&sort=&qsearch=&objGroupId=&devid=&apnodemac=&wsubjId=&status=&secproto=&secauth=&protocol=&channel=&channelnumber=&signal=&addTime=&tag=&macId=&ssid=&dupDetect=&allColumns="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApsApi;

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

public class ApsApiExample {

    public static void main(String[] args) {
        
        ApsApi apiInstance = new ApsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | Search string
        String objGroupId = objGroupId_example; // String | WLAN AP Name
        String devid = devid_example; // String | WLAN Device ID
        String apnodemac = apnodemac_example; // String | MAC
        String wsubjId = wsubjId_example; // String | WLAN Group
        String status = status_example; // String | WLAN status
        String secproto = secproto_example; // String | Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs
        String secauth = secauth_example; // String | Security Settings - Authentication Methods (1: PSK, 2: 802.1X)
        String protocol = protocol_example; // String | Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N)
        String channel = channel_example; // String | Frequency
        String channelnumber = channelnumber_example; // String | Channel
        String signal = signal_example; // String | Signal strength
        String addTime = addTime_example; // String | Registered
        String tag = tag_example; // String | Tag
        String macId = macId_example; // String | MAC
        String ssid = ssid_example; // String | SSID
        Boolean dupDetect = true; // Boolean | Duplicated WLANs
        Boolean allColumns = true; // Boolean | Viewing all columns
        try {
            apiInstance.getAPs(page, pageSize, sort, qsearch, objGroupId, devid, apnodemac, wsubjId, status, secproto, secauth, protocol, channel, channelnumber, signal, addTime, tag, macId, ssid, dupDetect, allColumns);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApsApi#getAPs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApsApi;

public class ApsApiExample {

    public static void main(String[] args) {
        ApsApi apiInstance = new ApsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | Search string
        String objGroupId = objGroupId_example; // String | WLAN AP Name
        String devid = devid_example; // String | WLAN Device ID
        String apnodemac = apnodemac_example; // String | MAC
        String wsubjId = wsubjId_example; // String | WLAN Group
        String status = status_example; // String | WLAN status
        String secproto = secproto_example; // String | Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs
        String secauth = secauth_example; // String | Security Settings - Authentication Methods (1: PSK, 2: 802.1X)
        String protocol = protocol_example; // String | Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N)
        String channel = channel_example; // String | Frequency
        String channelnumber = channelnumber_example; // String | Channel
        String signal = signal_example; // String | Signal strength
        String addTime = addTime_example; // String | Registered
        String tag = tag_example; // String | Tag
        String macId = macId_example; // String | MAC
        String ssid = ssid_example; // String | SSID
        Boolean dupDetect = true; // Boolean | Duplicated WLANs
        Boolean allColumns = true; // Boolean | Viewing all columns
        try {
            apiInstance.getAPs(page, pageSize, sort, qsearch, objGroupId, devid, apnodemac, wsubjId, status, secproto, secauth, protocol, channel, channelnumber, signal, addTime, tag, macId, ssid, dupDetect, allColumns);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApsApi#getAPs");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *qsearch = qsearch_example; // Search string (optional)
String *objGroupId = objGroupId_example; // WLAN AP Name (optional)
String *devid = devid_example; // WLAN Device ID (optional)
String *apnodemac = apnodemac_example; // MAC (optional)
String *wsubjId = wsubjId_example; // WLAN Group (optional)
String *status = status_example; // WLAN status (optional)
String *secproto = secproto_example; // Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs (optional)
String *secauth = secauth_example; // Security Settings - Authentication Methods (1: PSK, 2: 802.1X) (optional)
String *protocol = protocol_example; // Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N) (optional)
String *channel = channel_example; // Frequency (optional)
String *channelnumber = channelnumber_example; // Channel (optional)
String *signal = signal_example; // Signal strength (optional)
String *addTime = addTime_example; // Registered (optional)
String *tag = tag_example; // Tag (optional)
String *macId = macId_example; // MAC (optional)
String *ssid = ssid_example; // SSID (optional)
Boolean *dupDetect = true; // Duplicated WLANs (optional) (default to false)
Boolean *allColumns = true; // Viewing all columns (optional)

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

// List WLANs
[apiInstance getAPsWith:page
    pageSize:pageSize
    sort:sort
    qsearch:qsearch
    objGroupId:objGroupId
    devid:devid
    apnodemac:apnodemac
    wsubjId:wsubjId
    status:status
    secproto:secproto
    secauth:secauth
    protocol:protocol
    channel:channel
    channelnumber:channelnumber
    signal:signal
    addTime:addTime
    tag:tag
    macId:macId
    ssid:ssid
    dupDetect:dupDetect
    allColumns:allColumns
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ApsApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'qsearch': qsearch_example, // {String} Search string
  'objGroupId': objGroupId_example, // {String} WLAN AP Name
  'devid': devid_example, // {String} WLAN Device ID
  'apnodemac': apnodemac_example, // {String} MAC
  'wsubjId': wsubjId_example, // {String} WLAN Group
  'status': status_example, // {String} WLAN status
  'secproto': secproto_example, // {String} Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs
  'secauth': secauth_example, // {String} Security Settings - Authentication Methods (1: PSK, 2: 802.1X)
  'protocol': protocol_example, // {String} Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N)
  'channel': channel_example, // {String} Frequency
  'channelnumber': channelnumber_example, // {String} Channel
  'signal': signal_example, // {String} Signal strength
  'addTime': addTime_example, // {String} Registered
  'tag': tag_example, // {String} Tag
  'macId': macId_example, // {String} MAC
  'ssid': ssid_example, // {String} SSID
  'dupDetect': true, // {Boolean} Duplicated WLANs
  'allColumns': true // {Boolean} Viewing all columns
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAPs(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAPsExample
    {
        public void main()
        {
            
            var apiInstance = new ApsApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var qsearch = qsearch_example;  // String | Search string (optional) 
            var objGroupId = objGroupId_example;  // String | WLAN AP Name (optional) 
            var devid = devid_example;  // String | WLAN Device ID (optional) 
            var apnodemac = apnodemac_example;  // String | MAC (optional) 
            var wsubjId = wsubjId_example;  // String | WLAN Group (optional) 
            var status = status_example;  // String | WLAN status (optional) 
            var secproto = secproto_example;  // String | Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs (optional) 
            var secauth = secauth_example;  // String | Security Settings - Authentication Methods (1: PSK, 2: 802.1X) (optional) 
            var protocol = protocol_example;  // String | Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N) (optional) 
            var channel = channel_example;  // String | Frequency (optional) 
            var channelnumber = channelnumber_example;  // String | Channel (optional) 
            var signal = signal_example;  // String | Signal strength (optional) 
            var addTime = addTime_example;  // String | Registered (optional) 
            var tag = tag_example;  // String | Tag (optional) 
            var macId = macId_example;  // String | MAC (optional) 
            var ssid = ssid_example;  // String | SSID (optional) 
            var dupDetect = true;  // Boolean | Duplicated WLANs (optional)  (default to false)
            var allColumns = true;  // Boolean | Viewing all columns (optional) 

            try
            {
                // List WLANs
                apiInstance.getAPs(page, pageSize, sort, qsearch, objGroupId, devid, apnodemac, wsubjId, status, secproto, secauth, protocol, channel, channelnumber, signal, addTime, tag, macId, ssid, dupDetect, allColumns);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApsApi.getAPs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ApsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$qsearch = qsearch_example; // String | Search string
$objGroupId = objGroupId_example; // String | WLAN AP Name
$devid = devid_example; // String | WLAN Device ID
$apnodemac = apnodemac_example; // String | MAC
$wsubjId = wsubjId_example; // String | WLAN Group
$status = status_example; // String | WLAN status
$secproto = secproto_example; // String | Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs
$secauth = secauth_example; // String | Security Settings - Authentication Methods (1: PSK, 2: 802.1X)
$protocol = protocol_example; // String | Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N)
$channel = channel_example; // String | Frequency
$channelnumber = channelnumber_example; // String | Channel
$signal = signal_example; // String | Signal strength
$addTime = addTime_example; // String | Registered
$tag = tag_example; // String | Tag
$macId = macId_example; // String | MAC
$ssid = ssid_example; // String | SSID
$dupDetect = true; // Boolean | Duplicated WLANs
$allColumns = true; // Boolean | Viewing all columns

try {
    $api_instance->getAPs($page, $pageSize, $sort, $qsearch, $objGroupId, $devid, $apnodemac, $wsubjId, $status, $secproto, $secauth, $protocol, $channel, $channelnumber, $signal, $addTime, $tag, $macId, $ssid, $dupDetect, $allColumns);
} catch (Exception $e) {
    echo 'Exception when calling ApsApi->getAPs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApsApi;

my $api_instance = WWW::SwaggerClient::ApsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $qsearch = qsearch_example; # String | Search string
my $objGroupId = objGroupId_example; # String | WLAN AP Name
my $devid = devid_example; # String | WLAN Device ID
my $apnodemac = apnodemac_example; # String | MAC
my $wsubjId = wsubjId_example; # String | WLAN Group
my $status = status_example; # String | WLAN status
my $secproto = secproto_example; # String | Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs
my $secauth = secauth_example; # String | Security Settings - Authentication Methods (1: PSK, 2: 802.1X)
my $protocol = protocol_example; # String | Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N)
my $channel = channel_example; # String | Frequency
my $channelnumber = channelnumber_example; # String | Channel
my $signal = signal_example; # String | Signal strength
my $addTime = addTime_example; # String | Registered
my $tag = tag_example; # String | Tag
my $macId = macId_example; # String | MAC
my $ssid = ssid_example; # String | SSID
my $dupDetect = true; # Boolean | Duplicated WLANs
my $allColumns = true; # Boolean | Viewing all columns

eval { 
    $api_instance->getAPs(page => $page, pageSize => $pageSize, sort => $sort, qsearch => $qsearch, objGroupId => $objGroupId, devid => $devid, apnodemac => $apnodemac, wsubjId => $wsubjId, status => $status, secproto => $secproto, secauth => $secauth, protocol => $protocol, channel => $channel, channelnumber => $channelnumber, signal => $signal, addTime => $addTime, tag => $tag, macId => $macId, ssid => $ssid, dupDetect => $dupDetect, allColumns => $allColumns);
};
if ($@) {
    warn "Exception when calling ApsApi->getAPs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApsApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
qsearch = qsearch_example # String | Search string (optional)
objGroupId = objGroupId_example # String | WLAN AP Name (optional)
devid = devid_example # String | WLAN Device ID (optional)
apnodemac = apnodemac_example # String | MAC (optional)
wsubjId = wsubjId_example # String | WLAN Group (optional)
status = status_example # String | WLAN status (optional)
secproto = secproto_example # String | Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs (optional)
secauth = secauth_example # String | Security Settings - Authentication Methods (1: PSK, 2: 802.1X) (optional)
protocol = protocol_example # String | Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N) (optional)
channel = channel_example # String | Frequency (optional)
channelnumber = channelnumber_example # String | Channel (optional)
signal = signal_example # String | Signal strength (optional)
addTime = addTime_example # String | Registered (optional)
tag = tag_example # String | Tag (optional)
macId = macId_example # String | MAC (optional)
ssid = ssid_example # String | SSID (optional)
dupDetect = true # Boolean | Duplicated WLANs (optional) (default to false)
allColumns = true # Boolean | Viewing all columns (optional)

try: 
    # List WLANs
    api_instance.get_aps(page, pageSize, sort=sort, qsearch=qsearch, objGroupId=objGroupId, devid=devid, apnodemac=apnodemac, wsubjId=wsubjId, status=status, secproto=secproto, secauth=secauth, protocol=protocol, channel=channel, channelnumber=channelnumber, signal=signal, addTime=addTime, tag=tag, macId=macId, ssid=ssid, dupDetect=dupDetect, allColumns=allColumns)
except ApiException as e:
    print("Exception when calling ApsApi->getAPs: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
qsearch
String
Search string
objGroupId
String
WLAN AP Name
devid
String
WLAN Device ID
apnodemac
String
MAC
wsubjId
String
WLAN Group
status
String
WLAN status
secproto
String
Security Settings - Protocol (1:OPEN, 2:WEP, 3:WPA, 4:WPA2, 5:WPAs
secauth
String
Security Settings - Authentication Methods (1: PSK, 2: 802.1X)
protocol
String
Protocol (1: A, 2: B ,4: G, 6: B/G, 9: A/N, 12: G/N, 14: B/G/N, 16: AC, 24: AC/N)
channel
String
Frequency
channelnumber
String
Channel
signal
String
Signal strength
addTime
String
Registered
tag
String
Tag
macId
String
MAC
ssid
String
SSID
dupDetect
Boolean
Duplicated WLANs
allColumns
Boolean
Viewing all columns

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


Cves

getCvePlatformInfo

Platform Search with CVE

Platform Search with CVE.


/cves/{cveId}/platformInfo

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/cves/{cveId}/platformInfo?page=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CvesApi;

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

public class CvesApiExample {

    public static void main(String[] args) {
        
        CvesApi apiInstance = new CvesApi();
        String cveId = cveId_example; // String | CVE ID
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getCvePlatformInfo(cveId, page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling CvesApi#getCvePlatformInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CvesApi;

public class CvesApiExample {

    public static void main(String[] args) {
        CvesApi apiInstance = new CvesApi();
        String cveId = cveId_example; // String | CVE ID
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getCvePlatformInfo(cveId, page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling CvesApi#getCvePlatformInfo");
            e.printStackTrace();
        }
    }
}
String *cveId = cveId_example; // CVE ID
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

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

// Platform Search with CVE
[apiInstance getCvePlatformInfoWith:cveId
    page:page
    pageSize:pageSize
    sort:sort
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.CvesApi()

var cveId = cveId_example; // {String} CVE ID

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getCvePlatformInfo(cveId, page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCvePlatformInfoExample
    {
        public void main()
        {
            
            var apiInstance = new CvesApi();
            var cveId = cveId_example;  // String | CVE ID
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 

            try
            {
                // Platform Search with CVE
                apiInstance.getCvePlatformInfo(cveId, page, pageSize, sort);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CvesApi.getCvePlatformInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CvesApi();
$cveId = cveId_example; // String | CVE ID
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

try {
    $api_instance->getCvePlatformInfo($cveId, $page, $pageSize, $sort);
} catch (Exception $e) {
    echo 'Exception when calling CvesApi->getCvePlatformInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CvesApi;

my $api_instance = WWW::SwaggerClient::CvesApi->new();
my $cveId = cveId_example; # String | CVE ID
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

eval { 
    $api_instance->getCvePlatformInfo(cveId => $cveId, page => $page, pageSize => $pageSize, sort => $sort);
};
if ($@) {
    warn "Exception when calling CvesApi->getCvePlatformInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CvesApi()
cveId = cveId_example # String | CVE ID
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

try: 
    # Platform Search with CVE
    api_instance.get_cve_platform_info(cveId, page, pageSize, sort=sort)
except ApiException as e:
    print("Exception when calling CvesApi->getCvePlatformInfo: %s\n" % e)

Parameters

Path parameters
Name Description
cveId*
String
CVE ID
Required
Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

Responses

Status: 401 - Unauthorized

Status: 404 - Node ID Not Found


getCves

Retrieve a specific Node's CVE(s)

Retrieves the CVE(s) assigned to the Node specified.


/cves

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/cves?page=&pageSize=&qsearch=&mode=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CvesApi;

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

public class CvesApiExample {

    public static void main(String[] args) {
        
        CvesApi apiInstance = new CvesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String qsearch = qsearch_example; // String | Search string
        String mode = mode_example; // String | List mode
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getCves(page, pageSize, qsearch, mode, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling CvesApi#getCves");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CvesApi;

public class CvesApiExample {

    public static void main(String[] args) {
        CvesApi apiInstance = new CvesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String qsearch = qsearch_example; // String | Search string
        String mode = mode_example; // String | List mode
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getCves(page, pageSize, qsearch, mode, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling CvesApi#getCves");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *qsearch = qsearch_example; // Search string (optional)
String *mode = mode_example; // List mode (optional)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

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

// Retrieve a specific Node's CVE(s)
[apiInstance getCvesWith:page
    pageSize:pageSize
    qsearch:qsearch
    mode:mode
    sort:sort
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.CvesApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'qsearch': qsearch_example, // {String} Search string
  'mode': mode_example, // {String} List mode
  'sort': sort_example // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getCves(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCvesExample
    {
        public void main()
        {
            
            var apiInstance = new CvesApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var qsearch = qsearch_example;  // String | Search string (optional) 
            var mode = mode_example;  // String | List mode (optional) 
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 

            try
            {
                // Retrieve a specific Node's CVE(s)
                apiInstance.getCves(page, pageSize, qsearch, mode, sort);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CvesApi.getCves: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CvesApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$qsearch = qsearch_example; // String | Search string
$mode = mode_example; // String | List mode
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

try {
    $api_instance->getCves($page, $pageSize, $qsearch, $mode, $sort);
} catch (Exception $e) {
    echo 'Exception when calling CvesApi->getCves: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CvesApi;

my $api_instance = WWW::SwaggerClient::CvesApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $qsearch = qsearch_example; # String | Search string
my $mode = mode_example; # String | List mode
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

eval { 
    $api_instance->getCves(page => $page, pageSize => $pageSize, qsearch => $qsearch, mode => $mode, sort => $sort);
};
if ($@) {
    warn "Exception when calling CvesApi->getCves: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CvesApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
qsearch = qsearch_example # String | Search string (optional)
mode = mode_example # String | List mode (optional)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

try: 
    # Retrieve a specific Node's CVE(s)
    api_instance.get_cves(page, pageSize, qsearch=qsearch, mode=mode, sort=sort)
except ApiException as e:
    print("Exception when calling CvesApi->getCves: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
qsearch
String
Search string
mode
String
List mode
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

Responses

Status: 401 - Unauthorized

Status: 404 - Node ID Not Found


Devices

createNodeTagsOfDevice

Assign a tag

Assign a Node tag to the device specified.


/devices/{devId}/node/tags

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/devices/{devId}/node/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    public static void main(String[] args) {
        
        DevicesApi apiInstance = new DevicesApi();
        String devId = devId_example; // String | Device ID
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
        try {
            apiInstance.createNodeTagsOfDevice(devId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#createNodeTagsOfDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String devId = devId_example; // String | Device ID
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
        try {
            apiInstance.createNodeTagsOfDevice(devId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#createNodeTagsOfDevice");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Device ID
array[TagVo] *body = ; // Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

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

// Assign a tag
[apiInstance createNodeTagsOfDeviceWith:devId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.DevicesApi()

var devId = devId_example; // {String} Device ID

var body = ; // {array[TagVo]} Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)


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

namespace Example
{
    public class createNodeTagsOfDeviceExample
    {
        public void main()
        {
            
            var apiInstance = new DevicesApi();
            var devId = devId_example;  // String | Device ID
            var body = new array[TagVo](); // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

            try
            {
                // Assign a tag
                apiInstance.createNodeTagsOfDevice(devId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.createNodeTagsOfDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DevicesApi();
$devId = devId_example; // String | Device ID
$body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

try {
    $api_instance->createNodeTagsOfDevice($devId, $body);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->createNodeTagsOfDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DevicesApi;

my $api_instance = WWW::SwaggerClient::DevicesApi->new();
my $devId = devId_example; # String | Device ID
my $body = [WWW::SwaggerClient::Object::array[TagVo]->new()]; # array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

eval { 
    $api_instance->createNodeTagsOfDevice(devId => $devId, body => $body);
};
if ($@) {
    warn "Exception when calling DevicesApi->createNodeTagsOfDevice: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
devId = devId_example # String | Device ID
body =  # array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

try: 
    # Assign a tag
    api_instance.create_node_tags_of_device(devId, body)
except ApiException as e:
    print("Exception when calling DevicesApi->createNodeTagsOfDevice: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Device ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteNodeTagsOfDevice

Remove the tag(s)

Removes the Node tag(s) from the device specified.


/devices/{devId}/node/tags

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/devices/{devId}/node/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    public static void main(String[] args) {
        
        DevicesApi apiInstance = new DevicesApi();
        String devId = devId_example; // String | Device ID
        array[String] body = ; // array[String] | Tag List
        try {
            apiInstance.deleteNodeTagsOfDevice(devId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteNodeTagsOfDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String devId = devId_example; // String | Device ID
        array[String] body = ; // array[String] | Tag List
        try {
            apiInstance.deleteNodeTagsOfDevice(devId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteNodeTagsOfDevice");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Device ID
array[String] *body = ; // Tag List

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

// Remove the tag(s)
[apiInstance deleteNodeTagsOfDeviceWith:devId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.DevicesApi()

var devId = devId_example; // {String} Device ID

var body = ; // {array[String]} Tag List


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

namespace Example
{
    public class deleteNodeTagsOfDeviceExample
    {
        public void main()
        {
            
            var apiInstance = new DevicesApi();
            var devId = devId_example;  // String | Device ID
            var body = new array[String](); // array[String] | Tag List

            try
            {
                // Remove the tag(s)
                apiInstance.deleteNodeTagsOfDevice(devId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.deleteNodeTagsOfDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DevicesApi();
$devId = devId_example; // String | Device ID
$body = ; // array[String] | Tag List

try {
    $api_instance->deleteNodeTagsOfDevice($devId, $body);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->deleteNodeTagsOfDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DevicesApi;

my $api_instance = WWW::SwaggerClient::DevicesApi->new();
my $devId = devId_example; # String | Device ID
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | Tag List

eval { 
    $api_instance->deleteNodeTagsOfDevice(devId => $devId, body => $body);
};
if ($@) {
    warn "Exception when calling DevicesApi->deleteNodeTagsOfDevice: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
devId = devId_example # String | Device ID
body =  # array[String] | Tag List

try: 
    # Remove the tag(s)
    api_instance.delete_node_tags_of_device(devId, body)
except ApiException as e:
    print("Exception when calling DevicesApi->deleteNodeTagsOfDevice: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Device ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getIsActiveAgent

Retrieve whether Agent is installed and active.

Retrieves count the Agent installed and active.


/devices/agent

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/devices/agent?status=&ip=&nodeId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    public static void main(String[] args) {
        
        DevicesApi apiInstance = new DevicesApi();
        String status = status_example; // String | 
        String ip = ip_example; // String | 
        String nodeId = nodeId_example; // String | 
        try {
            apiInstance.getIsActiveAgent(status, ip, nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getIsActiveAgent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String status = status_example; // String | 
        String ip = ip_example; // String | 
        String nodeId = nodeId_example; // String | 
        try {
            apiInstance.getIsActiveAgent(status, ip, nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getIsActiveAgent");
            e.printStackTrace();
        }
    }
}
String *status = status_example; // 
String *ip = ip_example; // 
String *nodeId = nodeId_example; //  (optional)

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

// Retrieve whether Agent is installed and active.
[apiInstance getIsActiveAgentWith:status
    ip:ip
    nodeId:nodeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.DevicesApi()

var status = status_example; // {String} 

var ip = ip_example; // {String} 

var opts = { 
  'nodeId': nodeId_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getIsActiveAgent(status, ip, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getIsActiveAgentExample
    {
        public void main()
        {
            
            var apiInstance = new DevicesApi();
            var status = status_example;  // String | 
            var ip = ip_example;  // String | 
            var nodeId = nodeId_example;  // String |  (optional) 

            try
            {
                // Retrieve whether Agent is installed and active.
                apiInstance.getIsActiveAgent(status, ip, nodeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getIsActiveAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DevicesApi();
$status = status_example; // String | 
$ip = ip_example; // String | 
$nodeId = nodeId_example; // String | 

try {
    $api_instance->getIsActiveAgent($status, $ip, $nodeId);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->getIsActiveAgent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DevicesApi;

my $api_instance = WWW::SwaggerClient::DevicesApi->new();
my $status = status_example; # String | 
my $ip = ip_example; # String | 
my $nodeId = nodeId_example; # String | 

eval { 
    $api_instance->getIsActiveAgent(status => $status, ip => $ip, nodeId => $nodeId);
};
if ($@) {
    warn "Exception when calling DevicesApi->getIsActiveAgent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
status = status_example # String | 
ip = ip_example # String | 
nodeId = nodeId_example # String |  (optional)

try: 
    # Retrieve whether Agent is installed and active.
    api_instance.get_is_active_agent(status, ip, nodeId=nodeId)
except ApiException as e:
    print("Exception when calling DevicesApi->getIsActiveAgent: %s\n" % e)

Parameters

Query parameters
Name Description
status*
String
Required
ip*
String
Required
nodeId
String

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNodeTagsOfDevice

Retrieve a specific device's Node tag(s)

Retrieves the Node tag(s) assigned to the device specified.


/devices/{devId}/node/tags

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/devices/{devId}/node/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    public static void main(String[] args) {
        
        DevicesApi apiInstance = new DevicesApi();
        String devId = devId_example; // String | Device ID
        try {
            apiInstance.getNodeTagsOfDevice(devId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getNodeTagsOfDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String devId = devId_example; // String | Device ID
        try {
            apiInstance.getNodeTagsOfDevice(devId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getNodeTagsOfDevice");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Device ID

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

// Retrieve a specific device's Node tag(s)
[apiInstance getNodeTagsOfDeviceWith:devId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.DevicesApi()

var devId = devId_example; // {String} Device ID


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

namespace Example
{
    public class getNodeTagsOfDeviceExample
    {
        public void main()
        {
            
            var apiInstance = new DevicesApi();
            var devId = devId_example;  // String | Device ID

            try
            {
                // Retrieve a specific device's Node tag(s)
                apiInstance.getNodeTagsOfDevice(devId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getNodeTagsOfDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DevicesApi();
$devId = devId_example; // String | Device ID

try {
    $api_instance->getNodeTagsOfDevice($devId);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->getNodeTagsOfDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DevicesApi;

my $api_instance = WWW::SwaggerClient::DevicesApi->new();
my $devId = devId_example; # String | Device ID

eval { 
    $api_instance->getNodeTagsOfDevice(devId => $devId);
};
if ($@) {
    warn "Exception when calling DevicesApi->getNodeTagsOfDevice: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DevicesApi()
devId = devId_example # String | Device ID

try: 
    # Retrieve a specific device's Node tag(s)
    api_instance.get_node_tags_of_device(devId)
except ApiException as e:
    print("Exception when calling DevicesApi->getNodeTagsOfDevice: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Device ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Device ID Not Found


Groups

getFovoriteApGroups

List Widget WLAN Groups

Retrieves a list of the WLAN Groups assigned to the WLAN Group Widget.


/groups/ap/favorite

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/groups/ap/favorite"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        try {
            apiInstance.getFovoriteApGroups();
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getFovoriteApGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        try {
            apiInstance.getFovoriteApGroups();
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getFovoriteApGroups");
            e.printStackTrace();
        }
    }
}

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

// List Widget WLAN Groups
[apiInstance getFovoriteApGroupsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.GroupsApi()

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

namespace Example
{
    public class getFovoriteApGroupsExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();

            try
            {
                // List Widget WLAN Groups
                apiInstance.getFovoriteApGroups();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.getFovoriteApGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();

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

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

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

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

try: 
    # List Widget WLAN Groups
    api_instance.get_fovorite_ap_groups()
except ApiException as e:
    print("Exception when calling GroupsApi->getFovoriteApGroups: %s\n" % e)

Parameters

Responses

Status: 401 - Unauthorized

Status: 404 - WLAN Group Not Found


getFovoriteNodeGroups

List Widget Node Groups

Retrieves a list of the Node Groups assigned to the Node Group Widget.


/groups/node/favorite

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/groups/node/favorite"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        try {
            apiInstance.getFovoriteNodeGroups();
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getFovoriteNodeGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        try {
            apiInstance.getFovoriteNodeGroups();
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getFovoriteNodeGroups");
            e.printStackTrace();
        }
    }
}

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

// List Widget Node Groups
[apiInstance getFovoriteNodeGroupsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.GroupsApi()

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

namespace Example
{
    public class getFovoriteNodeGroupsExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();

            try
            {
                // List Widget Node Groups
                apiInstance.getFovoriteNodeGroups();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.getFovoriteNodeGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();

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

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

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

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

try: 
    # List Widget Node Groups
    api_instance.get_fovorite_node_groups()
except ApiException as e:
    print("Exception when calling GroupsApi->getFovoriteNodeGroups: %s\n" % e)

Parameters

Responses

Status: 401 - Unauthorized

Status: 404 - Node Group Not Found


Ip

getIPCustomFields

Get custom fields of ip

Gets custom fileds of ip


/ip/customfields

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/ip/customfields?ip=&snid="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IpApi;

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

public class IpApiExample {

    public static void main(String[] args) {
        
        IpApi apiInstance = new IpApi();
        String ip = ip_example; // String | ip
        String snid = snid_example; // String | sensor nid
        try {
            apiInstance.getIPCustomFields(ip, snid);
        } catch (ApiException e) {
            System.err.println("Exception when calling IpApi#getIPCustomFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IpApi;

public class IpApiExample {

    public static void main(String[] args) {
        IpApi apiInstance = new IpApi();
        String ip = ip_example; // String | ip
        String snid = snid_example; // String | sensor nid
        try {
            apiInstance.getIPCustomFields(ip, snid);
        } catch (ApiException e) {
            System.err.println("Exception when calling IpApi#getIPCustomFields");
            e.printStackTrace();
        }
    }
}
String *ip = ip_example; // ip
String *snid = snid_example; // sensor nid

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

// Get custom fields of ip
[apiInstance getIPCustomFieldsWith:ip
    snid:snid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.IpApi()

var ip = ip_example; // {String} ip

var snid = snid_example; // {String} sensor nid


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

namespace Example
{
    public class getIPCustomFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new IpApi();
            var ip = ip_example;  // String | ip
            var snid = snid_example;  // String | sensor nid

            try
            {
                // Get custom fields of ip
                apiInstance.getIPCustomFields(ip, snid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IpApi.getIPCustomFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\IpApi();
$ip = ip_example; // String | ip
$snid = snid_example; // String | sensor nid

try {
    $api_instance->getIPCustomFields($ip, $snid);
} catch (Exception $e) {
    echo 'Exception when calling IpApi->getIPCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::IpApi;

my $api_instance = WWW::SwaggerClient::IpApi->new();
my $ip = ip_example; # String | ip
my $snid = snid_example; # String | sensor nid

eval { 
    $api_instance->getIPCustomFields(ip => $ip, snid => $snid);
};
if ($@) {
    warn "Exception when calling IpApi->getIPCustomFields: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.IpApi()
ip = ip_example # String | ip
snid = snid_example # String | sensor nid

try: 
    # Get custom fields of ip
    api_instance.get_ip_custom_fields(ip, snid)
except ApiException as e:
    print("Exception when calling IpApi->getIPCustomFields: %s\n" % e)

Parameters

Query parameters
Name Description
ip*
String
ip
Required
snid*
String
sensor nid
Required

Responses

Status: default - successful operation


updateIPCustomFields

Update custom fields of ip

Update custom fileds of ip


/ip/customfields

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/ip/customfields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IpApi;

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

public class IpApiExample {

    public static void main(String[] args) {
        
        IpApi apiInstance = new IpApi();
        IPM_TrustMACIPVo body = ; // IPM_TrustMACIPVo | ip custom fields
        try {
            apiInstance.updateIPCustomFields(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling IpApi#updateIPCustomFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IpApi;

public class IpApiExample {

    public static void main(String[] args) {
        IpApi apiInstance = new IpApi();
        IPM_TrustMACIPVo body = ; // IPM_TrustMACIPVo | ip custom fields
        try {
            apiInstance.updateIPCustomFields(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling IpApi#updateIPCustomFields");
            e.printStackTrace();
        }
    }
}
IPM_TrustMACIPVo *body = ; // ip custom fields

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

// Update custom fields of ip
[apiInstance updateIPCustomFieldsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.IpApi()

var body = ; // {IPM_TrustMACIPVo} ip custom fields


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

namespace Example
{
    public class updateIPCustomFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new IpApi();
            var body = new IPM_TrustMACIPVo(); // IPM_TrustMACIPVo | ip custom fields

            try
            {
                // Update custom fields of ip
                apiInstance.updateIPCustomFields(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IpApi.updateIPCustomFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\IpApi();
$body = ; // IPM_TrustMACIPVo | ip custom fields

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

my $api_instance = WWW::SwaggerClient::IpApi->new();
my $body = WWW::SwaggerClient::Object::IPM_TrustMACIPVo->new(); # IPM_TrustMACIPVo | ip custom fields

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

# create an instance of the API class
api_instance = swagger_client.IpApi()
body =  # IPM_TrustMACIPVo | ip custom fields

try: 
    # Update custom fields of ip
    api_instance.update_ip_custom_fields(body)
except ApiException as e:
    print("Exception when calling IpApi->updateIPCustomFields: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: default - successful operation


updateIpPolicies

Configure IP Policy

Executable Commands<br/><br/>ipdeny : Deny IP<br/>ipallow : Allow IP - Disable Conflict Prevention<br/>ipprotect : Allow IP - Enable Conflict Prevention (Allow Specified MAC(s))


/ip/policies

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/ip/policies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IpApi;

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

public class IpApiExample {

    public static void main(String[] args) {
        
        IpApi apiInstance = new IpApi();
        array[IP Policy Value Object] body = ; // array[IP Policy Value Object] | Policy Data
        try {
            Message Value Object result = apiInstance.updateIpPolicies(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IpApi#updateIpPolicies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IpApi;

public class IpApiExample {

    public static void main(String[] args) {
        IpApi apiInstance = new IpApi();
        array[IP Policy Value Object] body = ; // array[IP Policy Value Object] | Policy Data
        try {
            Message Value Object result = apiInstance.updateIpPolicies(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IpApi#updateIpPolicies");
            e.printStackTrace();
        }
    }
}
array[IP Policy Value Object] *body = ; // Policy Data

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

// Configure IP Policy
[apiInstance updateIpPoliciesWith:body
              completionHandler: ^(Message Value Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.IpApi()

var body = ; // {array[IP Policy Value Object]} Policy Data


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

namespace Example
{
    public class updateIpPoliciesExample
    {
        public void main()
        {
            
            var apiInstance = new IpApi();
            var body = new array[IP Policy Value Object](); // array[IP Policy Value Object] | Policy Data

            try
            {
                // Configure IP Policy
                Message Value Object result = apiInstance.updateIpPolicies(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IpApi.updateIpPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\IpApi();
$body = ; // array[IP Policy Value Object] | Policy Data

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

my $api_instance = WWW::SwaggerClient::IpApi->new();
my $body = [WWW::SwaggerClient::Object::array[IP Policy Value Object]->new()]; # array[IP Policy Value Object] | Policy Data

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

# create an instance of the API class
api_instance = swagger_client.IpApi()
body =  # array[IP Policy Value Object] | Policy Data

try: 
    # Configure IP Policy
    api_response = api_instance.update_ip_policies(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IpApi->updateIpPolicies: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 500 - Internal Server Error


Logs

createLogfilter

Create a new log filter

Creates a new log filter.


/logs/filters

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/logs/filters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogsApi;

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

public class LogsApiExample {

    public static void main(String[] args) {
        
        LogsApi apiInstance = new LogsApi();
        LogFilterVo body = ; // LogFilterVo | Log filter
        try {
            apiInstance.createLogfilter(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#createLogfilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LogsApi;

public class LogsApiExample {

    public static void main(String[] args) {
        LogsApi apiInstance = new LogsApi();
        LogFilterVo body = ; // LogFilterVo | Log filter
        try {
            apiInstance.createLogfilter(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#createLogfilter");
            e.printStackTrace();
        }
    }
}
LogFilterVo *body = ; // Log filter

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

// Create a new log filter
[apiInstance createLogfilterWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.LogsApi()

var body = ; // {LogFilterVo} Log filter


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

namespace Example
{
    public class createLogfilterExample
    {
        public void main()
        {
            
            var apiInstance = new LogsApi();
            var body = new LogFilterVo(); // LogFilterVo | Log filter

            try
            {
                // Create a new log filter
                apiInstance.createLogfilter(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LogsApi.createLogfilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogsApi();
$body = ; // LogFilterVo | Log filter

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

my $api_instance = WWW::SwaggerClient::LogsApi->new();
my $body = WWW::SwaggerClient::Object::LogFilterVo->new(); # LogFilterVo | Log filter

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

# create an instance of the API class
api_instance = swagger_client.LogsApi()
body =  # LogFilterVo | Log filter

try: 
    # Create a new log filter
    api_instance.create_logfilter(body)
except ApiException as e:
    print("Exception when calling LogsApi->createLogfilter: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


deleteLogfilters

Delete a specific log filter.

Deletes the log filter specified.


/logs/filters

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/logs/filters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogsApi;

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

public class LogsApiExample {

    public static void main(String[] args) {
        
        LogsApi apiInstance = new LogsApi();
        String ids = ids_example; // String | Log Filter ID (Use a comma to separate entries.)
        try {
            apiInstance.deleteLogfilters(ids);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#deleteLogfilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LogsApi;

public class LogsApiExample {

    public static void main(String[] args) {
        LogsApi apiInstance = new LogsApi();
        String ids = ids_example; // String | Log Filter ID (Use a comma to separate entries.)
        try {
            apiInstance.deleteLogfilters(ids);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#deleteLogfilters");
            e.printStackTrace();
        }
    }
}
String *ids = ids_example; // Log Filter ID (Use a comma to separate entries.)

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

// Delete a specific log filter.
[apiInstance deleteLogfiltersWith:ids
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.LogsApi()

var ids = ids_example; // {String} Log Filter ID (Use a comma to separate entries.)


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

namespace Example
{
    public class deleteLogfiltersExample
    {
        public void main()
        {
            
            var apiInstance = new LogsApi();
            var ids = ids_example;  // String | Log Filter ID (Use a comma to separate entries.)

            try
            {
                // Delete a specific log filter.
                apiInstance.deleteLogfilters(ids);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LogsApi.deleteLogfilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogsApi();
$ids = ids_example; // String | Log Filter ID (Use a comma to separate entries.)

try {
    $api_instance->deleteLogfilters($ids);
} catch (Exception $e) {
    echo 'Exception when calling LogsApi->deleteLogfilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LogsApi;

my $api_instance = WWW::SwaggerClient::LogsApi->new();
my $ids = ids_example; # String | Log Filter ID (Use a comma to separate entries.)

eval { 
    $api_instance->deleteLogfilters(ids => $ids);
};
if ($@) {
    warn "Exception when calling LogsApi->deleteLogfilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
ids = ids_example # String | Log Filter ID (Use a comma to separate entries.)

try: 
    # Delete a specific log filter.
    api_instance.delete_logfilters(ids)
except ApiException as e:
    print("Exception when calling LogsApi->deleteLogfilters: %s\n" % e)

Parameters

Form parameters
Name Description
ids*
String
Log Filter ID (Use a comma to separate entries.)
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getInfoStatus

Information about Elasticsearch indexes

Retrieves information about the Elasticsearch index.


/logs/statusInfo

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/logs/statusInfo?h=&s="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogsApi;

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

public class LogsApiExample {

    public static void main(String[] args) {
        
        LogsApi apiInstance = new LogsApi();
        String h = h_example; // String | (Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size)
        String s = s_example; // String | (Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc)
        try {
            apiInstance.getInfoStatus(h, s);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#getInfoStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LogsApi;

public class LogsApiExample {

    public static void main(String[] args) {
        LogsApi apiInstance = new LogsApi();
        String h = h_example; // String | (Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size)
        String s = s_example; // String | (Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc)
        try {
            apiInstance.getInfoStatus(h, s);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#getInfoStatus");
            e.printStackTrace();
        }
    }
}
String *h = h_example; // (Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size) (optional)
String *s = s_example; // (Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc) (optional)

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

// Information about Elasticsearch indexes
[apiInstance getInfoStatusWith:h
    s:s
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.LogsApi()

var opts = { 
  'h': h_example, // {String} (Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size)
  's': s_example // {String} (Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc)
};

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

namespace Example
{
    public class getInfoStatusExample
    {
        public void main()
        {
            
            var apiInstance = new LogsApi();
            var h = h_example;  // String | (Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size) (optional) 
            var s = s_example;  // String | (Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc) (optional) 

            try
            {
                // Information about Elasticsearch indexes
                apiInstance.getInfoStatus(h, s);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LogsApi.getInfoStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogsApi();
$h = h_example; // String | (Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size)
$s = s_example; // String | (Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc)

try {
    $api_instance->getInfoStatus($h, $s);
} catch (Exception $e) {
    echo 'Exception when calling LogsApi->getInfoStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LogsApi;

my $api_instance = WWW::SwaggerClient::LogsApi->new();
my $h = h_example; # String | (Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size)
my $s = s_example; # String | (Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc)

eval { 
    $api_instance->getInfoStatus(h => $h, s => $s);
};
if ($@) {
    warn "Exception when calling LogsApi->getInfoStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
h = h_example # String | (Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size) (optional)
s = s_example # String | (Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc) (optional)

try: 
    # Information about Elasticsearch indexes
    api_instance.get_info_status(h=h, s=s)
except ApiException as e:
    print("Exception when calling LogsApi->getInfoStatus: %s\n" % e)

Parameters

Query parameters
Name Description
h
String
(Optional) Comma-separated list of column names to display. (e.g., health,status,index,uuid,pri,rep,docs.count,docs.deleted,store.size,pri.store.size)
s
String
(Optional) Comma-separated list of column names or column aliases used to sort the response. (e.g., index:desc)

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getLog

log raw data

Retrieves raw data of the log.


/logs/{index}/{type}/{id}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/logs/{index}/{type}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogsApi;

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

public class LogsApiExample {

    public static void main(String[] args) {
        
        LogsApi apiInstance = new LogsApi();
        String index = index_example; // String | Elastic Index
        String type = type_example; // String | Elastic Type
        String id = id_example; // String | doc id
        try {
            apiInstance.getLog(index, type, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#getLog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LogsApi;

public class LogsApiExample {

    public static void main(String[] args) {
        LogsApi apiInstance = new LogsApi();
        String index = index_example; // String | Elastic Index
        String type = type_example; // String | Elastic Type
        String id = id_example; // String | doc id
        try {
            apiInstance.getLog(index, type, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#getLog");
            e.printStackTrace();
        }
    }
}
String *index = index_example; // Elastic Index
String *type = type_example; // Elastic Type
String *id = id_example; // doc id

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

// log raw data
[apiInstance getLogWith:index
    type:type
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.LogsApi()

var index = index_example; // {String} Elastic Index

var type = type_example; // {String} Elastic Type

var id = id_example; // {String} doc id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getLog(index, type, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLogExample
    {
        public void main()
        {
            
            var apiInstance = new LogsApi();
            var index = index_example;  // String | Elastic Index
            var type = type_example;  // String | Elastic Type
            var id = id_example;  // String | doc id

            try
            {
                // log raw data
                apiInstance.getLog(index, type, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LogsApi.getLog: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogsApi();
$index = index_example; // String | Elastic Index
$type = type_example; // String | Elastic Type
$id = id_example; // String | doc id

try {
    $api_instance->getLog($index, $type, $id);
} catch (Exception $e) {
    echo 'Exception when calling LogsApi->getLog: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LogsApi;

my $api_instance = WWW::SwaggerClient::LogsApi->new();
my $index = index_example; # String | Elastic Index
my $type = type_example; # String | Elastic Type
my $id = id_example; # String | doc id

eval { 
    $api_instance->getLog(index => $index, type => $type, id => $id);
};
if ($@) {
    warn "Exception when calling LogsApi->getLog: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
index = index_example # String | Elastic Index
type = type_example # String | Elastic Type
id = id_example # String | doc id

try: 
    # log raw data
    api_instance.get_log(index, type, id)
except ApiException as e:
    print("Exception when calling LogsApi->getLog: %s\n" % e)

Parameters

Path parameters
Name Description
index*
String
Elastic Index
Required
type*
String
Elastic Type
Required
id*
String
doc id
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getLogfilter

Add a new log filter object

Adds a new log filter object.


/logs/filters/{id}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/logs/filters/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogsApi;

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

public class LogsApiExample {

    public static void main(String[] args) {
        
        LogsApi apiInstance = new LogsApi();
        String id = id_example; // String | Log Filter ID
        try {
            apiInstance.getLogfilter(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#getLogfilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LogsApi;

public class LogsApiExample {

    public static void main(String[] args) {
        LogsApi apiInstance = new LogsApi();
        String id = id_example; // String | Log Filter ID
        try {
            apiInstance.getLogfilter(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#getLogfilter");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Log Filter ID

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

// Add a new log filter object
[apiInstance getLogfilterWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.LogsApi()

var id = id_example; // {String} Log Filter ID


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

namespace Example
{
    public class getLogfilterExample
    {
        public void main()
        {
            
            var apiInstance = new LogsApi();
            var id = id_example;  // String | Log Filter ID

            try
            {
                // Add a new log filter object
                apiInstance.getLogfilter(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LogsApi.getLogfilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogsApi();
$id = id_example; // String | Log Filter ID

try {
    $api_instance->getLogfilter($id);
} catch (Exception $e) {
    echo 'Exception when calling LogsApi->getLogfilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LogsApi;

my $api_instance = WWW::SwaggerClient::LogsApi->new();
my $id = id_example; # String | Log Filter ID

eval { 
    $api_instance->getLogfilter(id => $id);
};
if ($@) {
    warn "Exception when calling LogsApi->getLogfilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
id = id_example # String | Log Filter ID

try: 
    # Add a new log filter object
    api_instance.get_logfilter(id)
except ApiException as e:
    print("Exception when calling LogsApi->getLogfilter: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Log Filter ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getLogfilters

List Log Filters

Retrieves a list of the Log Filters.


/logs/filters

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/logs/filters?page=&pageSize=&sort=&view=&ids=&name=&description=&isTreeDisplay=&isStatic="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogsApi;

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

public class LogsApiExample {

    public static void main(String[] args) {
        
        LogsApi apiInstance = new LogsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String view = view_example; // String | View (monitor, general)
        String ids = ids_example; // String | Log Filter ID
Note: Use a comma to separate entries. String name = name_example; // String | Name String description = description_example; // String | Description Boolean isTreeDisplay = true; // Boolean | Tree & Log Monitor Configured String isStatic = isStatic_example; // String | Is Static try { apiInstance.getLogfilters(page, pageSize, sort, view, ids, name, description, isTreeDisplay, isStatic); } catch (ApiException e) { System.err.println("Exception when calling LogsApi#getLogfilters"); e.printStackTrace(); } } }
import io.swagger.client.api.LogsApi;

public class LogsApiExample {

    public static void main(String[] args) {
        LogsApi apiInstance = new LogsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String view = view_example; // String | View (monitor, general)
        String ids = ids_example; // String | Log Filter ID
Note: Use a comma to separate entries. String name = name_example; // String | Name String description = description_example; // String | Description Boolean isTreeDisplay = true; // Boolean | Tree & Log Monitor Configured String isStatic = isStatic_example; // String | Is Static try { apiInstance.getLogfilters(page, pageSize, sort, view, ids, name, description, isTreeDisplay, isStatic); } catch (ApiException e) { System.err.println("Exception when calling LogsApi#getLogfilters"); e.printStackTrace(); } } }
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *view = view_example; // View (monitor, general) (optional)
String *ids = ids_example; // Log Filter ID
Note: Use a comma to separate entries. (optional) String *name = name_example; // Name (optional) String *description = description_example; // Description (optional) Boolean *isTreeDisplay = true; // Tree & Log Monitor Configured (optional) String *isStatic = isStatic_example; // Is Static (optional) LogsApi *apiInstance = [[LogsApi alloc] init]; // List Log Filters [apiInstance getLogfiltersWith:page pageSize:pageSize sort:sort view:view ids:ids name:name description:description isTreeDisplay:isTreeDisplay isStatic:isStatic completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.LogsApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'view': view_example, // {String} View (monitor, general)
  'ids': ids_example, // {String} Log Filter ID
Note: Use a comma to separate entries. 'name': name_example, // {String} Name 'description': description_example, // {String} Description 'isTreeDisplay': true, // {Boolean} Tree & Log Monitor Configured 'isStatic': isStatic_example // {String} Is Static }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.getLogfilters(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLogfiltersExample
    {
        public void main()
        {
            
            var apiInstance = new LogsApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var view = view_example;  // String | View (monitor, general) (optional) 
            var ids = ids_example;  // String | Log Filter ID
Note: Use a comma to separate entries. (optional) var name = name_example; // String | Name (optional) var description = description_example; // String | Description (optional) var isTreeDisplay = true; // Boolean | Tree & Log Monitor Configured (optional) var isStatic = isStatic_example; // String | Is Static (optional) try { // List Log Filters apiInstance.getLogfilters(page, pageSize, sort, view, ids, name, description, isTreeDisplay, isStatic); } catch (Exception e) { Debug.Print("Exception when calling LogsApi.getLogfilters: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$view = view_example; // String | View (monitor, general)
$ids = ids_example; // String | Log Filter ID
Note: Use a comma to separate entries. $name = name_example; // String | Name $description = description_example; // String | Description $isTreeDisplay = true; // Boolean | Tree & Log Monitor Configured $isStatic = isStatic_example; // String | Is Static try { $api_instance->getLogfilters($page, $pageSize, $sort, $view, $ids, $name, $description, $isTreeDisplay, $isStatic); } catch (Exception $e) { echo 'Exception when calling LogsApi->getLogfilters: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LogsApi;

my $api_instance = WWW::SwaggerClient::LogsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $view = view_example; # String | View (monitor, general)
my $ids = ids_example; # String | Log Filter ID
Note: Use a comma to separate entries. my $name = name_example; # String | Name my $description = description_example; # String | Description my $isTreeDisplay = true; # Boolean | Tree & Log Monitor Configured my $isStatic = isStatic_example; # String | Is Static eval { $api_instance->getLogfilters(page => $page, pageSize => $pageSize, sort => $sort, view => $view, ids => $ids, name => $name, description => $description, isTreeDisplay => $isTreeDisplay, isStatic => $isStatic); }; if ($@) { warn "Exception when calling LogsApi->getLogfilters: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
view = view_example # String | View (monitor, general) (optional)
ids = ids_example # String | Log Filter ID
Note: Use a comma to separate entries. (optional) name = name_example # String | Name (optional) description = description_example # String | Description (optional) isTreeDisplay = true # Boolean | Tree & Log Monitor Configured (optional) isStatic = isStatic_example # String | Is Static (optional) try: # List Log Filters api_instance.get_logfilters(page, pageSize, sort=sort, view=view, ids=ids, name=name, description=description, isTreeDisplay=isTreeDisplay, isStatic=isStatic) except ApiException as e: print("Exception when calling LogsApi->getLogfilters: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
view
String
View (monitor, general)
ids
String
Log Filter ID<br/>Note: Use a comma to separate entries.
name
String
Name
description
String
Description
isTreeDisplay
Boolean
Tree & Log Monitor Configured
isStatic
String
Is Static

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getLogs

List Logs

Retrieves a list of the logs.


/logs

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/logs?page=&pageSize=&sort=&logschema=&auditlogTypes=&periodType=&startdate=&enddate=&fromtime=&totime=&logfilterid=&ip=&mac=&userid=&username=&description=&loglevel=&logid=&sensorname=&extrainfo=&deptname=&qsearch=&ssid=&nasmac=&nasip=&nasporttype=&nasport=&radiuspolicy="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogsApi;

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

public class LogsApiExample {

    public static void main(String[] args) {
        
        LogsApi apiInstance = new LogsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String logschema = logschema_example; // String | Log Schema
        String sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        array[String] auditlogTypes = ; // array[String] | Auditlog Type (Used when Type is selected as auditlog)
        String periodType = periodType_example; // String | Period
        String startdate = startdate_example; // String | Start Date + Time (yyyy-MM-dd HH:mm:ss)
        String enddate = enddate_example; // String | End Date + Time (yyyy-MM-dd HH:mm:ss)
        String fromtime = fromtime_example; // String | From Time (HH:mm)
        String totime = totime_example; // String | To Time (HH:mm)
        String logfilterid = logfilterid_example; // String | Log Filter ID
        String ip = ip_example; // String | IP
        String mac = mac_example; // String | MAC
        String userid = userid_example; // String | Username
        String username = username_example; // String | Full Name
        String description = description_example; // String | Description
        String loglevel = loglevel_example; // String | Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)
Note: Use a comma to separate entries. String logid = logid_example; // String | Log ID
Note: Use a comma to separate entries. String sensorname = sensorname_example; // String | Node Name of Policy Server String extrainfo = extrainfo_example; // String | Remarks String deptname = deptname_example; // String | Department String qsearch = qsearch_example; // String | Qsearch String ssid = ssid_example; // String | SSID (only radius log) String nasmac = nasmac_example; // String | NAS MAC (only radius log) String nasip = nasip_example; // String | NAS IP (only radius log) String nasporttype = nasporttype_example; // String | NAS Port Type
Note: Use a comma to separate entries. String nasport = nasport_example; // String | NAS Port String radiuspolicy = radiuspolicy_example; // String | RADIUS POLICY try { apiInstance.getLogs(page, pageSize, logschema, sort, auditlogTypes, periodType, startdate, enddate, fromtime, totime, logfilterid, ip, mac, userid, username, description, loglevel, logid, sensorname, extrainfo, deptname, qsearch, ssid, nasmac, nasip, nasporttype, nasport, radiuspolicy); } catch (ApiException e) { System.err.println("Exception when calling LogsApi#getLogs"); e.printStackTrace(); } } }
import io.swagger.client.api.LogsApi;

public class LogsApiExample {

    public static void main(String[] args) {
        LogsApi apiInstance = new LogsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String logschema = logschema_example; // String | Log Schema
        String sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        array[String] auditlogTypes = ; // array[String] | Auditlog Type (Used when Type is selected as auditlog)
        String periodType = periodType_example; // String | Period
        String startdate = startdate_example; // String | Start Date + Time (yyyy-MM-dd HH:mm:ss)
        String enddate = enddate_example; // String | End Date + Time (yyyy-MM-dd HH:mm:ss)
        String fromtime = fromtime_example; // String | From Time (HH:mm)
        String totime = totime_example; // String | To Time (HH:mm)
        String logfilterid = logfilterid_example; // String | Log Filter ID
        String ip = ip_example; // String | IP
        String mac = mac_example; // String | MAC
        String userid = userid_example; // String | Username
        String username = username_example; // String | Full Name
        String description = description_example; // String | Description
        String loglevel = loglevel_example; // String | Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)
Note: Use a comma to separate entries. String logid = logid_example; // String | Log ID
Note: Use a comma to separate entries. String sensorname = sensorname_example; // String | Node Name of Policy Server String extrainfo = extrainfo_example; // String | Remarks String deptname = deptname_example; // String | Department String qsearch = qsearch_example; // String | Qsearch String ssid = ssid_example; // String | SSID (only radius log) String nasmac = nasmac_example; // String | NAS MAC (only radius log) String nasip = nasip_example; // String | NAS IP (only radius log) String nasporttype = nasporttype_example; // String | NAS Port Type
Note: Use a comma to separate entries. String nasport = nasport_example; // String | NAS Port String radiuspolicy = radiuspolicy_example; // String | RADIUS POLICY try { apiInstance.getLogs(page, pageSize, logschema, sort, auditlogTypes, periodType, startdate, enddate, fromtime, totime, logfilterid, ip, mac, userid, username, description, loglevel, logid, sensorname, extrainfo, deptname, qsearch, ssid, nasmac, nasip, nasporttype, nasport, radiuspolicy); } catch (ApiException e) { System.err.println("Exception when calling LogsApi#getLogs"); e.printStackTrace(); } } }
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *logschema = logschema_example; // Log Schema (default to auditlog)
String *sort = sort_example; // Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
array[String] *auditlogTypes = ; // Auditlog Type (Used when Type is selected as auditlog) (optional)
String *periodType = periodType_example; // Period (optional) (default to custom)
String *startdate = startdate_example; // Start Date + Time (yyyy-MM-dd HH:mm:ss) (optional)
String *enddate = enddate_example; // End Date + Time (yyyy-MM-dd HH:mm:ss) (optional)
String *fromtime = fromtime_example; // From Time (HH:mm) (optional)
String *totime = totime_example; // To Time (HH:mm) (optional)
String *logfilterid = logfilterid_example; // Log Filter ID (optional)
String *ip = ip_example; // IP (optional)
String *mac = mac_example; // MAC (optional)
String *userid = userid_example; // Username (optional)
String *username = username_example; // Full Name (optional)
String *description = description_example; // Description (optional)
String *loglevel = loglevel_example; // Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)
Note: Use a comma to separate entries. (optional) String *logid = logid_example; // Log ID
Note: Use a comma to separate entries. (optional) String *sensorname = sensorname_example; // Node Name of Policy Server (optional) String *extrainfo = extrainfo_example; // Remarks (optional) String *deptname = deptname_example; // Department (optional) String *qsearch = qsearch_example; // Qsearch (optional) String *ssid = ssid_example; // SSID (only radius log) (optional) String *nasmac = nasmac_example; // NAS MAC (only radius log) (optional) String *nasip = nasip_example; // NAS IP (only radius log) (optional) String *nasporttype = nasporttype_example; // NAS Port Type
Note: Use a comma to separate entries. (optional) String *nasport = nasport_example; // NAS Port (optional) String *radiuspolicy = radiuspolicy_example; // RADIUS POLICY (optional) LogsApi *apiInstance = [[LogsApi alloc] init]; // List Logs [apiInstance getLogsWith:page pageSize:pageSize logschema:logschema sort:sort auditlogTypes:auditlogTypes periodType:periodType startdate:startdate enddate:enddate fromtime:fromtime totime:totime logfilterid:logfilterid ip:ip mac:mac userid:userid username:username description:description loglevel:loglevel logid:logid sensorname:sensorname extrainfo:extrainfo deptname:deptname qsearch:qsearch ssid:ssid nasmac:nasmac nasip:nasip nasporttype:nasporttype nasport:nasport radiuspolicy:radiuspolicy completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.LogsApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var logschema = logschema_example; // {String} Log Schema

var opts = { 
  'sort': sort_example, // {String} Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'auditlogTypes': , // {array[String]} Auditlog Type (Used when Type is selected as auditlog)
  'periodType': periodType_example, // {String} Period
  'startdate': startdate_example, // {String} Start Date + Time (yyyy-MM-dd HH:mm:ss)
  'enddate': enddate_example, // {String} End Date + Time (yyyy-MM-dd HH:mm:ss)
  'fromtime': fromtime_example, // {String} From Time (HH:mm)
  'totime': totime_example, // {String} To Time (HH:mm)
  'logfilterid': logfilterid_example, // {String} Log Filter ID
  'ip': ip_example, // {String} IP
  'mac': mac_example, // {String} MAC
  'userid': userid_example, // {String} Username
  'username': username_example, // {String} Full Name
  'description': description_example, // {String} Description
  'loglevel': loglevel_example, // {String} Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)
Note: Use a comma to separate entries. 'logid': logid_example, // {String} Log ID
Note: Use a comma to separate entries. 'sensorname': sensorname_example, // {String} Node Name of Policy Server 'extrainfo': extrainfo_example, // {String} Remarks 'deptname': deptname_example, // {String} Department 'qsearch': qsearch_example, // {String} Qsearch 'ssid': ssid_example, // {String} SSID (only radius log) 'nasmac': nasmac_example, // {String} NAS MAC (only radius log) 'nasip': nasip_example, // {String} NAS IP (only radius log) 'nasporttype': nasporttype_example, // {String} NAS Port Type
Note: Use a comma to separate entries. 'nasport': nasport_example, // {String} NAS Port 'radiuspolicy': radiuspolicy_example // {String} RADIUS POLICY }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.getLogs(page, pageSize, logschema, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLogsExample
    {
        public void main()
        {
            
            var apiInstance = new LogsApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var logschema = logschema_example;  // String | Log Schema (default to auditlog)
            var sort = sort_example;  // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var auditlogTypes = new array[String](); // array[String] | Auditlog Type (Used when Type is selected as auditlog) (optional) 
            var periodType = periodType_example;  // String | Period (optional)  (default to custom)
            var startdate = startdate_example;  // String | Start Date + Time (yyyy-MM-dd HH:mm:ss) (optional) 
            var enddate = enddate_example;  // String | End Date + Time (yyyy-MM-dd HH:mm:ss) (optional) 
            var fromtime = fromtime_example;  // String | From Time (HH:mm) (optional) 
            var totime = totime_example;  // String | To Time (HH:mm) (optional) 
            var logfilterid = logfilterid_example;  // String | Log Filter ID (optional) 
            var ip = ip_example;  // String | IP (optional) 
            var mac = mac_example;  // String | MAC (optional) 
            var userid = userid_example;  // String | Username (optional) 
            var username = username_example;  // String | Full Name (optional) 
            var description = description_example;  // String | Description (optional) 
            var loglevel = loglevel_example;  // String | Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)
Note: Use a comma to separate entries. (optional) var logid = logid_example; // String | Log ID
Note: Use a comma to separate entries. (optional) var sensorname = sensorname_example; // String | Node Name of Policy Server (optional) var extrainfo = extrainfo_example; // String | Remarks (optional) var deptname = deptname_example; // String | Department (optional) var qsearch = qsearch_example; // String | Qsearch (optional) var ssid = ssid_example; // String | SSID (only radius log) (optional) var nasmac = nasmac_example; // String | NAS MAC (only radius log) (optional) var nasip = nasip_example; // String | NAS IP (only radius log) (optional) var nasporttype = nasporttype_example; // String | NAS Port Type
Note: Use a comma to separate entries. (optional) var nasport = nasport_example; // String | NAS Port (optional) var radiuspolicy = radiuspolicy_example; // String | RADIUS POLICY (optional) try { // List Logs apiInstance.getLogs(page, pageSize, logschema, sort, auditlogTypes, periodType, startdate, enddate, fromtime, totime, logfilterid, ip, mac, userid, username, description, loglevel, logid, sensorname, extrainfo, deptname, qsearch, ssid, nasmac, nasip, nasporttype, nasport, radiuspolicy); } catch (Exception e) { Debug.Print("Exception when calling LogsApi.getLogs: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$logschema = logschema_example; // String | Log Schema
$sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$auditlogTypes = ; // array[String] | Auditlog Type (Used when Type is selected as auditlog)
$periodType = periodType_example; // String | Period
$startdate = startdate_example; // String | Start Date + Time (yyyy-MM-dd HH:mm:ss)
$enddate = enddate_example; // String | End Date + Time (yyyy-MM-dd HH:mm:ss)
$fromtime = fromtime_example; // String | From Time (HH:mm)
$totime = totime_example; // String | To Time (HH:mm)
$logfilterid = logfilterid_example; // String | Log Filter ID
$ip = ip_example; // String | IP
$mac = mac_example; // String | MAC
$userid = userid_example; // String | Username
$username = username_example; // String | Full Name
$description = description_example; // String | Description
$loglevel = loglevel_example; // String | Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)
Note: Use a comma to separate entries. $logid = logid_example; // String | Log ID
Note: Use a comma to separate entries. $sensorname = sensorname_example; // String | Node Name of Policy Server $extrainfo = extrainfo_example; // String | Remarks $deptname = deptname_example; // String | Department $qsearch = qsearch_example; // String | Qsearch $ssid = ssid_example; // String | SSID (only radius log) $nasmac = nasmac_example; // String | NAS MAC (only radius log) $nasip = nasip_example; // String | NAS IP (only radius log) $nasporttype = nasporttype_example; // String | NAS Port Type
Note: Use a comma to separate entries. $nasport = nasport_example; // String | NAS Port $radiuspolicy = radiuspolicy_example; // String | RADIUS POLICY try { $api_instance->getLogs($page, $pageSize, $logschema, $sort, $auditlogTypes, $periodType, $startdate, $enddate, $fromtime, $totime, $logfilterid, $ip, $mac, $userid, $username, $description, $loglevel, $logid, $sensorname, $extrainfo, $deptname, $qsearch, $ssid, $nasmac, $nasip, $nasporttype, $nasport, $radiuspolicy); } catch (Exception $e) { echo 'Exception when calling LogsApi->getLogs: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LogsApi;

my $api_instance = WWW::SwaggerClient::LogsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $logschema = logschema_example; # String | Log Schema
my $sort = sort_example; # String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $auditlogTypes = []; # array[String] | Auditlog Type (Used when Type is selected as auditlog)
my $periodType = periodType_example; # String | Period
my $startdate = startdate_example; # String | Start Date + Time (yyyy-MM-dd HH:mm:ss)
my $enddate = enddate_example; # String | End Date + Time (yyyy-MM-dd HH:mm:ss)
my $fromtime = fromtime_example; # String | From Time (HH:mm)
my $totime = totime_example; # String | To Time (HH:mm)
my $logfilterid = logfilterid_example; # String | Log Filter ID
my $ip = ip_example; # String | IP
my $mac = mac_example; # String | MAC
my $userid = userid_example; # String | Username
my $username = username_example; # String | Full Name
my $description = description_example; # String | Description
my $loglevel = loglevel_example; # String | Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)
Note: Use a comma to separate entries. my $logid = logid_example; # String | Log ID
Note: Use a comma to separate entries. my $sensorname = sensorname_example; # String | Node Name of Policy Server my $extrainfo = extrainfo_example; # String | Remarks my $deptname = deptname_example; # String | Department my $qsearch = qsearch_example; # String | Qsearch my $ssid = ssid_example; # String | SSID (only radius log) my $nasmac = nasmac_example; # String | NAS MAC (only radius log) my $nasip = nasip_example; # String | NAS IP (only radius log) my $nasporttype = nasporttype_example; # String | NAS Port Type
Note: Use a comma to separate entries. my $nasport = nasport_example; # String | NAS Port my $radiuspolicy = radiuspolicy_example; # String | RADIUS POLICY eval { $api_instance->getLogs(page => $page, pageSize => $pageSize, logschema => $logschema, sort => $sort, auditlogTypes => $auditlogTypes, periodType => $periodType, startdate => $startdate, enddate => $enddate, fromtime => $fromtime, totime => $totime, logfilterid => $logfilterid, ip => $ip, mac => $mac, userid => $userid, username => $username, description => $description, loglevel => $loglevel, logid => $logid, sensorname => $sensorname, extrainfo => $extrainfo, deptname => $deptname, qsearch => $qsearch, ssid => $ssid, nasmac => $nasmac, nasip => $nasip, nasporttype => $nasporttype, nasport => $nasport, radiuspolicy => $radiuspolicy); }; if ($@) { warn "Exception when calling LogsApi->getLogs: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
logschema = logschema_example # String | Log Schema (default to auditlog)
sort = sort_example # String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
auditlogTypes =  # array[String] | Auditlog Type (Used when Type is selected as auditlog) (optional)
periodType = periodType_example # String | Period (optional) (default to custom)
startdate = startdate_example # String | Start Date + Time (yyyy-MM-dd HH:mm:ss) (optional)
enddate = enddate_example # String | End Date + Time (yyyy-MM-dd HH:mm:ss) (optional)
fromtime = fromtime_example # String | From Time (HH:mm) (optional)
totime = totime_example # String | To Time (HH:mm) (optional)
logfilterid = logfilterid_example # String | Log Filter ID (optional)
ip = ip_example # String | IP (optional)
mac = mac_example # String | MAC (optional)
userid = userid_example # String | Username (optional)
username = username_example # String | Full Name (optional)
description = description_example # String | Description (optional)
loglevel = loglevel_example # String | Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)
Note: Use a comma to separate entries. (optional) logid = logid_example # String | Log ID
Note: Use a comma to separate entries. (optional) sensorname = sensorname_example # String | Node Name of Policy Server (optional) extrainfo = extrainfo_example # String | Remarks (optional) deptname = deptname_example # String | Department (optional) qsearch = qsearch_example # String | Qsearch (optional) ssid = ssid_example # String | SSID (only radius log) (optional) nasmac = nasmac_example # String | NAS MAC (only radius log) (optional) nasip = nasip_example # String | NAS IP (only radius log) (optional) nasporttype = nasporttype_example # String | NAS Port Type
Note: Use a comma to separate entries. (optional) nasport = nasport_example # String | NAS Port (optional) radiuspolicy = radiuspolicy_example # String | RADIUS POLICY (optional) try: # List Logs api_instance.get_logs(page, pageSize, logschema, sort=sort, auditlogTypes=auditlogTypes, periodType=periodType, startdate=startdate, enddate=enddate, fromtime=fromtime, totime=totime, logfilterid=logfilterid, ip=ip, mac=mac, userid=userid, username=username, description=description, loglevel=loglevel, logid=logid, sensorname=sensorname, extrainfo=extrainfo, deptname=deptname, qsearch=qsearch, ssid=ssid, nasmac=nasmac, nasip=nasip, nasporttype=nasporttype, nasport=nasport, radiuspolicy=radiuspolicy) except ApiException as e: print("Exception when calling LogsApi->getLogs: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
logschema*
String
Log Schema
Required
auditlogTypes
array[String]
Auditlog Type (Used when Type is selected as auditlog)
periodType
String
Period
startdate
String
Start Date + Time (yyyy-MM-dd HH:mm:ss)
enddate
String
End Date + Time (yyyy-MM-dd HH:mm:ss)
fromtime
String
From Time (HH:mm)
totime
String
To Time (HH:mm)
logfilterid
String
Log Filter ID
ip
String
IP
mac
String
MAC
userid
String
Username
username
String
Full Name
description
String
Description
loglevel
String
Log Level (0: Error, 1: Warning, 2: Information, 3: Anomaly)<br/>Note: Use a comma to separate entries.
logid
String
Log ID<br/>Note: Use a comma to separate entries.
sensorname
String
Node Name of Policy Server
extrainfo
String
Remarks
deptname
String
Department
qsearch
String
Qsearch
ssid
String
SSID (only radius log)
nasmac
String
NAS MAC (only radius log)
nasip
String
NAS IP (only radius log)
nasporttype
String
NAS Port Type<br/>Note: Use a comma to separate entries.
nasport
String
NAS Port
radiuspolicy
String
RADIUS POLICY

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


updateLogfilter

Update an existing log filter

Updates an existing log filter.


/logs/filters

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/logs/filters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogsApi;

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

public class LogsApiExample {

    public static void main(String[] args) {
        
        LogsApi apiInstance = new LogsApi();
        LogFilterVo body = ; // LogFilterVo | Log Filter
        try {
            apiInstance.updateLogfilter(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#updateLogfilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LogsApi;

public class LogsApiExample {

    public static void main(String[] args) {
        LogsApi apiInstance = new LogsApi();
        LogFilterVo body = ; // LogFilterVo | Log Filter
        try {
            apiInstance.updateLogfilter(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogsApi#updateLogfilter");
            e.printStackTrace();
        }
    }
}
LogFilterVo *body = ; // Log Filter

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

// Update an existing log filter
[apiInstance updateLogfilterWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.LogsApi()

var body = ; // {LogFilterVo} Log Filter


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

namespace Example
{
    public class updateLogfilterExample
    {
        public void main()
        {
            
            var apiInstance = new LogsApi();
            var body = new LogFilterVo(); // LogFilterVo | Log Filter

            try
            {
                // Update an existing log filter
                apiInstance.updateLogfilter(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LogsApi.updateLogfilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogsApi();
$body = ; // LogFilterVo | Log Filter

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

my $api_instance = WWW::SwaggerClient::LogsApi->new();
my $body = WWW::SwaggerClient::Object::LogFilterVo->new(); # LogFilterVo | Log Filter

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

# create an instance of the API class
api_instance = swagger_client.LogsApi()
body =  # LogFilterVo | Log Filter

try: 
    # Update an existing log filter
    api_instance.update_logfilter(body)
except ApiException as e:
    print("Exception when calling LogsApi->updateLogfilter: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


Mac

getMACCustomFields

Get custom fields of mac

Gets custom fileds of mac


/mac/customfields

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/mac/customfields?mac=&snid="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MacApi;

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

public class MacApiExample {

    public static void main(String[] args) {
        
        MacApi apiInstance = new MacApi();
        String mac = mac_example; // String | mac
        String snid = snid_example; // String | sensor nid
        try {
            apiInstance.getMACCustomFields(mac, snid);
        } catch (ApiException e) {
            System.err.println("Exception when calling MacApi#getMACCustomFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MacApi;

public class MacApiExample {

    public static void main(String[] args) {
        MacApi apiInstance = new MacApi();
        String mac = mac_example; // String | mac
        String snid = snid_example; // String | sensor nid
        try {
            apiInstance.getMACCustomFields(mac, snid);
        } catch (ApiException e) {
            System.err.println("Exception when calling MacApi#getMACCustomFields");
            e.printStackTrace();
        }
    }
}
String *mac = mac_example; // mac
String *snid = snid_example; // sensor nid

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

// Get custom fields of mac
[apiInstance getMACCustomFieldsWith:mac
    snid:snid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.MacApi()

var mac = mac_example; // {String} mac

var snid = snid_example; // {String} sensor nid


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

namespace Example
{
    public class getMACCustomFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new MacApi();
            var mac = mac_example;  // String | mac
            var snid = snid_example;  // String | sensor nid

            try
            {
                // Get custom fields of mac
                apiInstance.getMACCustomFields(mac, snid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MacApi.getMACCustomFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MacApi();
$mac = mac_example; // String | mac
$snid = snid_example; // String | sensor nid

try {
    $api_instance->getMACCustomFields($mac, $snid);
} catch (Exception $e) {
    echo 'Exception when calling MacApi->getMACCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MacApi;

my $api_instance = WWW::SwaggerClient::MacApi->new();
my $mac = mac_example; # String | mac
my $snid = snid_example; # String | sensor nid

eval { 
    $api_instance->getMACCustomFields(mac => $mac, snid => $snid);
};
if ($@) {
    warn "Exception when calling MacApi->getMACCustomFields: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.MacApi()
mac = mac_example # String | mac
snid = snid_example # String | sensor nid

try: 
    # Get custom fields of mac
    api_instance.get_mac_custom_fields(mac, snid)
except ApiException as e:
    print("Exception when calling MacApi->getMACCustomFields: %s\n" % e)

Parameters

Query parameters
Name Description
mac*
String
mac
Required
snid*
String
sensor nid
Required

Responses

Status: default - successful operation


updateMACCustomFields

Update custom fields of mac

Update custom fileds of mac


/mac/customfields

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/mac/customfields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MacApi;

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

public class MacApiExample {

    public static void main(String[] args) {
        
        MacApi apiInstance = new MacApi();
        IPM_TrustMACIPVo body = ; // IPM_TrustMACIPVo | mac custom fields
        try {
            apiInstance.updateMACCustomFields(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling MacApi#updateMACCustomFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MacApi;

public class MacApiExample {

    public static void main(String[] args) {
        MacApi apiInstance = new MacApi();
        IPM_TrustMACIPVo body = ; // IPM_TrustMACIPVo | mac custom fields
        try {
            apiInstance.updateMACCustomFields(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling MacApi#updateMACCustomFields");
            e.printStackTrace();
        }
    }
}
IPM_TrustMACIPVo *body = ; // mac custom fields

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

// Update custom fields of mac
[apiInstance updateMACCustomFieldsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.MacApi()

var body = ; // {IPM_TrustMACIPVo} mac custom fields


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

namespace Example
{
    public class updateMACCustomFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new MacApi();
            var body = new IPM_TrustMACIPVo(); // IPM_TrustMACIPVo | mac custom fields

            try
            {
                // Update custom fields of mac
                apiInstance.updateMACCustomFields(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MacApi.updateMACCustomFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MacApi();
$body = ; // IPM_TrustMACIPVo | mac custom fields

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

my $api_instance = WWW::SwaggerClient::MacApi->new();
my $body = WWW::SwaggerClient::Object::IPM_TrustMACIPVo->new(); # IPM_TrustMACIPVo | mac custom fields

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

# create an instance of the API class
api_instance = swagger_client.MacApi()
body =  # IPM_TrustMACIPVo | mac custom fields

try: 
    # Update custom fields of mac
    api_instance.update_mac_custom_fields(body)
except ApiException as e:
    print("Exception when calling MacApi->updateMACCustomFields: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: default - successful operation


updateMACPolicy

Configure MAC Policy

Executable Commands<br/><br/>macdeny : Deny MAC<br/>macallow : Allow MAC - Disable Change Prevention<br/>appointblockipchange : Allow MAC - Enable Change Prevention (Allow Specified IP(s) - Specified IP(s) Network)<br/>blockipchange : Allow MAC - Enable Change Prevention (Allow Specified IP(s) - All Networks)


/mac/policies

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/mac/policies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MacApi;

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

public class MacApiExample {

    public static void main(String[] args) {
        
        MacApi apiInstance = new MacApi();
        array[MAC Policy Value Object] body = ; // array[MAC Policy Value Object] | Policy Data
        try {
            Message Value Object result = apiInstance.updateMACPolicy(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MacApi#updateMACPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MacApi;

public class MacApiExample {

    public static void main(String[] args) {
        MacApi apiInstance = new MacApi();
        array[MAC Policy Value Object] body = ; // array[MAC Policy Value Object] | Policy Data
        try {
            Message Value Object result = apiInstance.updateMACPolicy(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MacApi#updateMACPolicy");
            e.printStackTrace();
        }
    }
}
array[MAC Policy Value Object] *body = ; // Policy Data

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

// Configure MAC Policy
[apiInstance updateMACPolicyWith:body
              completionHandler: ^(Message Value Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.MacApi()

var body = ; // {array[MAC Policy Value Object]} Policy Data


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

namespace Example
{
    public class updateMACPolicyExample
    {
        public void main()
        {
            
            var apiInstance = new MacApi();
            var body = new array[MAC Policy Value Object](); // array[MAC Policy Value Object] | Policy Data

            try
            {
                // Configure MAC Policy
                Message Value Object result = apiInstance.updateMACPolicy(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MacApi.updateMACPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MacApi();
$body = ; // array[MAC Policy Value Object] | Policy Data

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

my $api_instance = WWW::SwaggerClient::MacApi->new();
my $body = [WWW::SwaggerClient::Object::array[MAC Policy Value Object]->new()]; # array[MAC Policy Value Object] | Policy Data

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

# create an instance of the API class
api_instance = swagger_client.MacApi()
body =  # array[MAC Policy Value Object] | Policy Data

try: 
    # Configure MAC Policy
    api_response = api_instance.update_mac_policy(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MacApi->updateMACPolicy: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 500 - Internal Server Error


Nodegroups

createNodeGroup

Add a new Node Group

Adds a new Node Group.


/nodegroups

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/nodegroups?policyAutoApply="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        SubjVo body = ; // SubjVo | SubjVo JSON Data
        String policyAutoApply = policyAutoApply_example; // String | Policy auto apply
        try {
            apiInstance.createNodeGroup(body, policyAutoApply);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#createNodeGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        SubjVo body = ; // SubjVo | SubjVo JSON Data
        String policyAutoApply = policyAutoApply_example; // String | Policy auto apply
        try {
            apiInstance.createNodeGroup(body, policyAutoApply);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#createNodeGroup");
            e.printStackTrace();
        }
    }
}
SubjVo *body = ; // SubjVo JSON Data
String *policyAutoApply = policyAutoApply_example; // Policy auto apply (optional) (default to 1)

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

// Add a new Node Group
[apiInstance createNodeGroupWith:body
    policyAutoApply:policyAutoApply
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

var body = ; // {SubjVo} SubjVo JSON Data

var opts = { 
  'policyAutoApply': policyAutoApply_example // {String} Policy auto apply
};

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

namespace Example
{
    public class createNodeGroupExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();
            var body = new SubjVo(); // SubjVo | SubjVo JSON Data
            var policyAutoApply = policyAutoApply_example;  // String | Policy auto apply (optional)  (default to 1)

            try
            {
                // Add a new Node Group
                apiInstance.createNodeGroup(body, policyAutoApply);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.createNodeGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();
$body = ; // SubjVo | SubjVo JSON Data
$policyAutoApply = policyAutoApply_example; // String | Policy auto apply

try {
    $api_instance->createNodeGroup($body, $policyAutoApply);
} catch (Exception $e) {
    echo 'Exception when calling NodegroupsApi->createNodeGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodegroupsApi;

my $api_instance = WWW::SwaggerClient::NodegroupsApi->new();
my $body = WWW::SwaggerClient::Object::SubjVo->new(); # SubjVo | SubjVo JSON Data
my $policyAutoApply = policyAutoApply_example; # String | Policy auto apply

eval { 
    $api_instance->createNodeGroup(body => $body, policyAutoApply => $policyAutoApply);
};
if ($@) {
    warn "Exception when calling NodegroupsApi->createNodeGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodegroupsApi()
body =  # SubjVo | SubjVo JSON Data
policyAutoApply = policyAutoApply_example # String | Policy auto apply (optional) (default to 1)

try: 
    # Add a new Node Group
    api_instance.create_node_group(body, policyAutoApply=policyAutoApply)
except ApiException as e:
    print("Exception when calling NodegroupsApi->createNodeGroup: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
policyAutoApply
String
Policy auto apply

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


createNodeGroupFilters

Assign a Condition

Assign a Condition to the Node Group specified.


/nodegroups/{id}/filters

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/nodegroups/{id}/filters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | Node Group ID
        array[FilterVo] body = ; // array[FilterVo] | FilterVo List
        try {
            apiInstance.createNodeGroupFilters(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#createNodeGroupFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | Node Group ID
        array[FilterVo] body = ; // array[FilterVo] | FilterVo List
        try {
            apiInstance.createNodeGroupFilters(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#createNodeGroupFilters");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Node Group ID
array[FilterVo] *body = ; // FilterVo List

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

// Assign a Condition
[apiInstance createNodeGroupFiltersWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

var id = id_example; // {String} Node Group ID

var body = ; // {array[FilterVo]} FilterVo List


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

namespace Example
{
    public class createNodeGroupFiltersExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();
            var id = id_example;  // String | Node Group ID
            var body = new array[FilterVo](); // array[FilterVo] | FilterVo List

            try
            {
                // Assign a Condition
                apiInstance.createNodeGroupFilters(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.createNodeGroupFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();
$id = id_example; // String | Node Group ID
$body = ; // array[FilterVo] | FilterVo List

try {
    $api_instance->createNodeGroupFilters($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling NodegroupsApi->createNodeGroupFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodegroupsApi;

my $api_instance = WWW::SwaggerClient::NodegroupsApi->new();
my $id = id_example; # String | Node Group ID
my $body = [WWW::SwaggerClient::Object::array[FilterVo]->new()]; # array[FilterVo] | FilterVo List

eval { 
    $api_instance->createNodeGroupFilters(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling NodegroupsApi->createNodeGroupFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodegroupsApi()
id = id_example # String | Node Group ID
body =  # array[FilterVo] | FilterVo List

try: 
    # Assign a Condition
    api_instance.create_node_group_filters(id, body)
except ApiException as e:
    print("Exception when calling NodegroupsApi->createNodeGroupFilters: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Node Group ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


deleteNodeGroupFilters

Remove the Condition(s)

Removes the Condition(s) from the Node Group specified.


/nodegroups/{id}/filters

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/nodegroups/{id}/filters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | SUBJ_ID
        array[FilterVo] body = ; // array[FilterVo] | FilterVo List
        try {
            apiInstance.deleteNodeGroupFilters(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#deleteNodeGroupFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | SUBJ_ID
        array[FilterVo] body = ; // array[FilterVo] | FilterVo List
        try {
            apiInstance.deleteNodeGroupFilters(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#deleteNodeGroupFilters");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // SUBJ_ID
array[FilterVo] *body = ; // FilterVo List

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

// Remove the Condition(s)
[apiInstance deleteNodeGroupFiltersWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

var id = id_example; // {String} SUBJ_ID

var body = ; // {array[FilterVo]} FilterVo List


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

namespace Example
{
    public class deleteNodeGroupFiltersExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();
            var id = id_example;  // String | SUBJ_ID
            var body = new array[FilterVo](); // array[FilterVo] | FilterVo List

            try
            {
                // Remove the Condition(s)
                apiInstance.deleteNodeGroupFilters(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.deleteNodeGroupFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();
$id = id_example; // String | SUBJ_ID
$body = ; // array[FilterVo] | FilterVo List

try {
    $api_instance->deleteNodeGroupFilters($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling NodegroupsApi->deleteNodeGroupFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodegroupsApi;

my $api_instance = WWW::SwaggerClient::NodegroupsApi->new();
my $id = id_example; # String | SUBJ_ID
my $body = [WWW::SwaggerClient::Object::array[FilterVo]->new()]; # array[FilterVo] | FilterVo List

eval { 
    $api_instance->deleteNodeGroupFilters(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling NodegroupsApi->deleteNodeGroupFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodegroupsApi()
id = id_example # String | SUBJ_ID
body =  # array[FilterVo] | FilterVo List

try: 
    # Remove the Condition(s)
    api_instance.delete_node_group_filters(id, body)
except ApiException as e:
    print("Exception when calling NodegroupsApi->deleteNodeGroupFilters: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
SUBJ_ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getFovoriteNodeGroups

List Widget Node Groups

Retrieves a list of the Node Groups assigned to the Node Group Widget.


/nodegroups/favorite

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodegroups/favorite"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        try {
            apiInstance.getFovoriteNodeGroups();
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getFovoriteNodeGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        try {
            apiInstance.getFovoriteNodeGroups();
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getFovoriteNodeGroups");
            e.printStackTrace();
        }
    }
}

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

// List Widget Node Groups
[apiInstance getFovoriteNodeGroupsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

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

namespace Example
{
    public class getFovoriteNodeGroupsExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();

            try
            {
                // List Widget Node Groups
                apiInstance.getFovoriteNodeGroups();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.getFovoriteNodeGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();

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

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

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

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

try: 
    # List Widget Node Groups
    api_instance.get_fovorite_node_groups()
except ApiException as e:
    print("Exception when calling NodegroupsApi->getFovoriteNodeGroups: %s\n" % e)

Parameters

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNodeGroup

Retrieve a specific Node Group's information

Retrieves the information of the Node Group specified.


/nodegroups/{id}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodegroups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | SUBJ_ID
        try {
            SubjVo result = apiInstance.getNodeGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getNodeGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | SUBJ_ID
        try {
            SubjVo result = apiInstance.getNodeGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getNodeGroup");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // SUBJ_ID

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

// Retrieve a specific Node Group's information
[apiInstance getNodeGroupWith:id
              completionHandler: ^(SubjVo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

var id = id_example; // {String} SUBJ_ID


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

namespace Example
{
    public class getNodeGroupExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();
            var id = id_example;  // String | SUBJ_ID

            try
            {
                // Retrieve a specific Node Group's information
                SubjVo result = apiInstance.getNodeGroup(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.getNodeGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();
$id = id_example; // String | SUBJ_ID

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

my $api_instance = WWW::SwaggerClient::NodegroupsApi->new();
my $id = id_example; # String | SUBJ_ID

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

# create an instance of the API class
api_instance = swagger_client.NodegroupsApi()
id = id_example # String | SUBJ_ID

try: 
    # Retrieve a specific Node Group's information
    api_response = api_instance.get_node_group(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NodegroupsApi->getNodeGroup: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
SUBJ_ID
Required

Responses

Status: 200 - successful operation

Status: 401 - Unauthorized

Status: 404 - Not Found


getNodeGroupDelete

Delete a specific Node Group

Deletes the Node Group specified.


/nodegroups/{id}

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/nodegroups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | SUBJ_ID
        try {
            apiInstance.getNodeGroupDelete(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getNodeGroupDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | SUBJ_ID
        try {
            apiInstance.getNodeGroupDelete(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getNodeGroupDelete");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // SUBJ_ID

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

// Delete a specific Node Group
[apiInstance getNodeGroupDeleteWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

var id = id_example; // {String} SUBJ_ID


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

namespace Example
{
    public class getNodeGroupDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();
            var id = id_example;  // String | SUBJ_ID

            try
            {
                // Delete a specific Node Group
                apiInstance.getNodeGroupDelete(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.getNodeGroupDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();
$id = id_example; // String | SUBJ_ID

try {
    $api_instance->getNodeGroupDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling NodegroupsApi->getNodeGroupDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodegroupsApi;

my $api_instance = WWW::SwaggerClient::NodegroupsApi->new();
my $id = id_example; # String | SUBJ_ID

eval { 
    $api_instance->getNodeGroupDelete(id => $id);
};
if ($@) {
    warn "Exception when calling NodegroupsApi->getNodeGroupDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodegroupsApi()
id = id_example # String | SUBJ_ID

try: 
    # Delete a specific Node Group
    api_instance.get_node_group_delete(id)
except ApiException as e:
    print("Exception when calling NodegroupsApi->getNodeGroupDelete: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
SUBJ_ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 412 - Precondition Failed

Status: 500 - Internal Server Error


getNodeGroupFilters

Retrieve a specific Node Group's Condition(s)

Retrieves the Node Group(s) assigned to the Node Group specified.


/nodegroups/{id}/filters

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodegroups/{id}/filters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | SUBJ_ID
        try {
            apiInstance.getNodeGroupFilters(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getNodeGroupFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        String id = id_example; // String | SUBJ_ID
        try {
            apiInstance.getNodeGroupFilters(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getNodeGroupFilters");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // SUBJ_ID

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

// Retrieve a specific Node Group's Condition(s)
[apiInstance getNodeGroupFiltersWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

var id = id_example; // {String} SUBJ_ID


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

namespace Example
{
    public class getNodeGroupFiltersExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();
            var id = id_example;  // String | SUBJ_ID

            try
            {
                // Retrieve a specific Node Group's Condition(s)
                apiInstance.getNodeGroupFilters(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.getNodeGroupFilters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();
$id = id_example; // String | SUBJ_ID

try {
    $api_instance->getNodeGroupFilters($id);
} catch (Exception $e) {
    echo 'Exception when calling NodegroupsApi->getNodeGroupFilters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodegroupsApi;

my $api_instance = WWW::SwaggerClient::NodegroupsApi->new();
my $id = id_example; # String | SUBJ_ID

eval { 
    $api_instance->getNodeGroupFilters(id => $id);
};
if ($@) {
    warn "Exception when calling NodegroupsApi->getNodeGroupFilters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodegroupsApi()
id = id_example # String | SUBJ_ID

try: 
    # Retrieve a specific Node Group's Condition(s)
    api_instance.get_node_group_filters(id)
except ApiException as e:
    print("Exception when calling NodegroupsApi->getNodeGroupFilters: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
SUBJ_ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNodeGroups

List Node Groups

Retrieves a list of the Node Groups.


/nodegroups

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodegroups?page=&pageSize=&sort=&qsearch=&id=&type=&name=&desc=&objGroupId=&v="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | Search string
        String id = id_example; // String | SUBJ_ID
        String type = type_example; // String | Type (1: Policy Group, 2: Status Group)
        String name = name_example; // String | ID
        String desc = desc_example; // String | Description
        String objGroupId = objGroupId_example; // String | Category
        String v = v_example; // String | Version
        try {
            SubjVo result = apiInstance.getNodeGroups(page, pageSize, sort, qsearch, id, type, name, desc, objGroupId, v);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getNodeGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | Search string
        String id = id_example; // String | SUBJ_ID
        String type = type_example; // String | Type (1: Policy Group, 2: Status Group)
        String name = name_example; // String | ID
        String desc = desc_example; // String | Description
        String objGroupId = objGroupId_example; // String | Category
        String v = v_example; // String | Version
        try {
            SubjVo result = apiInstance.getNodeGroups(page, pageSize, sort, qsearch, id, type, name, desc, objGroupId, v);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#getNodeGroups");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *qsearch = qsearch_example; // Search string (optional)
String *id = id_example; // SUBJ_ID (optional)
String *type = type_example; // Type (1: Policy Group, 2: Status Group) (optional)
String *name = name_example; // ID (optional)
String *desc = desc_example; // Description (optional)
String *objGroupId = objGroupId_example; // Category (optional)
String *v = v_example; // Version (optional)

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

// List Node Groups
[apiInstance getNodeGroupsWith:page
    pageSize:pageSize
    sort:sort
    qsearch:qsearch
    id:id
    type:type
    name:name
    desc:desc
    objGroupId:objGroupId
    v:v
              completionHandler: ^(SubjVo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'qsearch': qsearch_example, // {String} Search string
  'id': id_example, // {String} SUBJ_ID
  'type': type_example, // {String} Type (1: Policy Group, 2: Status Group)
  'name': name_example, // {String} ID
  'desc': desc_example, // {String} Description
  'objGroupId': objGroupId_example, // {String} Category
  'v': v_example // {String} Version
};

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

namespace Example
{
    public class getNodeGroupsExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var qsearch = qsearch_example;  // String | Search string (optional) 
            var id = id_example;  // String | SUBJ_ID (optional) 
            var type = type_example;  // String | Type (1: Policy Group, 2: Status Group) (optional) 
            var name = name_example;  // String | ID (optional) 
            var desc = desc_example;  // String | Description (optional) 
            var objGroupId = objGroupId_example;  // String | Category (optional) 
            var v = v_example;  // String | Version (optional) 

            try
            {
                // List Node Groups
                SubjVo result = apiInstance.getNodeGroups(page, pageSize, sort, qsearch, id, type, name, desc, objGroupId, v);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.getNodeGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$qsearch = qsearch_example; // String | Search string
$id = id_example; // String | SUBJ_ID
$type = type_example; // String | Type (1: Policy Group, 2: Status Group)
$name = name_example; // String | ID
$desc = desc_example; // String | Description
$objGroupId = objGroupId_example; // String | Category
$v = v_example; // String | Version

try {
    $result = $api_instance->getNodeGroups($page, $pageSize, $sort, $qsearch, $id, $type, $name, $desc, $objGroupId, $v);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NodegroupsApi->getNodeGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodegroupsApi;

my $api_instance = WWW::SwaggerClient::NodegroupsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $qsearch = qsearch_example; # String | Search string
my $id = id_example; # String | SUBJ_ID
my $type = type_example; # String | Type (1: Policy Group, 2: Status Group)
my $name = name_example; # String | ID
my $desc = desc_example; # String | Description
my $objGroupId = objGroupId_example; # String | Category
my $v = v_example; # String | Version

eval { 
    my $result = $api_instance->getNodeGroups(page => $page, pageSize => $pageSize, sort => $sort, qsearch => $qsearch, id => $id, type => $type, name => $name, desc => $desc, objGroupId => $objGroupId, v => $v);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NodegroupsApi->getNodeGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodegroupsApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
qsearch = qsearch_example # String | Search string (optional)
id = id_example # String | SUBJ_ID (optional)
type = type_example # String | Type (1: Policy Group, 2: Status Group) (optional)
name = name_example # String | ID (optional)
desc = desc_example # String | Description (optional)
objGroupId = objGroupId_example # String | Category (optional)
v = v_example # String | Version (optional)

try: 
    # List Node Groups
    api_response = api_instance.get_node_groups(page, pageSize, sort=sort, qsearch=qsearch, id=id, type=type, name=name, desc=desc, objGroupId=objGroupId, v=v)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NodegroupsApi->getNodeGroups: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
qsearch
String
Search string
id
String
SUBJ_ID
type
String
Type (1: Policy Group, 2: Status Group)
name
String
ID
desc
String
Description
objGroupId
String
Category
v
String
Version

Responses

Status: 200 - successful operation

Status: 401 - Unauthorized

Status: 404 - Not Found


updateNodeGroup

Update an existing Node Group

Updates an existing Node Group.


/nodegroups/{id}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/nodegroups/{id}?policyAutoApply="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodegroupsApi;

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

public class NodegroupsApiExample {

    public static void main(String[] args) {
        
        NodegroupsApi apiInstance = new NodegroupsApi();
        SubjVo body = ; // SubjVo | SubjVo JSON Data
        String policyAutoApply = policyAutoApply_example; // String | Policy auto apply
        try {
            apiInstance.updateNodeGroup(body, policyAutoApply);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#updateNodeGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodegroupsApi;

public class NodegroupsApiExample {

    public static void main(String[] args) {
        NodegroupsApi apiInstance = new NodegroupsApi();
        SubjVo body = ; // SubjVo | SubjVo JSON Data
        String policyAutoApply = policyAutoApply_example; // String | Policy auto apply
        try {
            apiInstance.updateNodeGroup(body, policyAutoApply);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodegroupsApi#updateNodeGroup");
            e.printStackTrace();
        }
    }
}
SubjVo *body = ; // SubjVo JSON Data
String *policyAutoApply = policyAutoApply_example; // Policy auto apply (optional) (default to 1)

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

// Update an existing Node Group
[apiInstance updateNodeGroupWith:body
    policyAutoApply:policyAutoApply
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodegroupsApi()

var body = ; // {SubjVo} SubjVo JSON Data

var opts = { 
  'policyAutoApply': policyAutoApply_example // {String} Policy auto apply
};

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

namespace Example
{
    public class updateNodeGroupExample
    {
        public void main()
        {
            
            var apiInstance = new NodegroupsApi();
            var body = new SubjVo(); // SubjVo | SubjVo JSON Data
            var policyAutoApply = policyAutoApply_example;  // String | Policy auto apply (optional)  (default to 1)

            try
            {
                // Update an existing Node Group
                apiInstance.updateNodeGroup(body, policyAutoApply);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodegroupsApi.updateNodeGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodegroupsApi();
$body = ; // SubjVo | SubjVo JSON Data
$policyAutoApply = policyAutoApply_example; // String | Policy auto apply

try {
    $api_instance->updateNodeGroup($body, $policyAutoApply);
} catch (Exception $e) {
    echo 'Exception when calling NodegroupsApi->updateNodeGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodegroupsApi;

my $api_instance = WWW::SwaggerClient::NodegroupsApi->new();
my $body = WWW::SwaggerClient::Object::SubjVo->new(); # SubjVo | SubjVo JSON Data
my $policyAutoApply = policyAutoApply_example; # String | Policy auto apply

eval { 
    $api_instance->updateNodeGroup(body => $body, policyAutoApply => $policyAutoApply);
};
if ($@) {
    warn "Exception when calling NodegroupsApi->updateNodeGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodegroupsApi()
body =  # SubjVo | SubjVo JSON Data
policyAutoApply = policyAutoApply_example # String | Policy auto apply (optional) (default to 1)

try: 
    # Update an existing Node Group
    api_instance.update_node_group(body, policyAutoApply=policyAutoApply)
except ApiException as e:
    print("Exception when calling NodegroupsApi->updateNodeGroup: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
policyAutoApply
String
Policy auto apply

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


Nodes

auth

Require a specific IP (MAC)'s User Authentication

Requires the User Authentication of the IP (MAC) specified.


/nodes/auth

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/nodes/auth"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String userId = userId_example; // String | Username (USER_ID)
        String passCheck = passCheck_example; // String | Password check (1: Check, Leave blank not to check)
        String scope = scope_example; // String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes String passwd = passwd_example; // String | Password String ip = ip_example; // String | IP String mac = mac_example; // String | MAC try { apiInstance.auth(userId, passCheck, scope, passwd, ip, mac); } catch (ApiException e) { System.err.println("Exception when calling NodesApi#auth"); e.printStackTrace(); } } }
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String userId = userId_example; // String | Username (USER_ID)
        String passCheck = passCheck_example; // String | Password check (1: Check, Leave blank not to check)
        String scope = scope_example; // String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes String passwd = passwd_example; // String | Password String ip = ip_example; // String | IP String mac = mac_example; // String | MAC try { apiInstance.auth(userId, passCheck, scope, passwd, ip, mac); } catch (ApiException e) { System.err.println("Exception when calling NodesApi#auth"); e.printStackTrace(); } } }
String *userId = userId_example; // Username (USER_ID)
String *passCheck = passCheck_example; // Password check (1: Check, Leave blank not to check) (default to 1)
String *scope = scope_example; // Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes (default to allUpNode) String *passwd = passwd_example; // Password (optional) String *ip = ip_example; // IP (optional) String *mac = mac_example; // MAC (optional) NodesApi *apiInstance = [[NodesApi alloc] init]; // Require a specific IP (MAC)'s User Authentication [apiInstance authWith:userId passCheck:passCheck scope:scope passwd:passwd ip:ip mac:mac completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var userId = userId_example; // {String} Username (USER_ID)

var passCheck = passCheck_example; // {String} Password check (1: Check, Leave blank not to check)

var scope = scope_example; // {String} Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes var opts = { 'passwd': passwd_example, // {String} Password 'ip': ip_example, // {String} IP 'mac': mac_example // {String} MAC }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.auth(userId, passCheck, scope, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class authExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var userId = userId_example;  // String | Username (USER_ID)
            var passCheck = passCheck_example;  // String | Password check (1: Check, Leave blank not to check) (default to 1)
            var scope = scope_example;  // String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes (default to allUpNode) var passwd = passwd_example; // String | Password (optional) var ip = ip_example; // String | IP (optional) var mac = mac_example; // String | MAC (optional) try { // Require a specific IP (MAC)'s User Authentication apiInstance.auth(userId, passCheck, scope, passwd, ip, mac); } catch (Exception e) { Debug.Print("Exception when calling NodesApi.auth: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$userId = userId_example; // String | Username (USER_ID)
$passCheck = passCheck_example; // String | Password check (1: Check, Leave blank not to check)
$scope = scope_example; // String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes $passwd = passwd_example; // String | Password $ip = ip_example; // String | IP $mac = mac_example; // String | MAC try { $api_instance->auth($userId, $passCheck, $scope, $passwd, $ip, $mac); } catch (Exception $e) { echo 'Exception when calling NodesApi->auth: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $userId = userId_example; # String | Username (USER_ID)
my $passCheck = passCheck_example; # String | Password check (1: Check, Leave blank not to check)
my $scope = scope_example; # String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes my $passwd = passwd_example; # String | Password my $ip = ip_example; # String | IP my $mac = mac_example; # String | MAC eval { $api_instance->auth(userId => $userId, passCheck => $passCheck, scope => $scope, passwd => $passwd, ip => $ip, mac => $mac); }; if ($@) { warn "Exception when calling NodesApi->auth: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
userId = userId_example # String | Username (USER_ID)
passCheck = passCheck_example # String | Password check (1: Check, Leave blank not to check) (default to 1)
scope = scope_example # String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes (default to allUpNode) passwd = passwd_example # String | Password (optional) ip = ip_example # String | IP (optional) mac = mac_example # String | MAC (optional) try: # Require a specific IP (MAC)'s User Authentication api_instance.auth(userId, passCheck, scope, passwd=passwd, ip=ip, mac=mac) except ApiException as e: print("Exception when calling NodesApi->auth: %s\n" % e)

Parameters

Form parameters
Name Description
userId*
String
Username (USER_ID)
Required
passwd
String
Password
ip
String
IP
mac
String
MAC
passCheck*
String
Password check (1: Check, Leave blank not to check)
Required
scope*
String
Scope<br/>singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes
Required

Responses

Status: 206 - Partial Content

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


commandToNode

Run a specific Node's Task

Runs the Task of the Node specified.


/nodes/{nodeId}/{cmd}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/nodes/{nodeId}/{cmd}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String cmd = cmd_example; // String | Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)
        String comment = comment_example; // String | Description
        String parameter = parameter_example; // String | Parameter
        try {
            apiInstance.commandToNode(nodeId, cmd, comment, parameter);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#commandToNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String cmd = cmd_example; // String | Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)
        String comment = comment_example; // String | Description
        String parameter = parameter_example; // String | Parameter
        try {
            apiInstance.commandToNode(nodeId, cmd, comment, parameter);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#commandToNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
String *cmd = cmd_example; // Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)
String *comment = comment_example; // Description (optional)
String *parameter = parameter_example; // Parameter (optional)

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

// Run a specific Node's Task
[apiInstance commandToNodeWith:nodeId
    cmd:cmd
    comment:comment
    parameter:parameter
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var cmd = cmd_example; // {String} Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)

var opts = { 
  'comment': comment_example, // {String} Description
  'parameter': parameter_example // {String} Parameter
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.commandToNode(nodeId, cmd, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class commandToNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var cmd = cmd_example;  // String | Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)
            var comment = comment_example;  // String | Description (optional) 
            var parameter = parameter_example;  // String | Parameter (optional) 

            try
            {
                // Run a specific Node's Task
                apiInstance.commandToNode(nodeId, cmd, comment, parameter);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.commandToNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$cmd = cmd_example; // String | Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)
$comment = comment_example; // String | Description
$parameter = parameter_example; // String | Parameter

try {
    $api_instance->commandToNode($nodeId, $cmd, $comment, $parameter);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->commandToNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $cmd = cmd_example; # String | Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)
my $comment = comment_example; # String | Description
my $parameter = parameter_example; # String | Parameter

eval { 
    $api_instance->commandToNode(nodeId => $nodeId, cmd => $cmd, comment => $comment, parameter => $parameter);
};
if ($@) {
    warn "Exception when calling NodesApi->commandToNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
cmd = cmd_example # String | Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)
comment = comment_example # String | Description (optional)
parameter = parameter_example # String | Parameter (optional)

try: 
    # Run a specific Node's Task
    api_instance.command_to_node(nodeId, cmd, comment=comment, parameter=parameter)
except ApiException as e:
    print("Exception when calling NodesApi->commandToNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
cmd*
String
Task (ipDeny: Deny IP, ipAllow: Allow IP, ipProtect: Enable IP Change Prevention, ipFixAuthUser: Enable Hostname Policy, ipUnFixAuthUser: Require User Authentication, ipUnFixHostName: Clear Hostname Policy Settings, macDeny: Deny MAC, macAllow: Allow MAC, sendInstantMsg: Send Instant Message)
Required
Form parameters
Name Description
comment
String
Description
parameter
String
Parameter

Responses

Status: 401 - Unauthorized

Status: 404 - Node Not Found

Status: 500 - Internal Server Error


commandsToNodes

Run a specific Node's Task

Runs the Task of the Node specified.


/nodes/commands

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/nodes/commands"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        array[Node Commands Value Object] body = ; // array[Node Commands Value Object] | Commands Data
        try {
            apiInstance.commandsToNodes(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#commandsToNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        array[Node Commands Value Object] body = ; // array[Node Commands Value Object] | Commands Data
        try {
            apiInstance.commandsToNodes(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#commandsToNodes");
            e.printStackTrace();
        }
    }
}
array[Node Commands Value Object] *body = ; // Commands Data

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

// Run a specific Node's Task
[apiInstance commandsToNodesWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var body = ; // {array[Node Commands Value Object]} Commands Data


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

namespace Example
{
    public class commandsToNodesExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var body = new array[Node Commands Value Object](); // array[Node Commands Value Object] | Commands Data

            try
            {
                // Run a specific Node's Task
                apiInstance.commandsToNodes(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.commandsToNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$body = ; // array[Node Commands Value Object] | Commands Data

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

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $body = [WWW::SwaggerClient::Object::array[Node Commands Value Object]->new()]; # array[Node Commands Value Object] | Commands Data

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

# create an instance of the API class
api_instance = swagger_client.NodesApi()
body =  # array[Node Commands Value Object] | Commands Data

try: 
    # Run a specific Node's Task
    api_instance.commands_to_nodes(body)
except ApiException as e:
    print("Exception when calling NodesApi->commandsToNodes: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 404 - Node Not Found

Status: 500 - Internal Server Error


createNodeTagsOfNode

Assign a tag

Assigns a tag to the Node specified.


/nodes/{nodeId}/tags

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/nodes/{nodeId}/tags?applyAgent="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
        Integer applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)
        try {
            apiInstance.createNodeTagsOfNode(nodeId, body, applyAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#createNodeTagsOfNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
        Integer applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)
        try {
            apiInstance.createNodeTagsOfNode(nodeId, body, applyAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#createNodeTagsOfNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
array[TagVo] *body = ; // Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
Integer *applyAgent = 56; // Apply the policy to the agent.(0: false, 1: true) (optional)

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

// Assign a tag
[apiInstance createNodeTagsOfNodeWith:nodeId
    body:body
    applyAgent:applyAgent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var body = ; // {array[TagVo]} Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

var opts = { 
  'applyAgent': 56 // {Integer} Apply the policy to the agent.(0: false, 1: true)
};

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

namespace Example
{
    public class createNodeTagsOfNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var body = new array[TagVo](); // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
            var applyAgent = 56;  // Integer | Apply the policy to the agent.(0: false, 1: true) (optional) 

            try
            {
                // Assign a tag
                apiInstance.createNodeTagsOfNode(nodeId, body, applyAgent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.createNodeTagsOfNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
$applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)

try {
    $api_instance->createNodeTagsOfNode($nodeId, $body, $applyAgent);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->createNodeTagsOfNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $body = [WWW::SwaggerClient::Object::array[TagVo]->new()]; # array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
my $applyAgent = 56; # Integer | Apply the policy to the agent.(0: false, 1: true)

eval { 
    $api_instance->createNodeTagsOfNode(nodeId => $nodeId, body => $body, applyAgent => $applyAgent);
};
if ($@) {
    warn "Exception when calling NodesApi->createNodeTagsOfNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
body =  # array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
applyAgent = 56 # Integer | Apply the policy to the agent.(0: false, 1: true) (optional)

try: 
    # Assign a tag
    api_instance.create_node_tags_of_node(nodeId, body, applyAgent=applyAgent)
except ApiException as e:
    print("Exception when calling NodesApi->createNodeTagsOfNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Body parameters
Name Description
body *
Query parameters
Name Description
applyAgent
Integer (int32)
Apply the policy to the agent.(0: false, 1: true)

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


createNodes

Add a new Node

Adds a new Node.


/nodes

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/nodes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        array[Node Value Object for create] body = ; // array[Node Value Object for create] | Node information
        try {
            Messages Value Object result = apiInstance.createNodes(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#createNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        array[Node Value Object for create] body = ; // array[Node Value Object for create] | Node information
        try {
            Messages Value Object result = apiInstance.createNodes(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#createNodes");
            e.printStackTrace();
        }
    }
}
array[Node Value Object for create] *body = ; // Node information

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

// Add a new Node
[apiInstance createNodesWith:body
              completionHandler: ^(Messages Value Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var body = ; // {array[Node Value Object for create]} Node information


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

namespace Example
{
    public class createNodesExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var body = new array[Node Value Object for create](); // array[Node Value Object for create] | Node information

            try
            {
                // Add a new Node
                Messages Value Object result = apiInstance.createNodes(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.createNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$body = ; // array[Node Value Object for create] | Node information

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

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $body = [WWW::SwaggerClient::Object::array[Node Value Object for create]->new()]; # array[Node Value Object for create] | Node information

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

# create an instance of the API class
api_instance = swagger_client.NodesApi()
body =  # array[Node Value Object for create] | Node information

try: 
    # Add a new Node
    api_response = api_instance.create_nodes(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NodesApi->createNodes: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


deleteNode

Delete a specific Node

Deletes the Node specified.


/nodes/{nodeId}

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/nodes/{nodeId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.deleteNode(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#deleteNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.deleteNode(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#deleteNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID

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

// Delete a specific Node
[apiInstance deleteNodeWith:nodeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID


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

namespace Example
{
    public class deleteNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID

            try
            {
                // Delete a specific Node
                apiInstance.deleteNode(nodeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.deleteNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID

try {
    $api_instance->deleteNode($nodeId);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->deleteNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID

eval { 
    $api_instance->deleteNode(nodeId => $nodeId);
};
if ($@) {
    warn "Exception when calling NodesApi->deleteNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID

try: 
    # Delete a specific Node
    api_instance.delete_node(nodeId)
except ApiException as e:
    print("Exception when calling NodesApi->deleteNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteNodeTagsOfNode

Remove the tag(s)

Removes the tag(s) from the Node specified.


/nodes/{nodeId}/tags

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/nodes/{nodeId}/tags?applyAgent="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        array[String] body = ; // array[String] | Tag List
        Integer applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)
        try {
            apiInstance.deleteNodeTagsOfNode(nodeId, body, applyAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#deleteNodeTagsOfNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        array[String] body = ; // array[String] | Tag List
        Integer applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)
        try {
            apiInstance.deleteNodeTagsOfNode(nodeId, body, applyAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#deleteNodeTagsOfNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
array[String] *body = ; // Tag List
Integer *applyAgent = 56; // Apply the policy to the agent.(0: false, 1: true) (optional)

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

// Remove the tag(s)
[apiInstance deleteNodeTagsOfNodeWith:nodeId
    body:body
    applyAgent:applyAgent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var body = ; // {array[String]} Tag List

var opts = { 
  'applyAgent': 56 // {Integer} Apply the policy to the agent.(0: false, 1: true)
};

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

namespace Example
{
    public class deleteNodeTagsOfNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var body = new array[String](); // array[String] | Tag List
            var applyAgent = 56;  // Integer | Apply the policy to the agent.(0: false, 1: true) (optional) 

            try
            {
                // Remove the tag(s)
                apiInstance.deleteNodeTagsOfNode(nodeId, body, applyAgent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.deleteNodeTagsOfNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$body = ; // array[String] | Tag List
$applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)

try {
    $api_instance->deleteNodeTagsOfNode($nodeId, $body, $applyAgent);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->deleteNodeTagsOfNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | Tag List
my $applyAgent = 56; # Integer | Apply the policy to the agent.(0: false, 1: true)

eval { 
    $api_instance->deleteNodeTagsOfNode(nodeId => $nodeId, body => $body, applyAgent => $applyAgent);
};
if ($@) {
    warn "Exception when calling NodesApi->deleteNodeTagsOfNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
body =  # array[String] | Tag List
applyAgent = 56 # Integer | Apply the policy to the agent.(0: false, 1: true) (optional)

try: 
    # Remove the tag(s)
    api_instance.delete_node_tags_of_node(nodeId, body, applyAgent=applyAgent)
except ApiException as e:
    print("Exception when calling NodesApi->deleteNodeTagsOfNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Body parameters
Name Description
body *
Query parameters
Name Description
applyAgent
Integer (int32)
Apply the policy to the agent.(0: false, 1: true)

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteNodes

Remove Specific Nodes

Removes the Nodes specified.


/nodes

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/nodes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        array[String] body = ; // array[String] | Node ID List(Format [nodeId,nodeId])
        try {
            apiInstance.deleteNodes(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#deleteNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        array[String] body = ; // array[String] | Node ID List(Format [nodeId,nodeId])
        try {
            apiInstance.deleteNodes(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#deleteNodes");
            e.printStackTrace();
        }
    }
}
array[String] *body = ; // Node ID List(Format [nodeId,nodeId])

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

// Remove Specific Nodes
[apiInstance deleteNodesWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var body = ; // {array[String]} Node ID List(Format [nodeId,nodeId])


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

namespace Example
{
    public class deleteNodesExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var body = new array[String](); // array[String] | Node ID List(Format [nodeId,nodeId])

            try
            {
                // Remove Specific Nodes
                apiInstance.deleteNodes(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.deleteNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$body = ; // array[String] | Node ID List(Format [nodeId,nodeId])

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

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | Node ID List(Format [nodeId,nodeId])

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

# create an instance of the API class
api_instance = swagger_client.NodesApi()
body =  # array[String] | Node ID List(Format [nodeId,nodeId])

try: 
    # Remove Specific Nodes
    api_instance.delete_nodes(body)
except ApiException as e:
    print("Exception when calling NodesApi->deleteNodes: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getCountOfNode

Retrieve the number of Nodes

Retrieves the number of the Nodes.


/nodes/count

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/count?active=&risk=&genidevs="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        Boolean active = true; // Boolean | Node UP
        Boolean risk = true; // Boolean | Anomalies detected
        String genidevs = genidevs_example; // String | Node Type (CM_CODE or CM_CODEs separated by comma)
        try {
            apiInstance.getCountOfNode(active, risk, genidevs);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getCountOfNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        Boolean active = true; // Boolean | Node UP
        Boolean risk = true; // Boolean | Anomalies detected
        String genidevs = genidevs_example; // String | Node Type (CM_CODE or CM_CODEs separated by comma)
        try {
            apiInstance.getCountOfNode(active, risk, genidevs);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getCountOfNode");
            e.printStackTrace();
        }
    }
}
Boolean *active = true; // Node UP (optional)
Boolean *risk = true; // Anomalies detected (optional)
String *genidevs = genidevs_example; // Node Type (CM_CODE or CM_CODEs separated by comma) (optional)

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

// Retrieve the number of Nodes
[apiInstance getCountOfNodeWith:active
    risk:risk
    genidevs:genidevs
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var opts = { 
  'active': true, // {Boolean} Node UP
  'risk': true, // {Boolean} Anomalies detected
  'genidevs': genidevs_example // {String} Node Type (CM_CODE or CM_CODEs separated by comma)
};

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

namespace Example
{
    public class getCountOfNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var active = true;  // Boolean | Node UP (optional) 
            var risk = true;  // Boolean | Anomalies detected (optional) 
            var genidevs = genidevs_example;  // String | Node Type (CM_CODE or CM_CODEs separated by comma) (optional) 

            try
            {
                // Retrieve the number of Nodes
                apiInstance.getCountOfNode(active, risk, genidevs);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getCountOfNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$active = true; // Boolean | Node UP
$risk = true; // Boolean | Anomalies detected
$genidevs = genidevs_example; // String | Node Type (CM_CODE or CM_CODEs separated by comma)

try {
    $api_instance->getCountOfNode($active, $risk, $genidevs);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getCountOfNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $active = true; # Boolean | Node UP
my $risk = true; # Boolean | Anomalies detected
my $genidevs = genidevs_example; # String | Node Type (CM_CODE or CM_CODEs separated by comma)

eval { 
    $api_instance->getCountOfNode(active => $active, risk => $risk, genidevs => $genidevs);
};
if ($@) {
    warn "Exception when calling NodesApi->getCountOfNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
active = true # Boolean | Node UP (optional)
risk = true # Boolean | Anomalies detected (optional)
genidevs = genidevs_example # String | Node Type (CM_CODE or CM_CODEs separated by comma) (optional)

try: 
    # Retrieve the number of Nodes
    api_instance.get_count_of_node(active=active, risk=risk, genidevs=genidevs)
except ApiException as e:
    print("Exception when calling NodesApi->getCountOfNode: %s\n" % e)

Parameters

Query parameters
Name Description
active
Boolean
Node UP
risk
Boolean
Anomalies detected
genidevs
String
Node Type (CM_CODE or CM_CODEs separated by comma)

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getCountOfStatisticsForNodes

Retrieve Node detection average by period

Retrieves the Node detection average by period (cps_data1: UP Nodes, cps_data2: All Nodes, cps_data3: Up / All Nodes, cps_data4: All Devices).


/nodes/stat

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/stat?periodType=&timeScope="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String periodType = periodType_example; // String | Time unit (min, hour, day)
        Integer timeScope = 56; // Integer | Period
        try {
            CommonPeriodicStatVo result = apiInstance.getCountOfStatisticsForNodes(periodType, timeScope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getCountOfStatisticsForNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String periodType = periodType_example; // String | Time unit (min, hour, day)
        Integer timeScope = 56; // Integer | Period
        try {
            CommonPeriodicStatVo result = apiInstance.getCountOfStatisticsForNodes(periodType, timeScope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getCountOfStatisticsForNodes");
            e.printStackTrace();
        }
    }
}
String *periodType = periodType_example; // Time unit (min, hour, day) (optional)
Integer *timeScope = 56; // Period (optional)

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

// Retrieve Node detection average by period
[apiInstance getCountOfStatisticsForNodesWith:periodType
    timeScope:timeScope
              completionHandler: ^(CommonPeriodicStatVo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var opts = { 
  'periodType': periodType_example, // {String} Time unit (min, hour, day)
  'timeScope': 56 // {Integer} Period
};

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

namespace Example
{
    public class getCountOfStatisticsForNodesExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var periodType = periodType_example;  // String | Time unit (min, hour, day) (optional) 
            var timeScope = 56;  // Integer | Period (optional) 

            try
            {
                // Retrieve Node detection average by period
                CommonPeriodicStatVo result = apiInstance.getCountOfStatisticsForNodes(periodType, timeScope);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getCountOfStatisticsForNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$periodType = periodType_example; // String | Time unit (min, hour, day)
$timeScope = 56; // Integer | Period

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

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $periodType = periodType_example; # String | Time unit (min, hour, day)
my $timeScope = 56; # Integer | Period

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

# create an instance of the API class
api_instance = swagger_client.NodesApi()
periodType = periodType_example # String | Time unit (min, hour, day) (optional)
timeScope = 56 # Integer | Period (optional)

try: 
    # Retrieve Node detection average by period
    api_response = api_instance.get_count_of_statistics_for_nodes(periodType=periodType, timeScope=timeScope)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NodesApi->getCountOfStatisticsForNodes: %s\n" % e)

Parameters

Query parameters
Name Description
periodType
String
Time unit (min, hour, day)
timeScope
Integer (int32)
Period

Responses

Status: 200 - successful operation

Status: 401 - Unauthorized

Status: 404 - Not Found


getCves

Retrieve a specific Node's CVE(s)

Retrieves the CVE(s) assigned to the Node specified.


/nodes/{nodeId}/cves

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/cves?page=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getCves(nodeId, page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getCves");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getCves(nodeId, page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getCves");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

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

// Retrieve a specific Node's CVE(s)
[apiInstance getCvesWith:nodeId
    page:page
    pageSize:pageSize
    sort:sort
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getCves(nodeId, page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCvesExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 

            try
            {
                // Retrieve a specific Node's CVE(s)
                apiInstance.getCves(nodeId, page, pageSize, sort);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getCves: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

try {
    $api_instance->getCves($nodeId, $page, $pageSize, $sort);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getCves: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

eval { 
    $api_instance->getCves(nodeId => $nodeId, page => $page, pageSize => $pageSize, sort => $sort);
};
if ($@) {
    warn "Exception when calling NodesApi->getCves: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

try: 
    # Retrieve a specific Node's CVE(s)
    api_instance.get_cves(nodeId, page, pageSize, sort=sort)
except ApiException as e:
    print("Exception when calling NodesApi->getCves: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

Responses

Status: 401 - Unauthorized

Status: 404 - Node ID Not Found


getDevInfo

Retrieve the data of the InfoConf

Retrieves the data of the Category specified.


/nodes/{nodeId}/devInfo

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/devInfo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getDevInfo(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getDevInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getDevInfo(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getDevInfo");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID

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

// Retrieve the data of the InfoConf
[apiInstance getDevInfoWith:nodeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID


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

namespace Example
{
    public class getDevInfoExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID

            try
            {
                // Retrieve the data of the InfoConf
                apiInstance.getDevInfo(nodeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getDevInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID

try {
    $api_instance->getDevInfo($nodeId);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getDevInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID

eval { 
    $api_instance->getDevInfo(nodeId => $nodeId);
};
if ($@) {
    warn "Exception when calling NodesApi->getDevInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID

try: 
    # Retrieve the data of the InfoConf
    api_instance.get_dev_info(nodeId)
except ApiException as e:
    print("Exception when calling NodesApi->getDevInfo: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getDeviceAssetCustomFields

Get custom fields for device asset information

Get custom fields for device asset information


/nodes/{nodeId}/device/asset/customfields

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/device/asset/customfields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getDeviceAssetCustomFields(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getDeviceAssetCustomFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getDeviceAssetCustomFields(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getDeviceAssetCustomFields");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID

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

// Get custom fields for device asset information
[apiInstance getDeviceAssetCustomFieldsWith:nodeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID


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

namespace Example
{
    public class getDeviceAssetCustomFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID

            try
            {
                // Get custom fields for device asset information
                apiInstance.getDeviceAssetCustomFields(nodeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getDeviceAssetCustomFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID

try {
    $api_instance->getDeviceAssetCustomFields($nodeId);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getDeviceAssetCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID

eval { 
    $api_instance->getDeviceAssetCustomFields(nodeId => $nodeId);
};
if ($@) {
    warn "Exception when calling NodesApi->getDeviceAssetCustomFields: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID

try: 
    # Get custom fields for device asset information
    api_instance.get_device_asset_custom_fields(nodeId)
except ApiException as e:
    print("Exception when calling NodesApi->getDeviceAssetCustomFields: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getDeviceCustomFields

Get custom fields of device

Gets custom fileds of device


/nodes/{nodeId}/device/customfields

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/device/customfields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getDeviceCustomFields(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getDeviceCustomFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getDeviceCustomFields(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getDeviceCustomFields");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID

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

// Get custom fields of device
[apiInstance getDeviceCustomFieldsWith:nodeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID


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

namespace Example
{
    public class getDeviceCustomFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID

            try
            {
                // Get custom fields of device
                apiInstance.getDeviceCustomFields(nodeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getDeviceCustomFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID

try {
    $api_instance->getDeviceCustomFields($nodeId);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getDeviceCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID

eval { 
    $api_instance->getDeviceCustomFields(nodeId => $nodeId);
};
if ($@) {
    warn "Exception when calling NodesApi->getDeviceCustomFields: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID

try: 
    # Get custom fields of device
    api_instance.get_device_custom_fields(nodeId)
except ApiException as e:
    print("Exception when calling NodesApi->getDeviceCustomFields: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getMalwareListOfNode

List of malware detected on the node

Retrieves a list of malware files for nodes detected by the agent.


/nodes/{nodeId}/malware

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/malware?page=&pageSize=&sort=&fileName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String fileName = fileName_example; // String | File Name
        try {
            apiInstance.getMalwareListOfNode(nodeId, page, pageSize, sort, fileName);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getMalwareListOfNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String fileName = fileName_example; // String | File Name
        try {
            apiInstance.getMalwareListOfNode(nodeId, page, pageSize, sort, fileName);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getMalwareListOfNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *fileName = fileName_example; // File Name (optional)

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

// List of malware detected on the node
[apiInstance getMalwareListOfNodeWith:nodeId
    page:page
    pageSize:pageSize
    sort:sort
    fileName:fileName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'fileName': fileName_example // {String} File Name
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getMalwareListOfNode(nodeId, page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMalwareListOfNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var fileName = fileName_example;  // String | File Name (optional) 

            try
            {
                // List of malware detected on the node
                apiInstance.getMalwareListOfNode(nodeId, page, pageSize, sort, fileName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getMalwareListOfNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$fileName = fileName_example; // String | File Name

try {
    $api_instance->getMalwareListOfNode($nodeId, $page, $pageSize, $sort, $fileName);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getMalwareListOfNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $fileName = fileName_example; # String | File Name

eval { 
    $api_instance->getMalwareListOfNode(nodeId => $nodeId, page => $page, pageSize => $pageSize, sort => $sort, fileName => $fileName);
};
if ($@) {
    warn "Exception when calling NodesApi->getMalwareListOfNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
fileName = fileName_example # String | File Name (optional)

try: 
    # List of malware detected on the node
    api_instance.get_malware_list_of_node(nodeId, page, pageSize, sort=sort, fileName=fileName)
except ApiException as e:
    print("Exception when calling NodesApi->getMalwareListOfNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sort criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
fileName
String
File Name

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNode

Retrieve a specific Node's information

Retrieves the information of the Node specified.<br/>Node IDs can be imported into the node list through the "/mc2/rest/nodes" API.


/nodes/{nodeId}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}?v="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String v = v_example; // String | Version
        try {
            apiInstance.getNode(nodeId, v);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String v = v_example; // String | Version
        try {
            apiInstance.getNode(nodeId, v);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
String *v = v_example; // Version (optional)

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

// Retrieve a specific Node's information
[apiInstance getNodeWith:nodeId
    v:v
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var opts = { 
  'v': v_example // {String} Version
};

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

namespace Example
{
    public class getNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var v = v_example;  // String | Version (optional) 

            try
            {
                // Retrieve a specific Node's information
                apiInstance.getNode(nodeId, v);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$v = v_example; // String | Version

try {
    $api_instance->getNode($nodeId, $v);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $v = v_example; # String | Version

eval { 
    $api_instance->getNode(nodeId => $nodeId, v => $v);
};
if ($@) {
    warn "Exception when calling NodesApi->getNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
v = v_example # String | Version (optional)

try: 
    # Retrieve a specific Node's information
    api_instance.get_node(nodeId, v=v)
except ApiException as e:
    print("Exception when calling NodesApi->getNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Query parameters
Name Description
v
String
Version

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNodeCustomFields

Get custom fields of node

Gets custom fileds of node


/nodes/{nodeId}/customfields

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/customfields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getNodeCustomFields(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodeCustomFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getNodeCustomFields(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodeCustomFields");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID

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

// Get custom fields of node
[apiInstance getNodeCustomFieldsWith:nodeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID


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

namespace Example
{
    public class getNodeCustomFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID

            try
            {
                // Get custom fields of node
                apiInstance.getNodeCustomFields(nodeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getNodeCustomFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID

try {
    $api_instance->getNodeCustomFields($nodeId);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getNodeCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID

eval { 
    $api_instance->getNodeCustomFields(nodeId => $nodeId);
};
if ($@) {
    warn "Exception when calling NodesApi->getNodeCustomFields: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID

try: 
    # Get custom fields of node
    api_instance.get_node_custom_fields(nodeId)
except ApiException as e:
    print("Exception when calling NodesApi->getNodeCustomFields: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNodeInformation

Retrieve the data of the InfoConf

Retrieves the data of the Category specified.


/nodes/{nodeId}/information/{catgry}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/information/{catgry}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String catgry = catgry_example; // String | Category
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getNodeInformation(catgry, nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodeInformation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String catgry = catgry_example; // String | Category
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getNodeInformation(catgry, nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodeInformation");
            e.printStackTrace();
        }
    }
}
String *catgry = catgry_example; // Category
String *nodeId = nodeId_example; // Node ID

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

// Retrieve the data of the InfoConf
[apiInstance getNodeInformationWith:catgry
    nodeId:nodeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var catgry = catgry_example; // {String} Category

var nodeId = nodeId_example; // {String} Node ID


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

namespace Example
{
    public class getNodeInformationExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var catgry = catgry_example;  // String | Category
            var nodeId = nodeId_example;  // String | Node ID

            try
            {
                // Retrieve the data of the InfoConf
                apiInstance.getNodeInformation(catgry, nodeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getNodeInformation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$catgry = catgry_example; // String | Category
$nodeId = nodeId_example; // String | Node ID

try {
    $api_instance->getNodeInformation($catgry, $nodeId);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getNodeInformation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $catgry = catgry_example; # String | Category
my $nodeId = nodeId_example; # String | Node ID

eval { 
    $api_instance->getNodeInformation(catgry => $catgry, nodeId => $nodeId);
};
if ($@) {
    warn "Exception when calling NodesApi->getNodeInformation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
catgry = catgry_example # String | Category
nodeId = nodeId_example # String | Node ID

try: 
    # Retrieve the data of the InfoConf
    api_instance.get_node_information(catgry, nodeId)
except ApiException as e:
    print("Exception when calling NodesApi->getNodeInformation: %s\n" % e)

Parameters

Path parameters
Name Description
catgry*
String
Category
Required
nodeId*
String
Node ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNodePolicy

Retrieve a specific Node's information

Retrieves the information of the Node specified.


/nodes/{nodeId}/policy

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/policy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            NodePolicyVo result = apiInstance.getNodePolicy(nodeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodePolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            NodePolicyVo result = apiInstance.getNodePolicy(nodeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodePolicy");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID

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

// Retrieve a specific Node's information
[apiInstance getNodePolicyWith:nodeId
              completionHandler: ^(NodePolicyVo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID


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

namespace Example
{
    public class getNodePolicyExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID

            try
            {
                // Retrieve a specific Node's information
                NodePolicyVo result = apiInstance.getNodePolicy(nodeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getNodePolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID

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

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID

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

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID

try: 
    # Retrieve a specific Node's information
    api_response = api_instance.get_node_policy(nodeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NodesApi->getNodePolicy: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required

Responses

Status: 200 - successful operation

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


getNodeTagsOfNode

Retrieve a specific Node's tag(s)

Retrieves the tag(s) assigned to the Node specified.


/nodes/{nodeId}/tags

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/tags?type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String type = type_example; // String | Tag Type
        try {
            apiInstance.getNodeTagsOfNode(nodeId, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodeTagsOfNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String type = type_example; // String | Tag Type
        try {
            apiInstance.getNodeTagsOfNode(nodeId, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodeTagsOfNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
String *type = type_example; // Tag Type (optional) (default to node)

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

// Retrieve a specific Node's tag(s)
[apiInstance getNodeTagsOfNodeWith:nodeId
    type:type
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var opts = { 
  'type': type_example // {String} Tag Type
};

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

namespace Example
{
    public class getNodeTagsOfNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var type = type_example;  // String | Tag Type (optional)  (default to node)

            try
            {
                // Retrieve a specific Node's tag(s)
                apiInstance.getNodeTagsOfNode(nodeId, type);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getNodeTagsOfNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$type = type_example; // String | Tag Type

try {
    $api_instance->getNodeTagsOfNode($nodeId, $type);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getNodeTagsOfNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $type = type_example; # String | Tag Type

eval { 
    $api_instance->getNodeTagsOfNode(nodeId => $nodeId, type => $type);
};
if ($@) {
    warn "Exception when calling NodesApi->getNodeTagsOfNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
type = type_example # String | Tag Type (optional) (default to node)

try: 
    # Retrieve a specific Node's tag(s)
    api_instance.get_node_tags_of_node(nodeId, type=type)
except ApiException as e:
    print("Exception when calling NodesApi->getNodeTagsOfNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Query parameters
Name Description
type
String
Tag Type

Responses

Status: 401 - Unauthorized

Status: 404 - Node ID Not Found


getNodes

List Nodes

Retrieves a list of the Nodes.


/nodes

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes?page=&pageSize=&sort=&view=&subjid=&perspective=&licenseLimitExceededTime=&nid=&authdept=&authuser=&authuserExact=&property=&nodeproperty=&macproperty=&systemid=&roleid=&genidev=&genidevs=&agentType=&agentUpDown=&ipEqual=&ip=&macEqual=&mac=&riskNode=&riskDefinitionId=&beforeLoginTime=&qsearch=&allColumns=&ipUseOption="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String view = view_example; // String | Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View)
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String subjid = subjid_example; // String | Node Group (SUBJ_ID)
        String perspective = perspective_example; // String | View Criteria (node, dev)
        String licenseLimitExceededTime = licenseLimitExceededTime_example; // String | licenseLimitExceededTime
        String nid = nid_example; // String | Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group)
        String authdept = authdept_example; // String | Authenticated user's department (USER_DEPT)
        String authuser = authuser_example; // String | Authenticated user ID and user name included
        String authuserExact = authuserExact_example; // String | Authenticated user ID
        String property = property_example; // String | Tag (Node, MAC)
        String nodeproperty = nodeproperty_example; // String | Node Tag
        String macproperty = macproperty_example; // String | MAC Tag
        String systemid = systemid_example; // String | Node Policy (SYSTEM_ID)
        String roleid = roleid_example; // String | Enforcement Policy (ROLE_ID)
        String genidev = genidev_example; // String | Node Type (CM_CODE)
        String genidevs = genidevs_example; // String | Node Types (CM_CODEs separated by comma)
        String agentType = agentType_example; // String | Agent installed (agent_inst: Installed, agent_noinst: Not installed)
        String agentUpDown = agentUpDown_example; // String | Agent running (UP, DOWN)
        Boolean ipEqual = true; // Boolean | IP Match Full
        String ip = ip_example; // String | IP
        Boolean macEqual = true; // Boolean | MAC Match Full
        String mac = mac_example; // String | MAC
        Boolean riskNode = true; // Boolean | Anomalies detected
        String riskDefinitionId = riskDefinitionId_example; // String | Anomaly Definition
        String beforeLoginTime = beforeLoginTime_example; // String | Logged in (yyyy-MM-dd hh:mm:ss)
        String qsearch = qsearch_example; // String | Search string
        Boolean allColumns = true; // Boolean | Viewing all columns
        String ipUseOption = ipUseOption_example; // String | IP state (all: All, use: Assigned, unuse: Available)
        try {
            apiInstance.getNodes(page, pageSize, view, sort, subjid, perspective, licenseLimitExceededTime, nid, authdept, authuser, authuserExact, property, nodeproperty, macproperty, systemid, roleid, genidev, genidevs, agentType, agentUpDown, ipEqual, ip, macEqual, mac, riskNode, riskDefinitionId, beforeLoginTime, qsearch, allColumns, ipUseOption);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String view = view_example; // String | Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View)
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String subjid = subjid_example; // String | Node Group (SUBJ_ID)
        String perspective = perspective_example; // String | View Criteria (node, dev)
        String licenseLimitExceededTime = licenseLimitExceededTime_example; // String | licenseLimitExceededTime
        String nid = nid_example; // String | Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group)
        String authdept = authdept_example; // String | Authenticated user's department (USER_DEPT)
        String authuser = authuser_example; // String | Authenticated user ID and user name included
        String authuserExact = authuserExact_example; // String | Authenticated user ID
        String property = property_example; // String | Tag (Node, MAC)
        String nodeproperty = nodeproperty_example; // String | Node Tag
        String macproperty = macproperty_example; // String | MAC Tag
        String systemid = systemid_example; // String | Node Policy (SYSTEM_ID)
        String roleid = roleid_example; // String | Enforcement Policy (ROLE_ID)
        String genidev = genidev_example; // String | Node Type (CM_CODE)
        String genidevs = genidevs_example; // String | Node Types (CM_CODEs separated by comma)
        String agentType = agentType_example; // String | Agent installed (agent_inst: Installed, agent_noinst: Not installed)
        String agentUpDown = agentUpDown_example; // String | Agent running (UP, DOWN)
        Boolean ipEqual = true; // Boolean | IP Match Full
        String ip = ip_example; // String | IP
        Boolean macEqual = true; // Boolean | MAC Match Full
        String mac = mac_example; // String | MAC
        Boolean riskNode = true; // Boolean | Anomalies detected
        String riskDefinitionId = riskDefinitionId_example; // String | Anomaly Definition
        String beforeLoginTime = beforeLoginTime_example; // String | Logged in (yyyy-MM-dd hh:mm:ss)
        String qsearch = qsearch_example; // String | Search string
        Boolean allColumns = true; // Boolean | Viewing all columns
        String ipUseOption = ipUseOption_example; // String | IP state (all: All, use: Assigned, unuse: Available)
        try {
            apiInstance.getNodes(page, pageSize, view, sort, subjid, perspective, licenseLimitExceededTime, nid, authdept, authuser, authuserExact, property, nodeproperty, macproperty, systemid, roleid, genidev, genidevs, agentType, agentUpDown, ipEqual, ip, macEqual, mac, riskNode, riskDefinitionId, beforeLoginTime, qsearch, allColumns, ipUseOption);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getNodes");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *view = view_example; // Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View) (default to node)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *subjid = subjid_example; // Node Group (SUBJ_ID) (optional)
String *perspective = perspective_example; // View Criteria (node, dev) (optional)
String *licenseLimitExceededTime = licenseLimitExceededTime_example; // licenseLimitExceededTime (optional)
String *nid = nid_example; // Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group) (optional) (default to All)
String *authdept = authdept_example; // Authenticated user's department (USER_DEPT) (optional)
String *authuser = authuser_example; // Authenticated user ID and user name included (optional)
String *authuserExact = authuserExact_example; // Authenticated user ID (optional)
String *property = property_example; // Tag (Node, MAC) (optional)
String *nodeproperty = nodeproperty_example; // Node Tag (optional)
String *macproperty = macproperty_example; // MAC Tag (optional)
String *systemid = systemid_example; // Node Policy (SYSTEM_ID) (optional)
String *roleid = roleid_example; // Enforcement Policy (ROLE_ID) (optional)
String *genidev = genidev_example; // Node Type (CM_CODE) (optional)
String *genidevs = genidevs_example; // Node Types (CM_CODEs separated by comma) (optional)
String *agentType = agentType_example; // Agent installed (agent_inst: Installed, agent_noinst: Not installed) (optional)
String *agentUpDown = agentUpDown_example; // Agent running (UP, DOWN) (optional)
Boolean *ipEqual = true; // IP Match Full (optional) (default to false)
String *ip = ip_example; // IP (optional)
Boolean *macEqual = true; // MAC Match Full (optional) (default to false)
String *mac = mac_example; // MAC (optional)
Boolean *riskNode = true; // Anomalies detected (optional)
String *riskDefinitionId = riskDefinitionId_example; // Anomaly Definition (optional)
String *beforeLoginTime = beforeLoginTime_example; // Logged in (yyyy-MM-dd hh:mm:ss) (optional)
String *qsearch = qsearch_example; // Search string (optional)
Boolean *allColumns = true; // Viewing all columns (optional)
String *ipUseOption = ipUseOption_example; // IP state (all: All, use: Assigned, unuse: Available) (optional)

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

// List Nodes
[apiInstance getNodesWith:page
    pageSize:pageSize
    view:view
    sort:sort
    subjid:subjid
    perspective:perspective
    licenseLimitExceededTime:licenseLimitExceededTime
    nid:nid
    authdept:authdept
    authuser:authuser
    authuserExact:authuserExact
    property:property
    nodeproperty:nodeproperty
    macproperty:macproperty
    systemid:systemid
    roleid:roleid
    genidev:genidev
    genidevs:genidevs
    agentType:agentType
    agentUpDown:agentUpDown
    ipEqual:ipEqual
    ip:ip
    macEqual:macEqual
    mac:mac
    riskNode:riskNode
    riskDefinitionId:riskDefinitionId
    beforeLoginTime:beforeLoginTime
    qsearch:qsearch
    allColumns:allColumns
    ipUseOption:ipUseOption
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var view = view_example; // {String} Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View)

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'subjid': subjid_example, // {String} Node Group (SUBJ_ID)
  'perspective': perspective_example, // {String} View Criteria (node, dev)
  'licenseLimitExceededTime': licenseLimitExceededTime_example, // {String} licenseLimitExceededTime
  'nid': nid_example, // {String} Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group)
  'authdept': authdept_example, // {String} Authenticated user's department (USER_DEPT)
  'authuser': authuser_example, // {String} Authenticated user ID and user name included
  'authuserExact': authuserExact_example, // {String} Authenticated user ID
  'property': property_example, // {String} Tag (Node, MAC)
  'nodeproperty': nodeproperty_example, // {String} Node Tag
  'macproperty': macproperty_example, // {String} MAC Tag
  'systemid': systemid_example, // {String} Node Policy (SYSTEM_ID)
  'roleid': roleid_example, // {String} Enforcement Policy (ROLE_ID)
  'genidev': genidev_example, // {String} Node Type (CM_CODE)
  'genidevs': genidevs_example, // {String} Node Types (CM_CODEs separated by comma)
  'agentType': agentType_example, // {String} Agent installed (agent_inst: Installed, agent_noinst: Not installed)
  'agentUpDown': agentUpDown_example, // {String} Agent running (UP, DOWN)
  'ipEqual': true, // {Boolean} IP Match Full
  'ip': ip_example, // {String} IP
  'macEqual': true, // {Boolean} MAC Match Full
  'mac': mac_example, // {String} MAC
  'riskNode': true, // {Boolean} Anomalies detected
  'riskDefinitionId': riskDefinitionId_example, // {String} Anomaly Definition
  'beforeLoginTime': beforeLoginTime_example, // {String} Logged in (yyyy-MM-dd hh:mm:ss)
  'qsearch': qsearch_example, // {String} Search string
  'allColumns': true, // {Boolean} Viewing all columns
  'ipUseOption': ipUseOption_example // {String} IP state (all: All, use: Assigned, unuse: Available)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getNodes(page, pageSize, view, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNodesExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var view = view_example;  // String | Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View) (default to node)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var subjid = subjid_example;  // String | Node Group (SUBJ_ID) (optional) 
            var perspective = perspective_example;  // String | View Criteria (node, dev) (optional) 
            var licenseLimitExceededTime = licenseLimitExceededTime_example;  // String | licenseLimitExceededTime (optional) 
            var nid = nid_example;  // String | Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group) (optional)  (default to All)
            var authdept = authdept_example;  // String | Authenticated user's department (USER_DEPT) (optional) 
            var authuser = authuser_example;  // String | Authenticated user ID and user name included (optional) 
            var authuserExact = authuserExact_example;  // String | Authenticated user ID (optional) 
            var property = property_example;  // String | Tag (Node, MAC) (optional) 
            var nodeproperty = nodeproperty_example;  // String | Node Tag (optional) 
            var macproperty = macproperty_example;  // String | MAC Tag (optional) 
            var systemid = systemid_example;  // String | Node Policy (SYSTEM_ID) (optional) 
            var roleid = roleid_example;  // String | Enforcement Policy (ROLE_ID) (optional) 
            var genidev = genidev_example;  // String | Node Type (CM_CODE) (optional) 
            var genidevs = genidevs_example;  // String | Node Types (CM_CODEs separated by comma) (optional) 
            var agentType = agentType_example;  // String | Agent installed (agent_inst: Installed, agent_noinst: Not installed) (optional) 
            var agentUpDown = agentUpDown_example;  // String | Agent running (UP, DOWN) (optional) 
            var ipEqual = true;  // Boolean | IP Match Full (optional)  (default to false)
            var ip = ip_example;  // String | IP (optional) 
            var macEqual = true;  // Boolean | MAC Match Full (optional)  (default to false)
            var mac = mac_example;  // String | MAC (optional) 
            var riskNode = true;  // Boolean | Anomalies detected (optional) 
            var riskDefinitionId = riskDefinitionId_example;  // String | Anomaly Definition (optional) 
            var beforeLoginTime = beforeLoginTime_example;  // String | Logged in (yyyy-MM-dd hh:mm:ss) (optional) 
            var qsearch = qsearch_example;  // String | Search string (optional) 
            var allColumns = true;  // Boolean | Viewing all columns (optional) 
            var ipUseOption = ipUseOption_example;  // String | IP state (all: All, use: Assigned, unuse: Available) (optional) 

            try
            {
                // List Nodes
                apiInstance.getNodes(page, pageSize, view, sort, subjid, perspective, licenseLimitExceededTime, nid, authdept, authuser, authuserExact, property, nodeproperty, macproperty, systemid, roleid, genidev, genidevs, agentType, agentUpDown, ipEqual, ip, macEqual, mac, riskNode, riskDefinitionId, beforeLoginTime, qsearch, allColumns, ipUseOption);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$view = view_example; // String | Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View)
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$subjid = subjid_example; // String | Node Group (SUBJ_ID)
$perspective = perspective_example; // String | View Criteria (node, dev)
$licenseLimitExceededTime = licenseLimitExceededTime_example; // String | licenseLimitExceededTime
$nid = nid_example; // String | Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group)
$authdept = authdept_example; // String | Authenticated user's department (USER_DEPT)
$authuser = authuser_example; // String | Authenticated user ID and user name included
$authuserExact = authuserExact_example; // String | Authenticated user ID
$property = property_example; // String | Tag (Node, MAC)
$nodeproperty = nodeproperty_example; // String | Node Tag
$macproperty = macproperty_example; // String | MAC Tag
$systemid = systemid_example; // String | Node Policy (SYSTEM_ID)
$roleid = roleid_example; // String | Enforcement Policy (ROLE_ID)
$genidev = genidev_example; // String | Node Type (CM_CODE)
$genidevs = genidevs_example; // String | Node Types (CM_CODEs separated by comma)
$agentType = agentType_example; // String | Agent installed (agent_inst: Installed, agent_noinst: Not installed)
$agentUpDown = agentUpDown_example; // String | Agent running (UP, DOWN)
$ipEqual = true; // Boolean | IP Match Full
$ip = ip_example; // String | IP
$macEqual = true; // Boolean | MAC Match Full
$mac = mac_example; // String | MAC
$riskNode = true; // Boolean | Anomalies detected
$riskDefinitionId = riskDefinitionId_example; // String | Anomaly Definition
$beforeLoginTime = beforeLoginTime_example; // String | Logged in (yyyy-MM-dd hh:mm:ss)
$qsearch = qsearch_example; // String | Search string
$allColumns = true; // Boolean | Viewing all columns
$ipUseOption = ipUseOption_example; // String | IP state (all: All, use: Assigned, unuse: Available)

try {
    $api_instance->getNodes($page, $pageSize, $view, $sort, $subjid, $perspective, $licenseLimitExceededTime, $nid, $authdept, $authuser, $authuserExact, $property, $nodeproperty, $macproperty, $systemid, $roleid, $genidev, $genidevs, $agentType, $agentUpDown, $ipEqual, $ip, $macEqual, $mac, $riskNode, $riskDefinitionId, $beforeLoginTime, $qsearch, $allColumns, $ipUseOption);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getNodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $view = view_example; # String | Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View)
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $subjid = subjid_example; # String | Node Group (SUBJ_ID)
my $perspective = perspective_example; # String | View Criteria (node, dev)
my $licenseLimitExceededTime = licenseLimitExceededTime_example; # String | licenseLimitExceededTime
my $nid = nid_example; # String | Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group)
my $authdept = authdept_example; # String | Authenticated user's department (USER_DEPT)
my $authuser = authuser_example; # String | Authenticated user ID and user name included
my $authuserExact = authuserExact_example; # String | Authenticated user ID
my $property = property_example; # String | Tag (Node, MAC)
my $nodeproperty = nodeproperty_example; # String | Node Tag
my $macproperty = macproperty_example; # String | MAC Tag
my $systemid = systemid_example; # String | Node Policy (SYSTEM_ID)
my $roleid = roleid_example; # String | Enforcement Policy (ROLE_ID)
my $genidev = genidev_example; # String | Node Type (CM_CODE)
my $genidevs = genidevs_example; # String | Node Types (CM_CODEs separated by comma)
my $agentType = agentType_example; # String | Agent installed (agent_inst: Installed, agent_noinst: Not installed)
my $agentUpDown = agentUpDown_example; # String | Agent running (UP, DOWN)
my $ipEqual = true; # Boolean | IP Match Full
my $ip = ip_example; # String | IP
my $macEqual = true; # Boolean | MAC Match Full
my $mac = mac_example; # String | MAC
my $riskNode = true; # Boolean | Anomalies detected
my $riskDefinitionId = riskDefinitionId_example; # String | Anomaly Definition
my $beforeLoginTime = beforeLoginTime_example; # String | Logged in (yyyy-MM-dd hh:mm:ss)
my $qsearch = qsearch_example; # String | Search string
my $allColumns = true; # Boolean | Viewing all columns
my $ipUseOption = ipUseOption_example; # String | IP state (all: All, use: Assigned, unuse: Available)

eval { 
    $api_instance->getNodes(page => $page, pageSize => $pageSize, view => $view, sort => $sort, subjid => $subjid, perspective => $perspective, licenseLimitExceededTime => $licenseLimitExceededTime, nid => $nid, authdept => $authdept, authuser => $authuser, authuserExact => $authuserExact, property => $property, nodeproperty => $nodeproperty, macproperty => $macproperty, systemid => $systemid, roleid => $roleid, genidev => $genidev, genidevs => $genidevs, agentType => $agentType, agentUpDown => $agentUpDown, ipEqual => $ipEqual, ip => $ip, macEqual => $macEqual, mac => $mac, riskNode => $riskNode, riskDefinitionId => $riskDefinitionId, beforeLoginTime => $beforeLoginTime, qsearch => $qsearch, allColumns => $allColumns, ipUseOption => $ipUseOption);
};
if ($@) {
    warn "Exception when calling NodesApi->getNodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
view = view_example # String | Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View) (default to node)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
subjid = subjid_example # String | Node Group (SUBJ_ID) (optional)
perspective = perspective_example # String | View Criteria (node, dev) (optional)
licenseLimitExceededTime = licenseLimitExceededTime_example # String | licenseLimitExceededTime (optional)
nid = nid_example # String | Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group) (optional) (default to All)
authdept = authdept_example # String | Authenticated user's department (USER_DEPT) (optional)
authuser = authuser_example # String | Authenticated user ID and user name included (optional)
authuserExact = authuserExact_example # String | Authenticated user ID (optional)
property = property_example # String | Tag (Node, MAC) (optional)
nodeproperty = nodeproperty_example # String | Node Tag (optional)
macproperty = macproperty_example # String | MAC Tag (optional)
systemid = systemid_example # String | Node Policy (SYSTEM_ID) (optional)
roleid = roleid_example # String | Enforcement Policy (ROLE_ID) (optional)
genidev = genidev_example # String | Node Type (CM_CODE) (optional)
genidevs = genidevs_example # String | Node Types (CM_CODEs separated by comma) (optional)
agentType = agentType_example # String | Agent installed (agent_inst: Installed, agent_noinst: Not installed) (optional)
agentUpDown = agentUpDown_example # String | Agent running (UP, DOWN) (optional)
ipEqual = true # Boolean | IP Match Full (optional) (default to false)
ip = ip_example # String | IP (optional)
macEqual = true # Boolean | MAC Match Full (optional) (default to false)
mac = mac_example # String | MAC (optional)
riskNode = true # Boolean | Anomalies detected (optional)
riskDefinitionId = riskDefinitionId_example # String | Anomaly Definition (optional)
beforeLoginTime = beforeLoginTime_example # String | Logged in (yyyy-MM-dd hh:mm:ss) (optional)
qsearch = qsearch_example # String | Search string (optional)
allColumns = true # Boolean | Viewing all columns (optional)
ipUseOption = ipUseOption_example # String | IP state (all: All, use: Assigned, unuse: Available) (optional)

try: 
    # List Nodes
    api_instance.get_nodes(page, pageSize, view, sort=sort, subjid=subjid, perspective=perspective, licenseLimitExceededTime=licenseLimitExceededTime, nid=nid, authdept=authdept, authuser=authuser, authuserExact=authuserExact, property=property, nodeproperty=nodeproperty, macproperty=macproperty, systemid=systemid, roleid=roleid, genidev=genidev, genidevs=genidevs, agentType=agentType, agentUpDown=agentUpDown, ipEqual=ipEqual, ip=ip, macEqual=macEqual, mac=mac, riskNode=riskNode, riskDefinitionId=riskDefinitionId, beforeLoginTime=beforeLoginTime, qsearch=qsearch, allColumns=allColumns, ipUseOption=ipUseOption)
except ApiException as e:
    print("Exception when calling NodesApi->getNodes: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
view*
String
Views (summary: Overview, node: Node View, authuser: Authenticated User View, ipmgmt: IPAM View, risk: Anomaly View, pms: OS Update View, sms: Asset Management View, aa: Agent Action View, mediamgmt: External Device View)
Required
subjid
String
Node Group (SUBJ_ID)
perspective
String
View Criteria (node, dev)
licenseLimitExceededTime
String
licenseLimitExceededTime
nid
String
Retrieval Scope (Node ID: Policy Server / Sensor Node ID, All: All, ObjGroup: Group)
authdept
String
Authenticated user's department (USER_DEPT)
authuser
String
Authenticated user ID and user name included
authuserExact
String
Authenticated user ID
property
String
Tag (Node, MAC)
nodeproperty
String
Node Tag
macproperty
String
MAC Tag
systemid
String
Node Policy (SYSTEM_ID)
roleid
String
Enforcement Policy (ROLE_ID)
genidev
String
Node Type (CM_CODE)
genidevs
String
Node Types (CM_CODEs separated by comma)
agentType
String
Agent installed (agent_inst: Installed, agent_noinst: Not installed)
agentUpDown
String
Agent running (UP, DOWN)
ipEqual
Boolean
IP Match Full
ip
String
IP
macEqual
Boolean
MAC Match Full
mac
String
MAC
riskNode
Boolean
Anomalies detected
riskDefinitionId
String
Anomaly Definition
beforeLoginTime
String
Logged in (yyyy-MM-dd hh:mm:ss)
qsearch
String
Search string
allColumns
Boolean
Viewing all columns
ipUseOption
String
IP state (all: All, use: Assigned, unuse: Available)

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getPatchStatisticsForNode

Retrieve a specific Node's information

Retrieves the information of the Node specified.


/nodes/{nodeId}/patchstat

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/patchstat?page=&pageSize=&sort=&qsearch=¬meetpatch="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | qsearch
        String notmeetpatch = notmeetpatch_example; // String | Whether patch is not satisfied or all
        try {
            apiInstance.getPatchStatisticsForNode(nodeId, page, pageSize, sort, qsearch, notmeetpatch);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getPatchStatisticsForNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | qsearch
        String notmeetpatch = notmeetpatch_example; // String | Whether patch is not satisfied or all
        try {
            apiInstance.getPatchStatisticsForNode(nodeId, page, pageSize, sort, qsearch, notmeetpatch);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getPatchStatisticsForNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *qsearch = qsearch_example; // qsearch (optional)
String *notmeetpatch = notmeetpatch_example; // Whether patch is not satisfied or all (optional) (default to on)

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

// Retrieve a specific Node's information
[apiInstance getPatchStatisticsForNodeWith:nodeId
    page:page
    pageSize:pageSize
    sort:sort
    qsearch:qsearch
    notmeetpatch:notmeetpatch
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'qsearch': qsearch_example, // {String} qsearch
  'notmeetpatch': notmeetpatch_example // {String} Whether patch is not satisfied or all
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getPatchStatisticsForNode(nodeId, page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPatchStatisticsForNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var qsearch = qsearch_example;  // String | qsearch (optional) 
            var notmeetpatch = notmeetpatch_example;  // String | Whether patch is not satisfied or all (optional)  (default to on)

            try
            {
                // Retrieve a specific Node's information
                apiInstance.getPatchStatisticsForNode(nodeId, page, pageSize, sort, qsearch, notmeetpatch);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getPatchStatisticsForNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$qsearch = qsearch_example; // String | qsearch
$notmeetpatch = notmeetpatch_example; // String | Whether patch is not satisfied or all

try {
    $api_instance->getPatchStatisticsForNode($nodeId, $page, $pageSize, $sort, $qsearch, $notmeetpatch);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getPatchStatisticsForNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $qsearch = qsearch_example; # String | qsearch
my $notmeetpatch = notmeetpatch_example; # String | Whether patch is not satisfied or all

eval { 
    $api_instance->getPatchStatisticsForNode(nodeId => $nodeId, page => $page, pageSize => $pageSize, sort => $sort, qsearch => $qsearch, notmeetpatch => $notmeetpatch);
};
if ($@) {
    warn "Exception when calling NodesApi->getPatchStatisticsForNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
qsearch = qsearch_example # String | qsearch (optional)
notmeetpatch = notmeetpatch_example # String | Whether patch is not satisfied or all (optional) (default to on)

try: 
    # Retrieve a specific Node's information
    api_instance.get_patch_statistics_for_node(nodeId, page, pageSize, sort=sort, qsearch=qsearch, notmeetpatch=notmeetpatch)
except ApiException as e:
    print("Exception when calling NodesApi->getPatchStatisticsForNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
qsearch
String
qsearch
notmeetpatch
String
Whether patch is not satisfied or all

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getUpDownDatasOfNode

Retrieve a specific Node's connection status (UP / DOWN)

Retrieves the connection status (UP / DOWN) of the Node specified.


/nodes/{nodeId}/updown

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{nodeId}/updown"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getUpDownDatasOfNode(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getUpDownDatasOfNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        try {
            apiInstance.getUpDownDatasOfNode(nodeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#getUpDownDatasOfNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID

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

// Retrieve a specific Node's connection status (UP / DOWN)
[apiInstance getUpDownDatasOfNodeWith:nodeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID


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

namespace Example
{
    public class getUpDownDatasOfNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID

            try
            {
                // Retrieve a specific Node's connection status (UP / DOWN)
                apiInstance.getUpDownDatasOfNode(nodeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.getUpDownDatasOfNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID

try {
    $api_instance->getUpDownDatasOfNode($nodeId);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->getUpDownDatasOfNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID

eval { 
    $api_instance->getUpDownDatasOfNode(nodeId => $nodeId);
};
if ($@) {
    warn "Exception when calling NodesApi->getUpDownDatasOfNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID

try: 
    # Retrieve a specific Node's connection status (UP / DOWN)
    api_instance.get_up_down_datas_of_node(nodeId)
except ApiException as e:
    print("Exception when calling NodesApi->getUpDownDatasOfNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


logout

Deauthenticate a specific IP (MAC)

Deauthenticates the IP (MAC) specified.


/nodes/auth

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/nodes/auth"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String userId = userId_example; // String | Username (USER_ID)
        String scope = scope_example; // String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes String ip = ip_example; // String | IP String mac = mac_example; // String | MAC try { apiInstance.logout(userId, scope, ip, mac); } catch (ApiException e) { System.err.println("Exception when calling NodesApi#logout"); e.printStackTrace(); } } }
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String userId = userId_example; // String | Username (USER_ID)
        String scope = scope_example; // String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes String ip = ip_example; // String | IP String mac = mac_example; // String | MAC try { apiInstance.logout(userId, scope, ip, mac); } catch (ApiException e) { System.err.println("Exception when calling NodesApi#logout"); e.printStackTrace(); } } }
String *userId = userId_example; // Username (USER_ID)
String *scope = scope_example; // Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes (default to allUpNode) String *ip = ip_example; // IP (optional) String *mac = mac_example; // MAC (optional) NodesApi *apiInstance = [[NodesApi alloc] init]; // Deauthenticate a specific IP (MAC) [apiInstance logoutWith:userId scope:scope ip:ip mac:mac completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var userId = userId_example; // {String} Username (USER_ID)

var scope = scope_example; // {String} Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes var opts = { 'ip': ip_example, // {String} IP 'mac': mac_example // {String} MAC }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.logout(userId, scope, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class logoutExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var userId = userId_example;  // String | Username (USER_ID)
            var scope = scope_example;  // String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes (default to allUpNode) var ip = ip_example; // String | IP (optional) var mac = mac_example; // String | MAC (optional) try { // Deauthenticate a specific IP (MAC) apiInstance.logout(userId, scope, ip, mac); } catch (Exception e) { Debug.Print("Exception when calling NodesApi.logout: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$userId = userId_example; // String | Username (USER_ID)
$scope = scope_example; // String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes $ip = ip_example; // String | IP $mac = mac_example; // String | MAC try { $api_instance->logout($userId, $scope, $ip, $mac); } catch (Exception $e) { echo 'Exception when calling NodesApi->logout: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $userId = userId_example; # String | Username (USER_ID)
my $scope = scope_example; # String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes my $ip = ip_example; # String | IP my $mac = mac_example; # String | MAC eval { $api_instance->logout(userId => $userId, scope => $scope, ip => $ip, mac => $mac); }; if ($@) { warn "Exception when calling NodesApi->logout: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
userId = userId_example # String | Username (USER_ID)
scope = scope_example # String | Scope
singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes (default to allUpNode) ip = ip_example # String | IP (optional) mac = mac_example # String | MAC (optional) try: # Deauthenticate a specific IP (MAC) api_instance.logout(userId, scope, ip=ip, mac=mac) except ApiException as e: print("Exception when calling NodesApi->logout: %s\n" % e)

Parameters

Form parameters
Name Description
userId*
String
Username (USER_ID)
Required
ip
String
IP
mac
String
MAC
scope*
String
Scope<br/>singleUpNode: A single UP Node, allUpNode: All UP Nodes, singleNode: A single Node, allNode: All Nodes
Required

Responses

Status: 206 - Partial Content

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


managementScope

Retrieves a specific IP address's state

Retrieves the state of the IP address specified.


/nodes/{ip}/managementscope

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/nodes/{ip}/managementscope"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String ip = ip_example; // String | IP
        try {
            IP Value Object result = apiInstance.managementScope(ip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#managementScope");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String ip = ip_example; // String | IP
        try {
            IP Value Object result = apiInstance.managementScope(ip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#managementScope");
            e.printStackTrace();
        }
    }
}
String *ip = ip_example; // IP

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

// Retrieves a specific IP address's state
[apiInstance managementScopeWith:ip
              completionHandler: ^(IP Value Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var ip = ip_example; // {String} IP


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

namespace Example
{
    public class managementScopeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var ip = ip_example;  // String | IP

            try
            {
                // Retrieves a specific IP address's state
                IP Value Object result = apiInstance.managementScope(ip);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.managementScope: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$ip = ip_example; // String | IP

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

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $ip = ip_example; # String | IP

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

# create an instance of the API class
api_instance = swagger_client.NodesApi()
ip = ip_example # String | IP

try: 
    # Retrieves a specific IP address's state
    api_response = api_instance.management_scope(ip)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NodesApi->managementScope: %s\n" % e)

Parameters

Path parameters
Name Description
ip*
String
IP
Required

Responses

Status: 200 - successful operation

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - IP not found


nodeAuth

Require a specific Node's User Authentication

Requires the User Authentication of the Node specified.


/nodes/{nodeId}/auth

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/nodes/{nodeId}/auth"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String userId = userId_example; // String | Username (USER_ID)
        String passCheck = passCheck_example; // String | Password check (1: Check, Leave blank not to check)
        String passwd = passwd_example; // String | Password
        try {
            apiInstance.nodeAuth(nodeId, userId, passCheck, passwd);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#nodeAuth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String userId = userId_example; // String | Username (USER_ID)
        String passCheck = passCheck_example; // String | Password check (1: Check, Leave blank not to check)
        String passwd = passwd_example; // String | Password
        try {
            apiInstance.nodeAuth(nodeId, userId, passCheck, passwd);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#nodeAuth");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
String *userId = userId_example; // Username (USER_ID)
String *passCheck = passCheck_example; // Password check (1: Check, Leave blank not to check) (default to 1)
String *passwd = passwd_example; // Password (optional)

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

// Require a specific Node's User Authentication
[apiInstance nodeAuthWith:nodeId
    userId:userId
    passCheck:passCheck
    passwd:passwd
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var userId = userId_example; // {String} Username (USER_ID)

var passCheck = passCheck_example; // {String} Password check (1: Check, Leave blank not to check)

var opts = { 
  'passwd': passwd_example // {String} Password
};

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

namespace Example
{
    public class nodeAuthExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var userId = userId_example;  // String | Username (USER_ID)
            var passCheck = passCheck_example;  // String | Password check (1: Check, Leave blank not to check) (default to 1)
            var passwd = passwd_example;  // String | Password (optional) 

            try
            {
                // Require a specific Node's User Authentication
                apiInstance.nodeAuth(nodeId, userId, passCheck, passwd);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.nodeAuth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$userId = userId_example; // String | Username (USER_ID)
$passCheck = passCheck_example; // String | Password check (1: Check, Leave blank not to check)
$passwd = passwd_example; // String | Password

try {
    $api_instance->nodeAuth($nodeId, $userId, $passCheck, $passwd);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->nodeAuth: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $userId = userId_example; # String | Username (USER_ID)
my $passCheck = passCheck_example; # String | Password check (1: Check, Leave blank not to check)
my $passwd = passwd_example; # String | Password

eval { 
    $api_instance->nodeAuth(nodeId => $nodeId, userId => $userId, passCheck => $passCheck, passwd => $passwd);
};
if ($@) {
    warn "Exception when calling NodesApi->nodeAuth: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
userId = userId_example # String | Username (USER_ID)
passCheck = passCheck_example # String | Password check (1: Check, Leave blank not to check) (default to 1)
passwd = passwd_example # String | Password (optional)

try: 
    # Require a specific Node's User Authentication
    api_instance.node_auth(nodeId, userId, passCheck, passwd=passwd)
except ApiException as e:
    print("Exception when calling NodesApi->nodeAuth: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Form parameters
Name Description
userId*
String
Username (USER_ID)
Required
passwd
String
Password
passCheck*
String
Password check (1: Check, Leave blank not to check)
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


nodeLogout

Deauthenticate a specific Node

Deauthenticates the Node specified.


/nodes/{nodeId}/auth

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/nodes/{nodeId}/auth?authby="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String authby = authby_example; // String | Authentication by
        try {
            apiInstance.nodeLogout(nodeId, authby);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#nodeLogout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String authby = authby_example; // String | Authentication by
        try {
            apiInstance.nodeLogout(nodeId, authby);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#nodeLogout");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
String *authby = authby_example; // Authentication by (optional) (default to cwp)

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

// Deauthenticate a specific Node
[apiInstance nodeLogoutWith:nodeId
    authby:authby
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var opts = { 
  'authby': authby_example // {String} Authentication by
};

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

namespace Example
{
    public class nodeLogoutExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var authby = authby_example;  // String | Authentication by (optional)  (default to cwp)

            try
            {
                // Deauthenticate a specific Node
                apiInstance.nodeLogout(nodeId, authby);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.nodeLogout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$authby = authby_example; // String | Authentication by

try {
    $api_instance->nodeLogout($nodeId, $authby);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->nodeLogout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $authby = authby_example; # String | Authentication by

eval { 
    $api_instance->nodeLogout(nodeId => $nodeId, authby => $authby);
};
if ($@) {
    warn "Exception when calling NodesApi->nodeLogout: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
authby = authby_example # String | Authentication by (optional) (default to cwp)

try: 
    # Deauthenticate a specific Node
    api_instance.node_logout(nodeId, authby=authby)
except ApiException as e:
    print("Exception when calling NodesApi->nodeLogout: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Query parameters
Name Description
authby
String
Authentication by

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


performNodeActionOnNode

Run a specific Node's Node Action

Runs The Node Action of the Node specified.


/nodes/{nodeId}/nodeaction

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/nodes/{nodeId}/nodeaction?nodeaction="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String nodeaction = nodeaction_example; // String | Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)
        try {
            apiInstance.performNodeActionOnNode(nodeId, nodeaction);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#performNodeActionOnNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        String nodeaction = nodeaction_example; // String | Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)
        try {
            apiInstance.performNodeActionOnNode(nodeId, nodeaction);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#performNodeActionOnNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
String *nodeaction = nodeaction_example; // Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)

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

// Run a specific Node's Node Action
[apiInstance performNodeActionOnNodeWith:nodeId
    nodeaction:nodeaction
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var nodeaction = nodeaction_example; // {String} Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)


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

namespace Example
{
    public class performNodeActionOnNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var nodeaction = nodeaction_example;  // String | Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)

            try
            {
                // Run a specific Node's Node Action
                apiInstance.performNodeActionOnNode(nodeId, nodeaction);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.performNodeActionOnNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$nodeaction = nodeaction_example; // String | Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)

try {
    $api_instance->performNodeActionOnNode($nodeId, $nodeaction);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->performNodeActionOnNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $nodeaction = nodeaction_example; # String | Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)

eval { 
    $api_instance->performNodeActionOnNode(nodeId => $nodeId, nodeaction => $nodeaction);
};
if ($@) {
    warn "Exception when calling NodesApi->performNodeActionOnNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
nodeaction = nodeaction_example # String | Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)

try: 
    # Run a specific Node's Node Action
    api_instance.perform_node_action_on_node(nodeId, nodeaction)
except ApiException as e:
    print("Exception when calling NodesApi->performNodeActionOnNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Query parameters
Name Description
nodeaction*
String
Node Action (1: Node Information scanning, 7: OS Update, 8: Excute Agent actions, 10: Send the node asset information, 12: Reapplying node policies, 18: Start Agent service, 19: Stop Agent service, 20: Agent Update, 21: Server failure Recovery, 25: Integrity Verification27: Collect Agent Logs)
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Node Not Found

Status: 500 - Internal Server Error


updateDevice

Update an existing Node

Updates an existing Node.


/nodes/{nodeId}/device

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/nodes/{nodeId}/device"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        DeviceVo body = ; // DeviceVo | DeviceVo JSON
        try {
            apiInstance.updateDevice(nodeId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#updateDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        DeviceVo body = ; // DeviceVo | DeviceVo JSON
        try {
            apiInstance.updateDevice(nodeId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#updateDevice");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
DeviceVo *body = ; // DeviceVo JSON

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

// Update an existing Node
[apiInstance updateDeviceWith:nodeId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var body = ; // {DeviceVo} DeviceVo JSON


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

namespace Example
{
    public class updateDeviceExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var body = new DeviceVo(); // DeviceVo | DeviceVo JSON

            try
            {
                // Update an existing Node
                apiInstance.updateDevice(nodeId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.updateDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$body = ; // DeviceVo | DeviceVo JSON

try {
    $api_instance->updateDevice($nodeId, $body);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->updateDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $body = WWW::SwaggerClient::Object::DeviceVo->new(); # DeviceVo | DeviceVo JSON

eval { 
    $api_instance->updateDevice(nodeId => $nodeId, body => $body);
};
if ($@) {
    warn "Exception when calling NodesApi->updateDevice: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
body =  # DeviceVo | DeviceVo JSON

try: 
    # Update an existing Node
    api_instance.update_device(nodeId, body)
except ApiException as e:
    print("Exception when calling NodesApi->updateDevice: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 404 - Node Not Found

Status: 500 - Internal Server Error


updateDeviceAsset

Modify asset information of the device

Modify the asset information of the device registered as node.


/nodes/{nodeId}/device/asset

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/nodes/{nodeId}/device/asset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        DevInfoAllAssetVo body = ; // DevInfoAllAssetVo | DevInfoAllAssetVo JSON
        try {
            apiInstance.updateDeviceAsset(nodeId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#updateDeviceAsset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        DevInfoAllAssetVo body = ; // DevInfoAllAssetVo | DevInfoAllAssetVo JSON
        try {
            apiInstance.updateDeviceAsset(nodeId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#updateDeviceAsset");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
DevInfoAllAssetVo *body = ; // DevInfoAllAssetVo JSON

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

// Modify asset information of the device
[apiInstance updateDeviceAssetWith:nodeId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var body = ; // {DevInfoAllAssetVo} DevInfoAllAssetVo JSON


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

namespace Example
{
    public class updateDeviceAssetExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var body = new DevInfoAllAssetVo(); // DevInfoAllAssetVo | DevInfoAllAssetVo JSON

            try
            {
                // Modify asset information of the device
                apiInstance.updateDeviceAsset(nodeId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.updateDeviceAsset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$body = ; // DevInfoAllAssetVo | DevInfoAllAssetVo JSON

try {
    $api_instance->updateDeviceAsset($nodeId, $body);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->updateDeviceAsset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $body = WWW::SwaggerClient::Object::DevInfoAllAssetVo->new(); # DevInfoAllAssetVo | DevInfoAllAssetVo JSON

eval { 
    $api_instance->updateDeviceAsset(nodeId => $nodeId, body => $body);
};
if ($@) {
    warn "Exception when calling NodesApi->updateDeviceAsset: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
body =  # DevInfoAllAssetVo | DevInfoAllAssetVo JSON

try: 
    # Modify asset information of the device
    api_instance.update_device_asset(nodeId, body)
except ApiException as e:
    print("Exception when calling NodesApi->updateDeviceAsset: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 404 - Node Not Found

Status: 500 - Internal Server Error


updateNode

Update an existing Node

Updates an existing Node.<br><br>The updateable items are as follows.<br>nl_name, nl_genidev, nl_genidevconfirm, nl_genidev2, nl_genidev2confirm, nl_desc, nl_flags, nl_fqdn, nl_platform, nl_platformconfirm, nl_domain,nl_dnsname, nl_osdetect, nl_osconfirm, nl_custom01 ~ nl_custom20<br><br>Please check model for item description


/nodes/{nodeId}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/nodes/{nodeId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        NodeVo body = ; // NodeVo | NodeVo JSON
        try {
            apiInstance.updateNode(nodeId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#updateNode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        NodeVo body = ; // NodeVo | NodeVo JSON
        try {
            apiInstance.updateNode(nodeId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#updateNode");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
NodeVo *body = ; // NodeVo JSON

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

// Update an existing Node
[apiInstance updateNodeWith:nodeId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var body = ; // {NodeVo} NodeVo JSON


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

namespace Example
{
    public class updateNodeExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var body = new NodeVo(); // NodeVo | NodeVo JSON

            try
            {
                // Update an existing Node
                apiInstance.updateNode(nodeId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.updateNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$body = ; // NodeVo | NodeVo JSON

try {
    $api_instance->updateNode($nodeId, $body);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->updateNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $body = WWW::SwaggerClient::Object::NodeVo->new(); # NodeVo | NodeVo JSON

eval { 
    $api_instance->updateNode(nodeId => $nodeId, body => $body);
};
if ($@) {
    warn "Exception when calling NodesApi->updateNode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
body =  # NodeVo | NodeVo JSON

try: 
    # Update an existing Node
    api_instance.update_node(nodeId, body)
except ApiException as e:
    print("Exception when calling NodesApi->updateNode: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 404 - Node Not Found

Status: 500 - Internal Server Error


updateNodePolicy

Update an existing Node

Updates an existing Node.


/nodes/{nodeId}/policy

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/nodes/{nodeId}/policy?comment="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NodesApi;

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

public class NodesApiExample {

    public static void main(String[] args) {
        
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        NodePolicyVo body = ; // NodePolicyVo | Node Policy Vo JSON
        String comment = comment_example; // String | Comment
        try {
            apiInstance.updateNodePolicy(nodeId, body, comment);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#updateNodePolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NodesApi;

public class NodesApiExample {

    public static void main(String[] args) {
        NodesApi apiInstance = new NodesApi();
        String nodeId = nodeId_example; // String | Node ID
        NodePolicyVo body = ; // NodePolicyVo | Node Policy Vo JSON
        String comment = comment_example; // String | Comment
        try {
            apiInstance.updateNodePolicy(nodeId, body, comment);
        } catch (ApiException e) {
            System.err.println("Exception when calling NodesApi#updateNodePolicy");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Node ID
NodePolicyVo *body = ; // Node Policy Vo JSON
String *comment = comment_example; // Comment (optional)

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

// Update an existing Node
[apiInstance updateNodePolicyWith:nodeId
    body:body
    comment:comment
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.NodesApi()

var nodeId = nodeId_example; // {String} Node ID

var body = ; // {NodePolicyVo} Node Policy Vo JSON

var opts = { 
  'comment': comment_example // {String} Comment
};

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

namespace Example
{
    public class updateNodePolicyExample
    {
        public void main()
        {
            
            var apiInstance = new NodesApi();
            var nodeId = nodeId_example;  // String | Node ID
            var body = new NodePolicyVo(); // NodePolicyVo | Node Policy Vo JSON
            var comment = comment_example;  // String | Comment (optional) 

            try
            {
                // Update an existing Node
                apiInstance.updateNodePolicy(nodeId, body, comment);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NodesApi.updateNodePolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\NodesApi();
$nodeId = nodeId_example; // String | Node ID
$body = ; // NodePolicyVo | Node Policy Vo JSON
$comment = comment_example; // String | Comment

try {
    $api_instance->updateNodePolicy($nodeId, $body, $comment);
} catch (Exception $e) {
    echo 'Exception when calling NodesApi->updateNodePolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NodesApi;

my $api_instance = WWW::SwaggerClient::NodesApi->new();
my $nodeId = nodeId_example; # String | Node ID
my $body = WWW::SwaggerClient::Object::NodePolicyVo->new(); # NodePolicyVo | Node Policy Vo JSON
my $comment = comment_example; # String | Comment

eval { 
    $api_instance->updateNodePolicy(nodeId => $nodeId, body => $body, comment => $comment);
};
if ($@) {
    warn "Exception when calling NodesApi->updateNodePolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NodesApi()
nodeId = nodeId_example # String | Node ID
body =  # NodePolicyVo | Node Policy Vo JSON
comment = comment_example # String | Comment (optional)

try: 
    # Update an existing Node
    api_instance.update_node_policy(nodeId, body, comment=comment)
except ApiException as e:
    print("Exception when calling NodesApi->updateNodePolicy: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Node ID
Required
Body parameters
Name Description
body *
Query parameters
Name Description
comment
String
Comment

Responses

Status: 401 - Unauthorized

Status: 404 - Node Not Found

Status: 500 - Internal Server Error


Policies

apply

Apply Policy

Apply Policy


/policies/apply

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/policies/apply"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoliciesApi;

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

public class PoliciesApiExample {

    public static void main(String[] args) {
        
        PoliciesApi apiInstance = new PoliciesApi();
        try {
            apiInstance.apply();
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#apply");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoliciesApi;

public class PoliciesApiExample {

    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        try {
            apiInstance.apply();
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#apply");
            e.printStackTrace();
        }
    }
}

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

// Apply Policy
[apiInstance applyWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.PoliciesApi()

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

namespace Example
{
    public class applyExample
    {
        public void main()
        {
            
            var apiInstance = new PoliciesApi();

            try
            {
                // Apply Policy
                apiInstance.apply();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoliciesApi.apply: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PoliciesApi();

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

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

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

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

try: 
    # Apply Policy
    api_instance.apply()
except ApiException as e:
    print("Exception when calling PoliciesApi->apply: %s\n" % e)

Parameters

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


createNetworkObject

Add a new network object

Add a new network object


/policies/object/networks

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/policies/object/networks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoliciesApi;

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

public class PoliciesApiExample {

    public static void main(String[] args) {
        
        PoliciesApi apiInstance = new PoliciesApi();
        네트워크 객체 body = ; // 네트워크 객체 | Network Object
        try {
            apiInstance.createNetworkObject(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#createNetworkObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoliciesApi;

public class PoliciesApiExample {

    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        네트워크 객체 body = ; // 네트워크 객체 | Network Object
        try {
            apiInstance.createNetworkObject(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#createNetworkObject");
            e.printStackTrace();
        }
    }
}
네트워크 객체 *body = ; // Network Object

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

// Add a new network object
[apiInstance createNetworkObjectWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.PoliciesApi()

var body = ; // {네트워크 객체} Network Object


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

namespace Example
{
    public class createNetworkObjectExample
    {
        public void main()
        {
            
            var apiInstance = new PoliciesApi();
            var body = new 네트워크 객체(); // 네트워크 객체 | Network Object

            try
            {
                // Add a new network object
                apiInstance.createNetworkObject(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoliciesApi.createNetworkObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PoliciesApi();
$body = ; // 네트워크 객체 | Network Object

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

my $api_instance = WWW::SwaggerClient::PoliciesApi->new();
my $body = WWW::SwaggerClient::Object::네트워크 객체->new(); # 네트워크 객체 | Network Object

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

# create an instance of the API class
api_instance = swagger_client.PoliciesApi()
body =  # 네트워크 객체 | Network Object

try: 
    # Add a new network object
    api_instance.create_network_object(body)
except ApiException as e:
    print("Exception when calling PoliciesApi->createNetworkObject: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getEnforcementPolicies

List Enforcement Policies

Retrieves a list of the Enforcement Policies.


/policies/enforcementpolicies

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/policies/enforcementpolicies?page=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoliciesApi;

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

public class PoliciesApiExample {

    public static void main(String[] args) {
        
        PoliciesApi apiInstance = new PoliciesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getEnforcementPolicies(page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getEnforcementPolicies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoliciesApi;

public class PoliciesApiExample {

    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getEnforcementPolicies(page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getEnforcementPolicies");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

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

// List Enforcement Policies
[apiInstance getEnforcementPoliciesWith:page
    pageSize:pageSize
    sort:sort
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.PoliciesApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getEnforcementPolicies(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEnforcementPoliciesExample
    {
        public void main()
        {
            
            var apiInstance = new PoliciesApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 

            try
            {
                // List Enforcement Policies
                apiInstance.getEnforcementPolicies(page, pageSize, sort);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoliciesApi.getEnforcementPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PoliciesApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

try {
    $api_instance->getEnforcementPolicies($page, $pageSize, $sort);
} catch (Exception $e) {
    echo 'Exception when calling PoliciesApi->getEnforcementPolicies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoliciesApi;

my $api_instance = WWW::SwaggerClient::PoliciesApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

eval { 
    $api_instance->getEnforcementPolicies(page => $page, pageSize => $pageSize, sort => $sort);
};
if ($@) {
    warn "Exception when calling PoliciesApi->getEnforcementPolicies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoliciesApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

try: 
    # List Enforcement Policies
    api_instance.get_enforcement_policies(page, pageSize, sort=sort)
except ApiException as e:
    print("Exception when calling PoliciesApi->getEnforcementPolicies: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNetworkObject

Retrieve a specific network object

Retrieve a specific network object


/policies/object/networks/{id}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/policies/object/networks/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoliciesApi;

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

public class PoliciesApiExample {

    public static void main(String[] args) {
        
        PoliciesApi apiInstance = new PoliciesApi();
        String id = id_example; // String | Network Object ID
        try {
            apiInstance.getNetworkObject(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getNetworkObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoliciesApi;

public class PoliciesApiExample {

    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        String id = id_example; // String | Network Object ID
        try {
            apiInstance.getNetworkObject(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getNetworkObject");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Network Object ID

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

// Retrieve a specific network object
[apiInstance getNetworkObjectWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.PoliciesApi()

var id = id_example; // {String} Network Object ID


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

namespace Example
{
    public class getNetworkObjectExample
    {
        public void main()
        {
            
            var apiInstance = new PoliciesApi();
            var id = id_example;  // String | Network Object ID

            try
            {
                // Retrieve a specific network object
                apiInstance.getNetworkObject(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoliciesApi.getNetworkObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PoliciesApi();
$id = id_example; // String | Network Object ID

try {
    $api_instance->getNetworkObject($id);
} catch (Exception $e) {
    echo 'Exception when calling PoliciesApi->getNetworkObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoliciesApi;

my $api_instance = WWW::SwaggerClient::PoliciesApi->new();
my $id = id_example; # String | Network Object ID

eval { 
    $api_instance->getNetworkObject(id => $id);
};
if ($@) {
    warn "Exception when calling PoliciesApi->getNetworkObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoliciesApi()
id = id_example # String | Network Object ID

try: 
    # Retrieve a specific network object
    api_instance.get_network_object(id)
except ApiException as e:
    print("Exception when calling PoliciesApi->getNetworkObject: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Network Object ID
Required

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getNetworkObjects

List of network objects

Retrieves a list of the networks objects.


/policies/object/networks

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/policies/object/networks?page=&pageSize=&sort=&qsearch="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoliciesApi;

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

public class PoliciesApiExample {

    public static void main(String[] args) {
        
        PoliciesApi apiInstance = new PoliciesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | Search string
        try {
            apiInstance.getNetworkObjects(page, pageSize, sort, qsearch);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getNetworkObjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoliciesApi;

public class PoliciesApiExample {

    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        String qsearch = qsearch_example; // String | Search string
        try {
            apiInstance.getNetworkObjects(page, pageSize, sort, qsearch);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getNetworkObjects");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
String *qsearch = qsearch_example; // Search string (optional)

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

// List of network objects
[apiInstance getNetworkObjectsWith:page
    pageSize:pageSize
    sort:sort
    qsearch:qsearch
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.PoliciesApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
  'qsearch': qsearch_example // {String} Search string
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getNetworkObjects(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkObjectsExample
    {
        public void main()
        {
            
            var apiInstance = new PoliciesApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 
            var qsearch = qsearch_example;  // String | Search string (optional) 

            try
            {
                // List of network objects
                apiInstance.getNetworkObjects(page, pageSize, sort, qsearch);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoliciesApi.getNetworkObjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PoliciesApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
$qsearch = qsearch_example; // String | Search string

try {
    $api_instance->getNetworkObjects($page, $pageSize, $sort, $qsearch);
} catch (Exception $e) {
    echo 'Exception when calling PoliciesApi->getNetworkObjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoliciesApi;

my $api_instance = WWW::SwaggerClient::PoliciesApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
my $qsearch = qsearch_example; # String | Search string

eval { 
    $api_instance->getNetworkObjects(page => $page, pageSize => $pageSize, sort => $sort, qsearch => $qsearch);
};
if ($@) {
    warn "Exception when calling PoliciesApi->getNetworkObjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoliciesApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)
qsearch = qsearch_example # String | Search string (optional)

try: 
    # List of network objects
    api_instance.get_network_objects(page, pageSize, sort=sort, qsearch=qsearch)
except ApiException as e:
    print("Exception when calling PoliciesApi->getNetworkObjects: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
qsearch
String
Search string

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getNodePolicies

List Node Policies

Retrieves a list of the Node Policies.


/policies/nodepolicies

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/policies/nodepolicies?page=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoliciesApi;

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

public class PoliciesApiExample {

    public static void main(String[] args) {
        
        PoliciesApi apiInstance = new PoliciesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getNodePolicies(page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getNodePolicies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoliciesApi;

public class PoliciesApiExample {

    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getNodePolicies(page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getNodePolicies");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

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

// List Node Policies
[apiInstance getNodePoliciesWith:page
    pageSize:pageSize
    sort:sort
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.PoliciesApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getNodePolicies(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNodePoliciesExample
    {
        public void main()
        {
            
            var apiInstance = new PoliciesApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 

            try
            {
                // List Node Policies
                apiInstance.getNodePolicies(page, pageSize, sort);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoliciesApi.getNodePolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PoliciesApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

try {
    $api_instance->getNodePolicies($page, $pageSize, $sort);
} catch (Exception $e) {
    echo 'Exception when calling PoliciesApi->getNodePolicies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoliciesApi;

my $api_instance = WWW::SwaggerClient::PoliciesApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

eval { 
    $api_instance->getNodePolicies(page => $page, pageSize => $pageSize, sort => $sort);
};
if ($@) {
    warn "Exception when calling PoliciesApi->getNodePolicies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoliciesApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

try: 
    # List Node Policies
    api_instance.get_node_policies(page, pageSize, sort=sort)
except ApiException as e:
    print("Exception when calling PoliciesApi->getNodePolicies: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getWlanPolicies

List Wlan Policies

Retrieves a list of the Wlan Policies.


/policies/wlanpolicies

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/policies/wlanpolicies?page=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoliciesApi;

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

public class PoliciesApiExample {

    public static void main(String[] args) {
        
        PoliciesApi apiInstance = new PoliciesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getWlanPolicies(page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getWlanPolicies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoliciesApi;

public class PoliciesApiExample {

    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
        try {
            apiInstance.getWlanPolicies(page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#getWlanPolicies");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

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

// List Wlan Policies
[apiInstance getWlanPoliciesWith:page
    pageSize:pageSize
    sort:sort
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.PoliciesApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getWlanPolicies(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWlanPoliciesExample
    {
        public void main()
        {
            
            var apiInstance = new PoliciesApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional) 

            try
            {
                // List Wlan Policies
                apiInstance.getWlanPolicies(page, pageSize, sort);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoliciesApi.getWlanPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PoliciesApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

try {
    $api_instance->getWlanPolicies($page, $pageSize, $sort);
} catch (Exception $e) {
    echo 'Exception when calling PoliciesApi->getWlanPolicies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoliciesApi;

my $api_instance = WWW::SwaggerClient::PoliciesApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

eval { 
    $api_instance->getWlanPolicies(page => $page, pageSize => $pageSize, sort => $sort);
};
if ($@) {
    warn "Exception when calling PoliciesApi->getWlanPolicies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoliciesApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"}) (optional)

try: 
    # List Wlan Policies
    api_instance.get_wlan_policies(page, pageSize, sort=sort)
except ApiException as e:
    print("Exception when calling PoliciesApi->getWlanPolicies: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


updateNetworkObject

Update an existing network object

Update an existing network object


/policies/object/networks

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/policies/object/networks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoliciesApi;

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

public class PoliciesApiExample {

    public static void main(String[] args) {
        
        PoliciesApi apiInstance = new PoliciesApi();
        네트워크 객체 body = ; // 네트워크 객체 | Network Object
        try {
            apiInstance.updateNetworkObject(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#updateNetworkObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoliciesApi;

public class PoliciesApiExample {

    public static void main(String[] args) {
        PoliciesApi apiInstance = new PoliciesApi();
        네트워크 객체 body = ; // 네트워크 객체 | Network Object
        try {
            apiInstance.updateNetworkObject(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoliciesApi#updateNetworkObject");
            e.printStackTrace();
        }
    }
}
네트워크 객체 *body = ; // Network Object

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

// Update an existing network object
[apiInstance updateNetworkObjectWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.PoliciesApi()

var body = ; // {네트워크 객체} Network Object


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

namespace Example
{
    public class updateNetworkObjectExample
    {
        public void main()
        {
            
            var apiInstance = new PoliciesApi();
            var body = new 네트워크 객체(); // 네트워크 객체 | Network Object

            try
            {
                // Update an existing network object
                apiInstance.updateNetworkObject(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoliciesApi.updateNetworkObject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PoliciesApi();
$body = ; // 네트워크 객체 | Network Object

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

my $api_instance = WWW::SwaggerClient::PoliciesApi->new();
my $body = WWW::SwaggerClient::Object::네트워크 객체->new(); # 네트워크 객체 | Network Object

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

# create an instance of the API class
api_instance = swagger_client.PoliciesApi()
body =  # 네트워크 객체 | Network Object

try: 
    # Update an existing network object
    api_instance.update_network_object(body)
except ApiException as e:
    print("Exception when calling PoliciesApi->updateNetworkObject: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


Reports

getReportDownloadFiles

Download a specific Report's file(s)

Downloads the file(s) generated by the Report specified.


/reports/{reportId}/downloadFile

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/reports/{reportId}/downloadFile?filename="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        String reportId = reportId_example; // String | Report ID (ReportId)
        String filename = filename_example; // String | File Name
  The UTF-8 should be used for URLEncoder. try { apiInstance.getReportDownloadFiles(reportId, filename); } catch (ApiException e) { System.err.println("Exception when calling ReportsApi#getReportDownloadFiles"); e.printStackTrace(); } } }
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String reportId = reportId_example; // String | Report ID (ReportId)
        String filename = filename_example; // String | File Name
  The UTF-8 should be used for URLEncoder. try { apiInstance.getReportDownloadFiles(reportId, filename); } catch (ApiException e) { System.err.println("Exception when calling ReportsApi#getReportDownloadFiles"); e.printStackTrace(); } } }
String *reportId = reportId_example; // Report ID (ReportId)
String *filename = filename_example; // File Name
  The UTF-8 should be used for URLEncoder. ReportsApi *apiInstance = [[ReportsApi alloc] init]; // Download a specific Report's file(s) [apiInstance getReportDownloadFilesWith:reportId filename:filename completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ReportsApi()

var reportId = reportId_example; // {String} Report ID (ReportId)

var filename = filename_example; // {String} File Name
  The UTF-8 should be used for URLEncoder. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.getReportDownloadFiles(reportId, filename, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReportDownloadFilesExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var reportId = reportId_example;  // String | Report ID (ReportId)
            var filename = filename_example;  // String | File Name
  The UTF-8 should be used for URLEncoder. try { // Download a specific Report's file(s) apiInstance.getReportDownloadFiles(reportId, filename); } catch (Exception e) { Debug.Print("Exception when calling ReportsApi.getReportDownloadFiles: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$reportId = reportId_example; // String | Report ID (ReportId)
$filename = filename_example; // String | File Name
  The UTF-8 should be used for URLEncoder. try { $api_instance->getReportDownloadFiles($reportId, $filename); } catch (Exception $e) { echo 'Exception when calling ReportsApi->getReportDownloadFiles: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $reportId = reportId_example; # String | Report ID (ReportId)
my $filename = filename_example; # String | File Name
  The UTF-8 should be used for URLEncoder. eval { $api_instance->getReportDownloadFiles(reportId => $reportId, filename => $filename); }; if ($@) { warn "Exception when calling ReportsApi->getReportDownloadFiles: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
reportId = reportId_example # String | Report ID (ReportId)
filename = filename_example # String | File Name
  The UTF-8 should be used for URLEncoder. try: # Download a specific Report's file(s) api_instance.get_report_download_files(reportId, filename) except ApiException as e: print("Exception when calling ReportsApi->getReportDownloadFiles: %s\n" % e)

Parameters

Path parameters
Name Description
reportId*
String
Report ID (ReportId)
Required
Query parameters
Name Description
filename*
String
File Name<br/>&nbsp; The UTF-8 should be used for URLEncoder.
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getReportFiles

Retrieve a specific Report's file(s)

Retrieves the file(s) generated by the Report specified.


/reports/{reportId}/files

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/reports/{reportId}/files?page=&pageSize=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        String reportId = reportId_example; // String | Report ID (ReportId) only for Query Report (GWP300001) and Log Report (GWP300006)
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"}
        try {
            apiInstance.getReportFiles(reportId, page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String reportId = reportId_example; // String | Report ID (ReportId) only for Query Report (GWP300001) and Log Report (GWP300006)
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"}
        try {
            apiInstance.getReportFiles(reportId, page, pageSize, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportFiles");
            e.printStackTrace();
        }
    }
}
String *reportId = reportId_example; // Report ID (ReportId) only for Query Report (GWP300001) and Log Report (GWP300006)
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"} (optional)

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

// Retrieve a specific Report's file(s)
[apiInstance getReportFilesWith:reportId
    page:page
    pageSize:pageSize
    sort:sort
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ReportsApi()

var reportId = reportId_example; // {String} Report ID (ReportId) only for Query Report (GWP300001) and Log Report (GWP300006)

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example // {String} Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getReportFiles(reportId, page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReportFilesExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var reportId = reportId_example;  // String | Report ID (ReportId) only for Query Report (GWP300001) and Log Report (GWP300006)
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"} (optional) 

            try
            {
                // Retrieve a specific Report's file(s)
                apiInstance.getReportFiles(reportId, page, pageSize, sort);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getReportFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$reportId = reportId_example; // String | Report ID (ReportId) only for Query Report (GWP300001) and Log Report (GWP300006)
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"}

try {
    $api_instance->getReportFiles($reportId, $page, $pageSize, $sort);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReportFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $reportId = reportId_example; # String | Report ID (ReportId) only for Query Report (GWP300001) and Log Report (GWP300006)
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"}

eval { 
    $api_instance->getReportFiles(reportId => $reportId, page => $page, pageSize => $pageSize, sort => $sort);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReportFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
reportId = reportId_example # String | Report ID (ReportId) only for Query Report (GWP300001) and Log Report (GWP300006)
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"} (optional)

try: 
    # Retrieve a specific Report's file(s)
    api_instance.get_report_files(reportId, page, pageSize, sort=sort)
except ApiException as e:
    print("Exception when calling ReportsApi->getReportFiles: %s\n" % e)

Parameters

Path parameters
Name Description
reportId*
String
Report ID (ReportId) only for <b>Query Report (GWP300001) and Log Report (GWP300006)</b>
Required
Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON - {"field":"CreateDate","dir":"desc"}

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getReportResultDatas

Retrieve a specific Report's data

Retrieves the data of the Report specified.


/reports/{reportId}/result

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/reports/{reportId}/result?itemIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        String reportId = reportId_example; // String | Report ID (500: Node Group, 501: WLAN Group, 502: Log Filter)
        String itemIds = itemIds_example; // String | ItemID (Use a comma to separate entries.)
        try {
            apiInstance.getReportResultDatas(reportId, itemIds);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportResultDatas");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String reportId = reportId_example; // String | Report ID (500: Node Group, 501: WLAN Group, 502: Log Filter)
        String itemIds = itemIds_example; // String | ItemID (Use a comma to separate entries.)
        try {
            apiInstance.getReportResultDatas(reportId, itemIds);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReportResultDatas");
            e.printStackTrace();
        }
    }
}
String *reportId = reportId_example; // Report ID (500: Node Group, 501: WLAN Group, 502: Log Filter)
String *itemIds = itemIds_example; // ItemID (Use a comma to separate entries.) (optional)

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

// Retrieve a specific Report's data
[apiInstance getReportResultDatasWith:reportId
    itemIds:itemIds
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ReportsApi()

var reportId = reportId_example; // {String} Report ID (500: Node Group, 501: WLAN Group, 502: Log Filter)

var opts = { 
  'itemIds': itemIds_example // {String} ItemID (Use a comma to separate entries.)
};

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

namespace Example
{
    public class getReportResultDatasExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var reportId = reportId_example;  // String | Report ID (500: Node Group, 501: WLAN Group, 502: Log Filter)
            var itemIds = itemIds_example;  // String | ItemID (Use a comma to separate entries.) (optional) 

            try
            {
                // Retrieve a specific Report's data
                apiInstance.getReportResultDatas(reportId, itemIds);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getReportResultDatas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$reportId = reportId_example; // String | Report ID (500: Node Group, 501: WLAN Group, 502: Log Filter)
$itemIds = itemIds_example; // String | ItemID (Use a comma to separate entries.)

try {
    $api_instance->getReportResultDatas($reportId, $itemIds);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReportResultDatas: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $reportId = reportId_example; # String | Report ID (500: Node Group, 501: WLAN Group, 502: Log Filter)
my $itemIds = itemIds_example; # String | ItemID (Use a comma to separate entries.)

eval { 
    $api_instance->getReportResultDatas(reportId => $reportId, itemIds => $itemIds);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReportResultDatas: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
reportId = reportId_example # String | Report ID (500: Node Group, 501: WLAN Group, 502: Log Filter)
itemIds = itemIds_example # String | ItemID (Use a comma to separate entries.) (optional)

try: 
    # Retrieve a specific Report's data
    api_instance.get_report_result_datas(reportId, itemIds=itemIds)
except ApiException as e:
    print("Exception when calling ReportsApi->getReportResultDatas: %s\n" % e)

Parameters

Path parameters
Name Description
reportId*
String
<b>Report ID</b> (500: Node Group, 501: WLAN Group, 502: Log Filter)
Required
Query parameters
Name Description
itemIds
String
ItemID (Use a comma to separate entries.)

Responses

Status: 401 - Unauthorized

Status: 404 - Report Not Found


getReports

List Reports

Retrieves a list of the Reports.


/reports

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/reports?page=&pageSize=&sort=&qsearch=&reportId=&reportTitle=&onlyMyReport="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"}
        String qsearch = qsearch_example; // String | Search string
        String reportId = reportId_example; // String | Report ID
        String reportTitle = reportTitle_example; // String | Report Title
        Boolean onlyMyReport = true; // Boolean | Viewing my report(s)
        try {
            apiInstance.getReports(page, pageSize, sort, qsearch, reportId, reportTitle, onlyMyReport);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReports");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"}
        String qsearch = qsearch_example; // String | Search string
        String reportId = reportId_example; // String | Report ID
        String reportTitle = reportTitle_example; // String | Report Title
        Boolean onlyMyReport = true; // Boolean | Viewing my report(s)
        try {
            apiInstance.getReports(page, pageSize, sort, qsearch, reportId, reportTitle, onlyMyReport);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReports");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *sort = sort_example; // Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"} (optional)
String *qsearch = qsearch_example; // Search string (optional)
String *reportId = reportId_example; // Report ID (optional)
String *reportTitle = reportTitle_example; // Report Title (optional)
Boolean *onlyMyReport = true; // Viewing my report(s) (optional)

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

// List Reports
[apiInstance getReportsWith:page
    pageSize:pageSize
    sort:sort
    qsearch:qsearch
    reportId:reportId
    reportTitle:reportTitle
    onlyMyReport:onlyMyReport
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.ReportsApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var opts = { 
  'sort': sort_example, // {String} Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"}
  'qsearch': qsearch_example, // {String} Search string
  'reportId': reportId_example, // {String} Report ID
  'reportTitle': reportTitle_example, // {String} Report Title
  'onlyMyReport': true // {Boolean} Viewing my report(s)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getReports(page, pageSize, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReportsExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var sort = sort_example;  // String | Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"} (optional) 
            var qsearch = qsearch_example;  // String | Search string (optional) 
            var reportId = reportId_example;  // String | Report ID (optional) 
            var reportTitle = reportTitle_example;  // String | Report Title (optional) 
            var onlyMyReport = true;  // Boolean | Viewing my report(s) (optional) 

            try
            {
                // List Reports
                apiInstance.getReports(page, pageSize, sort, qsearch, reportId, reportTitle, onlyMyReport);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getReports: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"}
$qsearch = qsearch_example; // String | Search string
$reportId = reportId_example; // String | Report ID
$reportTitle = reportTitle_example; // String | Report Title
$onlyMyReport = true; // Boolean | Viewing my report(s)

try {
    $api_instance->getReports($page, $pageSize, $sort, $qsearch, $reportId, $reportTitle, $onlyMyReport);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReports: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"}
my $qsearch = qsearch_example; # String | Search string
my $reportId = reportId_example; # String | Report ID
my $reportTitle = reportTitle_example; # String | Report Title
my $onlyMyReport = true; # Boolean | Viewing my report(s)

eval { 
    $api_instance->getReports(page => $page, pageSize => $pageSize, sort => $sort, qsearch => $qsearch, reportId => $reportId, reportTitle => $reportTitle, onlyMyReport => $onlyMyReport);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReports: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
sort = sort_example # String | Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"} (optional)
qsearch = qsearch_example # String | Search string (optional)
reportId = reportId_example # String | Report ID (optional)
reportTitle = reportTitle_example # String | Report Title (optional)
onlyMyReport = true # Boolean | Viewing my report(s) (optional)

try: 
    # List Reports
    api_instance.get_reports(page, pageSize, sort=sort, qsearch=qsearch, reportId=reportId, reportTitle=reportTitle, onlyMyReport=onlyMyReport)
except ApiException as e:
    print("Exception when calling ReportsApi->getReports: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
sort
String
Sorting criteria in the JSON - {"field":"ReportId","dir":"desc"}
qsearch
String
Search string
reportId
String
Report ID
reportTitle
String
Report Title
onlyMyReport
Boolean
Viewing my report(s)

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


Sessions

changePassword

Reset password


/sessions/password

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/sessions/password?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.changePassword(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#changePassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.changePassword(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#changePassword");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; //  (optional)

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

// Reset password
[apiInstance changePasswordWith:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class changePasswordExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // Reset password
                apiInstance.changePassword(locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$locale = locale_example; // String | 

try {
    $api_instance->changePassword($locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->changePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $locale = locale_example; # String | 

eval { 
    $api_instance->changePassword(locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->changePassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
locale = locale_example # String |  (optional)

try: 
    # Reset password
    api_instance.change_password(locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->changePassword: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getAuthNumberForMobileOrEmail

Send authentication code


/sessions/authcode/{type}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/sessions/authcode/{type}?reload=&locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String type = type_example; // String | 
        String reload = reload_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.getAuthNumberForMobileOrEmail(type, reload, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getAuthNumberForMobileOrEmail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String type = type_example; // String | 
        String reload = reload_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.getAuthNumberForMobileOrEmail(type, reload, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getAuthNumberForMobileOrEmail");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // 
String *reload = reload_example; //  (optional)
String *locale = locale_example; //  (optional)

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

// Send authentication code 
[apiInstance getAuthNumberForMobileOrEmailWith:type
    reload:reload
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var type = type_example; // {String} 

var opts = { 
  'reload': reload_example, // {String} 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class getAuthNumberForMobileOrEmailExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var type = type_example;  // String | 
            var reload = reload_example;  // String |  (optional) 
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // Send authentication code 
                apiInstance.getAuthNumberForMobileOrEmail(type, reload, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.getAuthNumberForMobileOrEmail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$type = type_example; // String | 
$reload = reload_example; // String | 
$locale = locale_example; // String | 

try {
    $api_instance->getAuthNumberForMobileOrEmail($type, $reload, $locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->getAuthNumberForMobileOrEmail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $type = type_example; # String | 
my $reload = reload_example; # String | 
my $locale = locale_example; # String | 

eval { 
    $api_instance->getAuthNumberForMobileOrEmail(type => $type, reload => $reload, locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->getAuthNumberForMobileOrEmail: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
type = type_example # String | 
reload = reload_example # String |  (optional)
locale = locale_example # String |  (optional)

try: 
    # Send authentication code 
    api_instance.get_auth_number_for_mobile_or_email(type, reload=reload, locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->getAuthNumberForMobileOrEmail: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Required
Query parameters
Name Description
reload
String
locale
String

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized


getOtpAppQrUrl

Google OTP QR code


/sessions/otpapp/{mobileOsType}/{sendAppType}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/sessions/otpapp/{mobileOsType}/{sendAppType}?appURL=&locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String mobileOsType = mobileOsType_example; // String | 
        String sendAppType = sendAppType_example; // String | 
        String appURL = appURL_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.getOtpAppQrUrl(mobileOsType, sendAppType, appURL, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getOtpAppQrUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String mobileOsType = mobileOsType_example; // String | 
        String sendAppType = sendAppType_example; // String | 
        String appURL = appURL_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.getOtpAppQrUrl(mobileOsType, sendAppType, appURL, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getOtpAppQrUrl");
            e.printStackTrace();
        }
    }
}
String *mobileOsType = mobileOsType_example; // 
String *sendAppType = sendAppType_example; // 
String *appURL = appURL_example; //  (optional)
String *locale = locale_example; //  (optional)

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

// Google OTP QR code
[apiInstance getOtpAppQrUrlWith:mobileOsType
    sendAppType:sendAppType
    appURL:appURL
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var mobileOsType = mobileOsType_example; // {String} 

var sendAppType = sendAppType_example; // {String} 

var opts = { 
  'appURL': appURL_example, // {String} 
  'locale': locale_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getOtpAppQrUrl(mobileOsType, sendAppType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOtpAppQrUrlExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var mobileOsType = mobileOsType_example;  // String | 
            var sendAppType = sendAppType_example;  // String | 
            var appURL = appURL_example;  // String |  (optional) 
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // Google OTP QR code
                apiInstance.getOtpAppQrUrl(mobileOsType, sendAppType, appURL, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.getOtpAppQrUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$mobileOsType = mobileOsType_example; // String | 
$sendAppType = sendAppType_example; // String | 
$appURL = appURL_example; // String | 
$locale = locale_example; // String | 

try {
    $api_instance->getOtpAppQrUrl($mobileOsType, $sendAppType, $appURL, $locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->getOtpAppQrUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $mobileOsType = mobileOsType_example; # String | 
my $sendAppType = sendAppType_example; # String | 
my $appURL = appURL_example; # String | 
my $locale = locale_example; # String | 

eval { 
    $api_instance->getOtpAppQrUrl(mobileOsType => $mobileOsType, sendAppType => $sendAppType, appURL => $appURL, locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->getOtpAppQrUrl: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
mobileOsType = mobileOsType_example # String | 
sendAppType = sendAppType_example # String | 
appURL = appURL_example # String |  (optional)
locale = locale_example # String |  (optional)

try: 
    # Google OTP QR code
    api_instance.get_otp_app_qr_url(mobileOsType, sendAppType, appURL=appURL, locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->getOtpAppQrUrl: %s\n" % e)

Parameters

Path parameters
Name Description
mobileOsType*
String
Required
sendAppType*
String
Required
Query parameters
Name Description
appURL
String
locale
String

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getOtpAppSendAppType

Google OTP App download URL send type


/sessions/otpapp

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/sessions/otpapp?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.getOtpAppSendAppType(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getOtpAppSendAppType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.getOtpAppSendAppType(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getOtpAppSendAppType");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; //  (optional)

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

// Google OTP App download URL send type
[apiInstance getOtpAppSendAppTypeWith:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class getOtpAppSendAppTypeExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // Google OTP App download URL send type
                apiInstance.getOtpAppSendAppType(locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.getOtpAppSendAppType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$locale = locale_example; // String | 

try {
    $api_instance->getOtpAppSendAppType($locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->getOtpAppSendAppType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $locale = locale_example; # String | 

eval { 
    $api_instance->getOtpAppSendAppType(locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->getOtpAppSendAppType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
locale = locale_example # String |  (optional)

try: 
    # Google OTP App download URL send type
    api_instance.get_otp_app_send_app_type(locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->getOtpAppSendAppType: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getOtpQrUrl

QR code to generate an OTP secret key


/sessions/otp/{sendType}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/sessions/otp/{sendType}?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String sendType = sendType_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.getOtpQrUrl(sendType, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getOtpQrUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String sendType = sendType_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.getOtpQrUrl(sendType, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getOtpQrUrl");
            e.printStackTrace();
        }
    }
}
String *sendType = sendType_example; // 
String *locale = locale_example; //  (optional)

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

// QR code to generate an OTP secret key
[apiInstance getOtpQrUrlWith:sendType
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var sendType = sendType_example; // {String} 

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class getOtpQrUrlExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var sendType = sendType_example;  // String | 
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // QR code to generate an OTP secret key
                apiInstance.getOtpQrUrl(sendType, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.getOtpQrUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$sendType = sendType_example; // String | 
$locale = locale_example; // String | 

try {
    $api_instance->getOtpQrUrl($sendType, $locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->getOtpQrUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $sendType = sendType_example; # String | 
my $locale = locale_example; # String | 

eval { 
    $api_instance->getOtpQrUrl(sendType => $sendType, locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->getOtpQrUrl: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
sendType = sendType_example # String | 
locale = locale_example # String |  (optional)

try: 
    # QR code to generate an OTP secret key
    api_instance.get_otp_qr_url(sendType, locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->getOtpQrUrl: %s\n" % e)

Parameters

Path parameters
Name Description
sendType*
String
Required
Query parameters
Name Description
locale
String

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getOtpSecretKeySendAppType

OTP secret key send type


/sessions/otp

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/sessions/otp?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.getOtpSecretKeySendAppType(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getOtpSecretKeySendAppType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.getOtpSecretKeySendAppType(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getOtpSecretKeySendAppType");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; //  (optional)

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

// OTP secret key send type
[apiInstance getOtpSecretKeySendAppTypeWith:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class getOtpSecretKeySendAppTypeExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // OTP secret key send type
                apiInstance.getOtpSecretKeySendAppType(locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.getOtpSecretKeySendAppType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$locale = locale_example; // String | 

try {
    $api_instance->getOtpSecretKeySendAppType($locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->getOtpSecretKeySendAppType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $locale = locale_example; # String | 

eval { 
    $api_instance->getOtpSecretKeySendAppType(locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->getOtpSecretKeySendAppType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
locale = locale_example # String |  (optional)

try: 
    # OTP secret key send type
    api_instance.get_otp_secret_key_send_app_type(locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->getOtpSecretKeySendAppType: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getSecurityQuestionsAnswer

Answer UI for security question


/sessions/answer

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/sessions/answer?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.getSecurityQuestionsAnswer(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getSecurityQuestionsAnswer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.getSecurityQuestionsAnswer(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getSecurityQuestionsAnswer");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; //  (optional)

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

// Answer UI for security question
[apiInstance getSecurityQuestionsAnswerWith:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class getSecurityQuestionsAnswerExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // Answer UI for security question
                apiInstance.getSecurityQuestionsAnswer(locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.getSecurityQuestionsAnswer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$locale = locale_example; // String | 

try {
    $api_instance->getSecurityQuestionsAnswer($locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->getSecurityQuestionsAnswer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $locale = locale_example; # String | 

eval { 
    $api_instance->getSecurityQuestionsAnswer(locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->getSecurityQuestionsAnswer: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
locale = locale_example # String |  (optional)

try: 
    # Answer UI for security question
    api_instance.get_security_questions_answer(locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->getSecurityQuestionsAnswer: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized


getSession

Retrieve the current session information

Retrieves the information of the current session.


/sessions/current

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/sessions/current"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        try {
            apiInstance.getSession();
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        try {
            apiInstance.getSession();
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#getSession");
            e.printStackTrace();
        }
    }
}

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

// Retrieve the current session information
[apiInstance getSessionWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

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

namespace Example
{
    public class getSessionExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();

            try
            {
                // Retrieve the current session information
                apiInstance.getSession();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.getSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();

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

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

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

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

try: 
    # Retrieve the current session information
    api_instance.get_session()
except ApiException as e:
    print("Exception when calling SessionsApi->getSession: %s\n" % e)

Parameters

Responses

Status: 401 - Unauthorized


login

Add a new session by Login

Adds a new session by logging a user in.


/sessions

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/sessions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        Object body = ; // Object | JSON Authentication - {"adminid":"{adminid}","passwd":"{passwd}"}
        try {
            AuthBean result = apiInstance.login(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#login");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        Object body = ; // Object | JSON Authentication - {"adminid":"{adminid}","passwd":"{passwd}"}
        try {
            AuthBean result = apiInstance.login(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#login");
            e.printStackTrace();
        }
    }
}
Object *body = ; // JSON Authentication - {"adminid":"{adminid}","passwd":"{passwd}"}

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

// Add a new session by Login
[apiInstance loginWith:body
              completionHandler: ^(AuthBean output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var body = ; // {Object} JSON Authentication - {"adminid":"{adminid}","passwd":"{passwd}"}


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

namespace Example
{
    public class loginExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var body = new Object(); // Object | JSON Authentication - {"adminid":"{adminid}","passwd":"{passwd}"}

            try
            {
                // Add a new session by Login
                AuthBean result = apiInstance.login(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$body = ; // Object | JSON Authentication - {"adminid":"{adminid}","passwd":"{passwd}"}

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

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | JSON Authentication - {"adminid":"{adminid}","passwd":"{passwd}"}

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

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
body =  # Object | JSON Authentication - {"adminid":"{adminid}","passwd":"{passwd}"}

try: 
    # Add a new session by Login
    api_response = api_instance.login(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SessionsApi->login: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


logout

Delete the current session by Logout

Deletes the current session by loging a user out.


/sessions/current

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/sessions/current"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#logout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#logout");
            e.printStackTrace();
        }
    }
}

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

// Delete the current session by Logout
[apiInstance logoutWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

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

namespace Example
{
    public class logoutExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();

            try
            {
                // Delete the current session by Logout
                apiInstance.logout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();

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

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

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

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

try: 
    # Delete the current session by Logout
    api_instance.logout()
except ApiException as e:
    print("Exception when calling SessionsApi->logout: %s\n" % e)

Parameters

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


saveAnswer

Save answer for security question


/sessions/answer

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/sessions/answer?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.saveAnswer(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#saveAnswer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.saveAnswer(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#saveAnswer");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; //  (optional)

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

// Save answer for security question
[apiInstance saveAnswerWith:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class saveAnswerExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // Save answer for security question
                apiInstance.saveAnswer(locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.saveAnswer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$locale = locale_example; // String | 

try {
    $api_instance->saveAnswer($locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->saveAnswer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $locale = locale_example; # String | 

eval { 
    $api_instance->saveAnswer(locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->saveAnswer: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
locale = locale_example # String |  (optional)

try: 
    # Save answer for security question
    api_instance.save_answer(locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->saveAnswer: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


signin

Add a new session by Login

Adds a new session by logging a user in.


/sessions/signin

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/sessions/signin"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String body = body_example; // String | 
        try {
            AuthBean result = apiInstance.signin(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#signin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String body = body_example; // String | 
        try {
            AuthBean result = apiInstance.signin(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#signin");
            e.printStackTrace();
        }
    }
}
String *body = body_example; // 

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

// Add a new session by Login
[apiInstance signinWith:body
              completionHandler: ^(AuthBean output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var body = body_example; // {String} 


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

namespace Example
{
    public class signinExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var body = body_example;  // String | 

            try
            {
                // Add a new session by Login
                AuthBean result = apiInstance.signin(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.signin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$body = body_example; // String | 

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

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

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

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
body = body_example # String | 

try: 
    # Add a new session by Login
    api_response = api_instance.signin(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SessionsApi->signin: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


signinByOTP

OTP authentication


/sessions/otp

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/sessions/otp?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String body = body_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.signinByOTP(body, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#signinByOTP");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String body = body_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.signinByOTP(body, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#signinByOTP");
            e.printStackTrace();
        }
    }
}
String *body = body_example; // 
String *locale = locale_example; //  (optional)

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

// OTP authentication
[apiInstance signinByOTPWith:body
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var body = body_example; // {String} 

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class signinByOTPExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var body = body_example;  // String | 
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // OTP authentication
                apiInstance.signinByOTP(body, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.signinByOTP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$body = body_example; // String | 
$locale = locale_example; // String | 

try {
    $api_instance->signinByOTP($body, $locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->signinByOTP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | 
my $locale = locale_example; # String | 

eval { 
    $api_instance->signinByOTP(body => $body, locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->signinByOTP: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
body = body_example # String | 
locale = locale_example # String |  (optional)

try: 
    # OTP authentication
    api_instance.signin_by_otp(body, locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->signinByOTP: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
locale
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


signinBySMS

Authentication via SMS/Email


/sessions/authcode

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/sessions/authcode?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String body = body_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.signinBySMS(body, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#signinBySMS");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String body = body_example; // String | 
        String locale = locale_example; // String | 
        try {
            apiInstance.signinBySMS(body, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#signinBySMS");
            e.printStackTrace();
        }
    }
}
String *body = body_example; // 
String *locale = locale_example; //  (optional)

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

// Authentication via SMS/Email
[apiInstance signinBySMSWith:body
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var body = body_example; // {String} 

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class signinBySMSExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var body = body_example;  // String | 
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // Authentication via SMS/Email
                apiInstance.signinBySMS(body, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.signinBySMS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$body = body_example; // String | 
$locale = locale_example; // String | 

try {
    $api_instance->signinBySMS($body, $locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->signinBySMS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | 
my $locale = locale_example; # String | 

eval { 
    $api_instance->signinBySMS(body => $body, locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->signinBySMS: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
body = body_example # String | 
locale = locale_example # String |  (optional)

try: 
    # Authentication via SMS/Email
    api_instance.signin_by_sms(body, locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->signinBySMS: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
locale
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


updateAdminSecretKey

Save OTP secret key


/sessions/otp

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/sessions/otp?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.updateAdminSecretKey(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#updateAdminSecretKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.updateAdminSecretKey(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#updateAdminSecretKey");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; //  (optional)

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

// Save OTP secret key
[apiInstance updateAdminSecretKeyWith:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class updateAdminSecretKeyExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // Save OTP secret key
                apiInstance.updateAdminSecretKey(locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.updateAdminSecretKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$locale = locale_example; // String | 

try {
    $api_instance->updateAdminSecretKey($locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->updateAdminSecretKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $locale = locale_example; # String | 

eval { 
    $api_instance->updateAdminSecretKey(locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->updateAdminSecretKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
locale = locale_example # String |  (optional)

try: 
    # Save OTP secret key
    api_instance.update_admin_secret_key(locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->updateAdminSecretKey: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


updateAllowIp


/sessions/allowip

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/sessions/allowip?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

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

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.updateAllowIp(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#updateAllowIp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String locale = locale_example; // String | 
        try {
            apiInstance.updateAllowIp(locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#updateAllowIp");
            e.printStackTrace();
        }
    }
}
String *locale = locale_example; //  (optional)

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

// 
[apiInstance updateAllowIpWith:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SessionsApi()

var opts = { 
  'locale': locale_example // {String} 
};

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

namespace Example
{
    public class updateAllowIpExample
    {
        public void main()
        {
            
            var apiInstance = new SessionsApi();
            var locale = locale_example;  // String |  (optional) 

            try
            {
                // 
                apiInstance.updateAllowIp(locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.updateAllowIp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SessionsApi();
$locale = locale_example; // String | 

try {
    $api_instance->updateAllowIp($locale);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->updateAllowIp: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $locale = locale_example; # String | 

eval { 
    $api_instance->updateAllowIp(locale => $locale);
};
if ($@) {
    warn "Exception when calling SessionsApi->updateAllowIp: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
locale = locale_example # String |  (optional)

try: 
    # 
    api_instance.update_allow_ip(locale=locale)
except ApiException as e:
    print("Exception when calling SessionsApi->updateAllowIp: %s\n" % e)

Parameters

Query parameters
Name Description
locale
String

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


Switches

getSwitchPortBandWidthDatas

Retrieves a specific switch's link status (UP / DOWN)

Retrieves the link status (UP / DOWN) of the switch specified.


/switches/{switchId}/{port}/bandwidth

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/switches/{switchId}/{port}/bandwidth"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SwitchesApi;

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

public class SwitchesApiExample {

    public static void main(String[] args) {
        
        SwitchesApi apiInstance = new SwitchesApi();
        String switchId = switchId_example; // String | Switch ID
        String port = port_example; // String | Port
        try {
            apiInstance.getSwitchPortBandWidthDatas(switchId, port);
        } catch (ApiException e) {
            System.err.println("Exception when calling SwitchesApi#getSwitchPortBandWidthDatas");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SwitchesApi;

public class SwitchesApiExample {

    public static void main(String[] args) {
        SwitchesApi apiInstance = new SwitchesApi();
        String switchId = switchId_example; // String | Switch ID
        String port = port_example; // String | Port
        try {
            apiInstance.getSwitchPortBandWidthDatas(switchId, port);
        } catch (ApiException e) {
            System.err.println("Exception when calling SwitchesApi#getSwitchPortBandWidthDatas");
            e.printStackTrace();
        }
    }
}
String *switchId = switchId_example; // Switch ID
String *port = port_example; // Port

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

// Retrieves a specific switch's link status (UP / DOWN)
[apiInstance getSwitchPortBandWidthDatasWith:switchId
    port:port
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SwitchesApi()

var switchId = switchId_example; // {String} Switch ID

var port = port_example; // {String} Port


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

namespace Example
{
    public class getSwitchPortBandWidthDatasExample
    {
        public void main()
        {
            
            var apiInstance = new SwitchesApi();
            var switchId = switchId_example;  // String | Switch ID
            var port = port_example;  // String | Port

            try
            {
                // Retrieves a specific switch's link status (UP / DOWN)
                apiInstance.getSwitchPortBandWidthDatas(switchId, port);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SwitchesApi.getSwitchPortBandWidthDatas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SwitchesApi();
$switchId = switchId_example; // String | Switch ID
$port = port_example; // String | Port

try {
    $api_instance->getSwitchPortBandWidthDatas($switchId, $port);
} catch (Exception $e) {
    echo 'Exception when calling SwitchesApi->getSwitchPortBandWidthDatas: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SwitchesApi;

my $api_instance = WWW::SwaggerClient::SwitchesApi->new();
my $switchId = switchId_example; # String | Switch ID
my $port = port_example; # String | Port

eval { 
    $api_instance->getSwitchPortBandWidthDatas(switchId => $switchId, port => $port);
};
if ($@) {
    warn "Exception when calling SwitchesApi->getSwitchPortBandWidthDatas: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SwitchesApi()
switchId = switchId_example # String | Switch ID
port = port_example # String | Port

try: 
    # Retrieves a specific switch's link status (UP / DOWN)
    api_instance.get_switch_port_band_width_datas(switchId, port)
except ApiException as e:
    print("Exception when calling SwitchesApi->getSwitchPortBandWidthDatas: %s\n" % e)

Parameters

Path parameters
Name Description
switchId*
String
Switch ID
Required
port*
String
Port
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


Systems

commandToSystem

Run a specific System's Task

Runs the Task of the System(Sensor) specified.


/systems/{nodeId}/{cmd}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/systems/{nodeId}/{cmd}?value="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemsApi;

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

public class SystemsApiExample {

    public static void main(String[] args) {
        
        SystemsApi apiInstance = new SystemsApi();
        String nodeId = nodeId_example; // String | Sensor's Node ID
        String cmd = cmd_example; // String | Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes) 
        String value = value_example; // String | Command Value
        try {
            apiInstance.commandToSystem(nodeId, cmd, value);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#commandToSystem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemsApi;

public class SystemsApiExample {

    public static void main(String[] args) {
        SystemsApi apiInstance = new SystemsApi();
        String nodeId = nodeId_example; // String | Sensor's Node ID
        String cmd = cmd_example; // String | Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes) 
        String value = value_example; // String | Command Value
        try {
            apiInstance.commandToSystem(nodeId, cmd, value);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#commandToSystem");
            e.printStackTrace();
        }
    }
}
String *nodeId = nodeId_example; // Sensor's Node ID
String *cmd = cmd_example; // Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes) 
String *value = value_example; // Command Value

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

// Run a specific System's Task
[apiInstance commandToSystemWith:nodeId
    cmd:cmd
    value:value
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SystemsApi()

var nodeId = nodeId_example; // {String} Sensor's Node ID

var cmd = cmd_example; // {String} Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes) 

var value = value_example; // {String} Command Value


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.commandToSystem(nodeId, cmd, value, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class commandToSystemExample
    {
        public void main()
        {
            
            var apiInstance = new SystemsApi();
            var nodeId = nodeId_example;  // String | Sensor's Node ID
            var cmd = cmd_example;  // String | Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes) 
            var value = value_example;  // String | Command Value

            try
            {
                // Run a specific System's Task
                apiInstance.commandToSystem(nodeId, cmd, value);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemsApi.commandToSystem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SystemsApi();
$nodeId = nodeId_example; // String | Sensor's Node ID
$cmd = cmd_example; // String | Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes) 
$value = value_example; // String | Command Value

try {
    $api_instance->commandToSystem($nodeId, $cmd, $value);
} catch (Exception $e) {
    echo 'Exception when calling SystemsApi->commandToSystem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemsApi;

my $api_instance = WWW::SwaggerClient::SystemsApi->new();
my $nodeId = nodeId_example; # String | Sensor's Node ID
my $cmd = cmd_example; # String | Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes) 
my $value = value_example; # String | Command Value

eval { 
    $api_instance->commandToSystem(nodeId => $nodeId, cmd => $cmd, value => $value);
};
if ($@) {
    warn "Exception when calling SystemsApi->commandToSystem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemsApi()
nodeId = nodeId_example # String | Sensor's Node ID
cmd = cmd_example # String | Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes) 
value = value_example # String | Command Value

try: 
    # Run a specific System's Task
    api_instance.command_to_system(nodeId, cmd, value)
except ApiException as e:
    print("Exception when calling SystemsApi->commandToSystem: %s\n" % e)

Parameters

Path parameters
Name Description
nodeId*
String
Sensor's Node ID
Required
cmd*
String
Task (Action : Perform Action for Sensor, OperationMode: Edit All Sensors Operation Modes)
Required
Query parameters
Name Description
value*
String
Command Value
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Node Not Found

Status: 500 - Internal Server Error


createDeviceTagsOfSystem

Assign a tag

Assigns a tag to the System specified.


/systems/{devId}/tags

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/systems/{devId}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemsApi;

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

public class SystemsApiExample {

    public static void main(String[] args) {
        
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
        try {
            apiInstance.createDeviceTagsOfSystem(devId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#createDeviceTagsOfSystem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemsApi;

public class SystemsApiExample {

    public static void main(String[] args) {
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
        try {
            apiInstance.createDeviceTagsOfSystem(devId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#createDeviceTagsOfSystem");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Device ID
array[TagVo] *body = ; // Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

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

// Assign a tag
[apiInstance createDeviceTagsOfSystemWith:devId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SystemsApi()

var devId = devId_example; // {String} Device ID

var body = ; // {array[TagVo]} Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)


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

namespace Example
{
    public class createDeviceTagsOfSystemExample
    {
        public void main()
        {
            
            var apiInstance = new SystemsApi();
            var devId = devId_example;  // String | Device ID
            var body = new array[TagVo](); // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

            try
            {
                // Assign a tag
                apiInstance.createDeviceTagsOfSystem(devId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemsApi.createDeviceTagsOfSystem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SystemsApi();
$devId = devId_example; // String | Device ID
$body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

try {
    $api_instance->createDeviceTagsOfSystem($devId, $body);
} catch (Exception $e) {
    echo 'Exception when calling SystemsApi->createDeviceTagsOfSystem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemsApi;

my $api_instance = WWW::SwaggerClient::SystemsApi->new();
my $devId = devId_example; # String | Device ID
my $body = [WWW::SwaggerClient::Object::array[TagVo]->new()]; # array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

eval { 
    $api_instance->createDeviceTagsOfSystem(devId => $devId, body => $body);
};
if ($@) {
    warn "Exception when calling SystemsApi->createDeviceTagsOfSystem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemsApi()
devId = devId_example # String | Device ID
body =  # array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

try: 
    # Assign a tag
    api_instance.create_device_tags_of_system(devId, body)
except ApiException as e:
    print("Exception when calling SystemsApi->createDeviceTagsOfSystem: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Device ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteDeviceTagsOfSystem

Remove the tag(s)

Removes the tag(s) from the System specified.


/systems/{devId}/tags

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/systems/{devId}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemsApi;

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

public class SystemsApiExample {

    public static void main(String[] args) {
        
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        array[String] body = ; // array[String] | Tag List
        try {
            apiInstance.deleteDeviceTagsOfSystem(devId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#deleteDeviceTagsOfSystem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemsApi;

public class SystemsApiExample {

    public static void main(String[] args) {
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        array[String] body = ; // array[String] | Tag List
        try {
            apiInstance.deleteDeviceTagsOfSystem(devId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#deleteDeviceTagsOfSystem");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Device ID
array[String] *body = ; // Tag List

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

// Remove the tag(s)
[apiInstance deleteDeviceTagsOfSystemWith:devId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SystemsApi()

var devId = devId_example; // {String} Device ID

var body = ; // {array[String]} Tag List


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

namespace Example
{
    public class deleteDeviceTagsOfSystemExample
    {
        public void main()
        {
            
            var apiInstance = new SystemsApi();
            var devId = devId_example;  // String | Device ID
            var body = new array[String](); // array[String] | Tag List

            try
            {
                // Remove the tag(s)
                apiInstance.deleteDeviceTagsOfSystem(devId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemsApi.deleteDeviceTagsOfSystem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SystemsApi();
$devId = devId_example; // String | Device ID
$body = ; // array[String] | Tag List

try {
    $api_instance->deleteDeviceTagsOfSystem($devId, $body);
} catch (Exception $e) {
    echo 'Exception when calling SystemsApi->deleteDeviceTagsOfSystem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemsApi;

my $api_instance = WWW::SwaggerClient::SystemsApi->new();
my $devId = devId_example; # String | Device ID
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | Tag List

eval { 
    $api_instance->deleteDeviceTagsOfSystem(devId => $devId, body => $body);
};
if ($@) {
    warn "Exception when calling SystemsApi->deleteDeviceTagsOfSystem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemsApi()
devId = devId_example # String | Device ID
body =  # array[String] | Tag List

try: 
    # Remove the tag(s)
    api_instance.delete_device_tags_of_system(devId, body)
except ApiException as e:
    print("Exception when calling SystemsApi->deleteDeviceTagsOfSystem: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Device ID
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getDeviceTagsOfSystem

Retrieve a specific System's tag(s)

Retrieves the tag(s) assigned to the System specified.


/systems/{devId}/tags

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/systems/{devId}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemsApi;

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

public class SystemsApiExample {

    public static void main(String[] args) {
        
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        try {
            apiInstance.getDeviceTagsOfSystem(devId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#getDeviceTagsOfSystem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemsApi;

public class SystemsApiExample {

    public static void main(String[] args) {
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        try {
            apiInstance.getDeviceTagsOfSystem(devId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#getDeviceTagsOfSystem");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Device ID

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

// Retrieve a specific System's tag(s)
[apiInstance getDeviceTagsOfSystemWith:devId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SystemsApi()

var devId = devId_example; // {String} Device ID


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

namespace Example
{
    public class getDeviceTagsOfSystemExample
    {
        public void main()
        {
            
            var apiInstance = new SystemsApi();
            var devId = devId_example;  // String | Device ID

            try
            {
                // Retrieve a specific System's tag(s)
                apiInstance.getDeviceTagsOfSystem(devId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemsApi.getDeviceTagsOfSystem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SystemsApi();
$devId = devId_example; // String | Device ID

try {
    $api_instance->getDeviceTagsOfSystem($devId);
} catch (Exception $e) {
    echo 'Exception when calling SystemsApi->getDeviceTagsOfSystem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemsApi;

my $api_instance = WWW::SwaggerClient::SystemsApi->new();
my $devId = devId_example; # String | Device ID

eval { 
    $api_instance->getDeviceTagsOfSystem(devId => $devId);
};
if ($@) {
    warn "Exception when calling SystemsApi->getDeviceTagsOfSystem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemsApi()
devId = devId_example # String | Device ID

try: 
    # Retrieve a specific System's tag(s)
    api_instance.get_device_tags_of_system(devId)
except ApiException as e:
    print("Exception when calling SystemsApi->getDeviceTagsOfSystem: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Device ID
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Device ID Not Found


getSensorConfig

Sensor Settings

Gets the list of sensor settings.


/systems/sensor/conf/{devId}/{interface}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/systems/sensor/conf/{devId}/{interface}?key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemsApi;

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

public class SystemsApiExample {

    public static void main(String[] args) {
        
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Sensor's Device ID
        String interface = interface_example; // String | Interface
        String key = key_example; // String | key
        try {
            apiInstance.getSensorConfig(devId, interface, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#getSensorConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemsApi;

public class SystemsApiExample {

    public static void main(String[] args) {
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Sensor's Device ID
        String interface = interface_example; // String | Interface
        String key = key_example; // String | key
        try {
            apiInstance.getSensorConfig(devId, interface, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#getSensorConfig");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Sensor's Device ID
String *interface = interface_example; // Interface
String *key = key_example; // key (optional)

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

// Sensor Settings
[apiInstance getSensorConfigWith:devId
    interface:interface
    key:key
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SystemsApi()

var devId = devId_example; // {String} Sensor's Device ID

var interface = interface_example; // {String} Interface

var opts = { 
  'key': key_example // {String} key
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSensorConfig(devId, interface, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSensorConfigExample
    {
        public void main()
        {
            
            var apiInstance = new SystemsApi();
            var devId = devId_example;  // String | Sensor's Device ID
            var interface = interface_example;  // String | Interface
            var key = key_example;  // String | key (optional) 

            try
            {
                // Sensor Settings
                apiInstance.getSensorConfig(devId, interface, key);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemsApi.getSensorConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SystemsApi();
$devId = devId_example; // String | Sensor's Device ID
$interface = interface_example; // String | Interface
$key = key_example; // String | key

try {
    $api_instance->getSensorConfig($devId, $interface, $key);
} catch (Exception $e) {
    echo 'Exception when calling SystemsApi->getSensorConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemsApi;

my $api_instance = WWW::SwaggerClient::SystemsApi->new();
my $devId = devId_example; # String | Sensor's Device ID
my $interface = interface_example; # String | Interface
my $key = key_example; # String | key

eval { 
    $api_instance->getSensorConfig(devId => $devId, interface => $interface, key => $key);
};
if ($@) {
    warn "Exception when calling SystemsApi->getSensorConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemsApi()
devId = devId_example # String | Sensor's Device ID
interface = interface_example # String | Interface
key = key_example # String | key (optional)

try: 
    # Sensor Settings
    api_instance.get_sensor_config(devId, interface, key=key)
except ApiException as e:
    print("Exception when calling SystemsApi->getSensorConfig: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Sensor's Device ID
Required
interface*
String
Interface
Required
Query parameters
Name Description
key
String
key

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found Config

Status: 500 - Internal Server Error


getSystemCpuInfo

Retrieve a specific System's CPU information

Retrieves the CPU information of the System specified.


/systems/{devId}/cpu

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/systems/{devId}/cpu?timegap="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemsApi;

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

public class SystemsApiExample {

    public static void main(String[] args) {
        
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        Long timegap = 789; // Long | Time difference between data requests (Second(s))
        try {
            apiInstance.getSystemCpuInfo(devId, timegap);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#getSystemCpuInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemsApi;

public class SystemsApiExample {

    public static void main(String[] args) {
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        Long timegap = 789; // Long | Time difference between data requests (Second(s))
        try {
            apiInstance.getSystemCpuInfo(devId, timegap);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#getSystemCpuInfo");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Device ID
Long *timegap = 789; // Time difference between data requests (Second(s)) (optional) (default to 3600)

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

// Retrieve a specific System's CPU information
[apiInstance getSystemCpuInfoWith:devId
    timegap:timegap
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SystemsApi()

var devId = devId_example; // {String} Device ID

var opts = { 
  'timegap': 789 // {Long} Time difference between data requests (Second(s))
};

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

namespace Example
{
    public class getSystemCpuInfoExample
    {
        public void main()
        {
            
            var apiInstance = new SystemsApi();
            var devId = devId_example;  // String | Device ID
            var timegap = 789;  // Long | Time difference between data requests (Second(s)) (optional)  (default to 3600)

            try
            {
                // Retrieve a specific System's CPU information
                apiInstance.getSystemCpuInfo(devId, timegap);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemsApi.getSystemCpuInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SystemsApi();
$devId = devId_example; // String | Device ID
$timegap = 789; // Long | Time difference between data requests (Second(s))

try {
    $api_instance->getSystemCpuInfo($devId, $timegap);
} catch (Exception $e) {
    echo 'Exception when calling SystemsApi->getSystemCpuInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemsApi;

my $api_instance = WWW::SwaggerClient::SystemsApi->new();
my $devId = devId_example; # String | Device ID
my $timegap = 789; # Long | Time difference between data requests (Second(s))

eval { 
    $api_instance->getSystemCpuInfo(devId => $devId, timegap => $timegap);
};
if ($@) {
    warn "Exception when calling SystemsApi->getSystemCpuInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemsApi()
devId = devId_example # String | Device ID
timegap = 789 # Long | Time difference between data requests (Second(s)) (optional) (default to 3600)

try: 
    # Retrieve a specific System's CPU information
    api_instance.get_system_cpu_info(devId, timegap=timegap)
except ApiException as e:
    print("Exception when calling SystemsApi->getSystemCpuInfo: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Device ID
Required
Query parameters
Name Description
timegap
Long (int64)
Time difference between data requests (Second(s))

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getSystemMemInfo

Retrieve a specific System's memory information

Retrieves the memory information of the System specified.


/systems/{devId}/mem

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/systems/{devId}/mem?timegap="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemsApi;

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

public class SystemsApiExample {

    public static void main(String[] args) {
        
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        Long timegap = 789; // Long | Time difference between data requests(Second(s))
        try {
            apiInstance.getSystemMemInfo(devId, timegap);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#getSystemMemInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemsApi;

public class SystemsApiExample {

    public static void main(String[] args) {
        SystemsApi apiInstance = new SystemsApi();
        String devId = devId_example; // String | Device ID
        Long timegap = 789; // Long | Time difference between data requests(Second(s))
        try {
            apiInstance.getSystemMemInfo(devId, timegap);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemsApi#getSystemMemInfo");
            e.printStackTrace();
        }
    }
}
String *devId = devId_example; // Device ID
Long *timegap = 789; // Time difference between data requests(Second(s)) (optional) (default to 3600)

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

// Retrieve a specific System's memory information
[apiInstance getSystemMemInfoWith:devId
    timegap:timegap
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.SystemsApi()

var devId = devId_example; // {String} Device ID

var opts = { 
  'timegap': 789 // {Long} Time difference between data requests(Second(s))
};

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

namespace Example
{
    public class getSystemMemInfoExample
    {
        public void main()
        {
            
            var apiInstance = new SystemsApi();
            var devId = devId_example;  // String | Device ID
            var timegap = 789;  // Long | Time difference between data requests(Second(s)) (optional)  (default to 3600)

            try
            {
                // Retrieve a specific System's memory information
                apiInstance.getSystemMemInfo(devId, timegap);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemsApi.getSystemMemInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SystemsApi();
$devId = devId_example; // String | Device ID
$timegap = 789; // Long | Time difference between data requests(Second(s))

try {
    $api_instance->getSystemMemInfo($devId, $timegap);
} catch (Exception $e) {
    echo 'Exception when calling SystemsApi->getSystemMemInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemsApi;

my $api_instance = WWW::SwaggerClient::SystemsApi->new();
my $devId = devId_example; # String | Device ID
my $timegap = 789; # Long | Time difference between data requests(Second(s))

eval { 
    $api_instance->getSystemMemInfo(devId => $devId, timegap => $timegap);
};
if ($@) {
    warn "Exception when calling SystemsApi->getSystemMemInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemsApi()
devId = devId_example # String | Device ID
timegap = 789 # Long | Time difference between data requests(Second(s)) (optional) (default to 3600)

try: 
    # Retrieve a specific System's memory information
    api_instance.get_system_mem_info(devId, timegap=timegap)
except ApiException as e:
    print("Exception when calling SystemsApi->getSystemMemInfo: %s\n" % e)

Parameters

Path parameters
Name Description
devId*
String
Device ID
Required
Query parameters
Name Description
timegap
Long (int64)
Time difference between data requests(Second(s))

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


Tags

assignTags

Assign tags

Assigns tags to the one of the Object Types specified.


/tags/assignment

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/tags/assignment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        array[Tag for Bulk Operation] body = ; // array[Tag for Bulk Operation] | Tag Vo List
        try {
            apiInstance.assignTags(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#assignTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        array[Tag for Bulk Operation] body = ; // array[Tag for Bulk Operation] | Tag Vo List
        try {
            apiInstance.assignTags(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#assignTags");
            e.printStackTrace();
        }
    }
}
array[Tag for Bulk Operation] *body = ; // Tag Vo List

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

// Assign tags
[apiInstance assignTagsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.TagsApi()

var body = ; // {array[Tag for Bulk Operation]} Tag Vo List


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

namespace Example
{
    public class assignTagsExample
    {
        public void main()
        {
            
            var apiInstance = new TagsApi();
            var body = new array[Tag for Bulk Operation](); // array[Tag for Bulk Operation] | Tag Vo List

            try
            {
                // Assign tags
                apiInstance.assignTags(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.assignTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TagsApi();
$body = ; // array[Tag for Bulk Operation] | Tag Vo List

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

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $body = [WWW::SwaggerClient::Object::array[Tag for Bulk Operation]->new()]; # array[Tag for Bulk Operation] | Tag Vo List

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

# create an instance of the API class
api_instance = swagger_client.TagsApi()
body =  # array[Tag for Bulk Operation] | Tag Vo List

try: 
    # Assign tags
    api_instance.assign_tags(body)
except ApiException as e:
    print("Exception when calling TagsApi->assignTags: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


assignTags_1

Assign tags

Assigns tags to the one of the Object Types specified.


/tags/{type}/{value}

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/tags/{type}/{value}?comment="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        String type = type_example; // String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
        String value = value_example; // String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (expireDate Format: yyyy-MM-dd HH:mm)
If periodType is date, expireDate must have a value.
If periodType is period, expiryPeriod must have a value. String comment = comment_example; // String | Description (MAC Tag of IPAM) try { apiInstance.assignTags_0(type, value, body, comment); } catch (ApiException e) { System.err.println("Exception when calling TagsApi#assignTags_0"); e.printStackTrace(); } } }
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        String type = type_example; // String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
        String value = value_example; // String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (expireDate Format: yyyy-MM-dd HH:mm)
If periodType is date, expireDate must have a value.
If periodType is period, expiryPeriod must have a value. String comment = comment_example; // String | Description (MAC Tag of IPAM) try { apiInstance.assignTags_0(type, value, body, comment); } catch (ApiException e) { System.err.println("Exception when calling TagsApi#assignTags_0"); e.printStackTrace(); } } }
String *type = type_example; // Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
String *value = value_example; // Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
array[TagVo] *body = ; // Tag JSON Array (expireDate Format: yyyy-MM-dd HH:mm)
If periodType is date, expireDate must have a value.
If periodType is period, expiryPeriod must have a value. String *comment = comment_example; // Description (MAC Tag of IPAM) (optional) TagsApi *apiInstance = [[TagsApi alloc] init]; // Assign tags [apiInstance assignTags_1With:type value:value body:body comment:comment completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.TagsApi()

var type = type_example; // {String} Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)

var value = value_example; // {String} Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)

var body = ; // {array[TagVo]} Tag JSON Array (expireDate Format: yyyy-MM-dd HH:mm)
If periodType is date, expireDate must have a value.
If periodType is period, expiryPeriod must have a value. var opts = { 'comment': comment_example // {String} Description (MAC Tag of IPAM) }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.assignTags_0(type, value, body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assignTags_0Example
    {
        public void main()
        {
            
            var apiInstance = new TagsApi();
            var type = type_example;  // String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
            var value = value_example;  // String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
            var body = new array[TagVo](); // array[TagVo] | Tag JSON Array (expireDate Format: yyyy-MM-dd HH:mm)
If periodType is date, expireDate must have a value.
If periodType is period, expiryPeriod must have a value. var comment = comment_example; // String | Description (MAC Tag of IPAM) (optional) try { // Assign tags apiInstance.assignTags_0(type, value, body, comment); } catch (Exception e) { Debug.Print("Exception when calling TagsApi.assignTags_0: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TagsApi();
$type = type_example; // String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
$value = value_example; // String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
$body = ; // array[TagVo] | Tag JSON Array (expireDate Format: yyyy-MM-dd HH:mm)
If periodType is date, expireDate must have a value.
If periodType is period, expiryPeriod must have a value. $comment = comment_example; // String | Description (MAC Tag of IPAM) try { $api_instance->assignTags_0($type, $value, $body, $comment); } catch (Exception $e) { echo 'Exception when calling TagsApi->assignTags_0: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $type = type_example; # String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
my $value = value_example; # String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
my $body = [WWW::SwaggerClient::Object::array[TagVo]->new()]; # array[TagVo] | Tag JSON Array (expireDate Format: yyyy-MM-dd HH:mm)
If periodType is date, expireDate must have a value.
If periodType is period, expiryPeriod must have a value. my $comment = comment_example; # String | Description (MAC Tag of IPAM) eval { $api_instance->assignTags_0(type => $type, value => $value, body => $body, comment => $comment); }; if ($@) { warn "Exception when calling TagsApi->assignTags_0: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TagsApi()
type = type_example # String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
value = value_example # String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
body =  # array[TagVo] | Tag JSON Array (expireDate Format: yyyy-MM-dd HH:mm)
If periodType is date, expireDate must have a value.
If periodType is period, expiryPeriod must have a value. comment = comment_example # String | Description (MAC Tag of IPAM) (optional) try: # Assign tags api_instance.assign_tags_0(type, value, body, comment=comment) except ApiException as e: print("Exception when calling TagsApi->assignTags_0: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
Required
value*
String
Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
comment
String
Description (MAC Tag of IPAM)

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


createTag

Add a new tag

Adds a new tag.<br/><br/>Note: The value for • NP_IDX (Tag ID) will be automatically assigned.<br/>• np_periodtype Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry)<br/>• np_period Lifetime (D: day(s), h: hour(s), m: minute(s)) for np_periodtype is 1<br/>&nbsp;&nbsp; E.g., 2D, 48h, 3600m<br/>• np_periodexpire Lifetime + Expiry (D: day(s),0 - 23: Expiry) for np_periodtype is 2<br/>&nbsp;&nbsp; E.g., 2D,22<br/>• np_adminroles An Admin Role can be assigned to grant administrative privilege for Tag settings.<br/>&nbsp;&nbsp; E.g., audit, operator <br/>• np_color Color, e.g., 186AA7 )


/tags

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        NodePropertyVo body = ; // NodePropertyVo | Tag JSON
        try {
            apiInstance.createTag(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#createTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        NodePropertyVo body = ; // NodePropertyVo | Tag JSON
        try {
            apiInstance.createTag(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#createTag");
            e.printStackTrace();
        }
    }
}
NodePropertyVo *body = ; // Tag JSON

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

// Add a new tag
[apiInstance createTagWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.TagsApi()

var body = ; // {NodePropertyVo} Tag JSON


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

namespace Example
{
    public class createTagExample
    {
        public void main()
        {
            
            var apiInstance = new TagsApi();
            var body = new NodePropertyVo(); // NodePropertyVo | Tag JSON

            try
            {
                // Add a new tag
                apiInstance.createTag(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.createTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TagsApi();
$body = ; // NodePropertyVo | Tag JSON

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

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $body = WWW::SwaggerClient::Object::NodePropertyVo->new(); # NodePropertyVo | Tag JSON

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

# create an instance of the API class
api_instance = swagger_client.TagsApi()
body =  # NodePropertyVo | Tag JSON

try: 
    # Add a new tag
    api_instance.create_tag(body)
except ApiException as e:
    print("Exception when calling TagsApi->createTag: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteTags

Delete a specific tag

Deletes the tag specified.


/tags

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        array[String] body = ; // array[String] | Tag List
Format [tagId,tagId] try { apiInstance.deleteTags(body); } catch (ApiException e) { System.err.println("Exception when calling TagsApi#deleteTags"); e.printStackTrace(); } } }
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        array[String] body = ; // array[String] | Tag List
Format [tagId,tagId] try { apiInstance.deleteTags(body); } catch (ApiException e) { System.err.println("Exception when calling TagsApi#deleteTags"); e.printStackTrace(); } } }
array[String] *body = ; // Tag List
Format [tagId,tagId] TagsApi *apiInstance = [[TagsApi alloc] init]; // Delete a specific tag [apiInstance deleteTagsWith:body completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.TagsApi()

var body = ; // {array[String]} Tag List
Format [tagId,tagId] var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.deleteTags(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTagsExample
    {
        public void main()
        {
            
            var apiInstance = new TagsApi();
            var body = new array[String](); // array[String] | Tag List
Format [tagId,tagId] try { // Delete a specific tag apiInstance.deleteTags(body); } catch (Exception e) { Debug.Print("Exception when calling TagsApi.deleteTags: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TagsApi();
$body = ; // array[String] | Tag List
Format [tagId,tagId] try { $api_instance->deleteTags($body); } catch (Exception $e) { echo 'Exception when calling TagsApi->deleteTags: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | Tag List
Format [tagId,tagId] eval { $api_instance->deleteTags(body => $body); }; if ($@) { warn "Exception when calling TagsApi->deleteTags: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TagsApi()
body =  # array[String] | Tag List
Format [tagId,tagId] try: # Delete a specific tag api_instance.delete_tags(body) except ApiException as e: print("Exception when calling TagsApi->deleteTags: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteTagsByType

Remove the tag(s)

Removes the tag(s) from the one of the Object Types specified.


/tags/{type}/{value}

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/tags/{type}/{value}?comment="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        String type = type_example; // String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
        String value = value_example; // String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
        array[TagVo] body = ; // array[TagVo] | Tag JSON List
        String comment = comment_example; // String | Description (MAC Tag of IPAM)
        try {
            apiInstance.deleteTagsByType(type, value, body, comment);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteTagsByType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        String type = type_example; // String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
        String value = value_example; // String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
        array[TagVo] body = ; // array[TagVo] | Tag JSON List
        String comment = comment_example; // String | Description (MAC Tag of IPAM)
        try {
            apiInstance.deleteTagsByType(type, value, body, comment);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#deleteTagsByType");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
String *value = value_example; // Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
array[TagVo] *body = ; // Tag JSON List
String *comment = comment_example; // Description (MAC Tag of IPAM) (optional)

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

// Remove the tag(s)
[apiInstance deleteTagsByTypeWith:type
    value:value
    body:body
    comment:comment
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.TagsApi()

var type = type_example; // {String} Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)

var value = value_example; // {String} Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)

var body = ; // {array[TagVo]} Tag JSON List

var opts = { 
  'comment': comment_example // {String} Description (MAC Tag of IPAM)
};

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

namespace Example
{
    public class deleteTagsByTypeExample
    {
        public void main()
        {
            
            var apiInstance = new TagsApi();
            var type = type_example;  // String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
            var value = value_example;  // String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
            var body = new array[TagVo](); // array[TagVo] | Tag JSON List
            var comment = comment_example;  // String | Description (MAC Tag of IPAM) (optional) 

            try
            {
                // Remove the tag(s)
                apiInstance.deleteTagsByType(type, value, body, comment);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.deleteTagsByType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TagsApi();
$type = type_example; // String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
$value = value_example; // String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
$body = ; // array[TagVo] | Tag JSON List
$comment = comment_example; // String | Description (MAC Tag of IPAM)

try {
    $api_instance->deleteTagsByType($type, $value, $body, $comment);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->deleteTagsByType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $type = type_example; # String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
my $value = value_example; # String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
my $body = [WWW::SwaggerClient::Object::array[TagVo]->new()]; # array[TagVo] | Tag JSON List
my $comment = comment_example; # String | Description (MAC Tag of IPAM)

eval { 
    $api_instance->deleteTagsByType(type => $type, value => $value, body => $body, comment => $comment);
};
if ($@) {
    warn "Exception when calling TagsApi->deleteTagsByType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TagsApi()
type = type_example # String | Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
value = value_example # String | Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
body =  # array[TagVo] | Tag JSON List
comment = comment_example # String | Description (MAC Tag of IPAM) (optional)

try: 
    # Remove the tag(s)
    api_instance.delete_tags_by_type(type, value, body, comment=comment)
except ApiException as e:
    print("Exception when calling TagsApi->deleteTagsByType: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Object Type (node: Node, mac: MAC, ip: Node's IP, user: User, device: Device, ap: WLAN)
Required
value*
String
Object ID (Node ID, MAC, Node's IP, USER_ID, Device ID, AP's MAC)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
comment
String
Description (MAC Tag of IPAM)

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getTag

Retrieve a specific tag's information

Retrieves the information of the tag specified.


/tags/{tagId}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/tags/{tagId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        Integer tagId = 56; // Integer | Tag ID (NP_IDX)
        try {
            apiInstance.getTag(tagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#getTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer tagId = 56; // Integer | Tag ID (NP_IDX)
        try {
            apiInstance.getTag(tagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#getTag");
            e.printStackTrace();
        }
    }
}
Integer *tagId = 56; // Tag ID (NP_IDX)

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

// Retrieve a specific tag's information
[apiInstance getTagWith:tagId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.TagsApi()

var tagId = 56; // {Integer} Tag ID (NP_IDX)


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

namespace Example
{
    public class getTagExample
    {
        public void main()
        {
            
            var apiInstance = new TagsApi();
            var tagId = 56;  // Integer | Tag ID (NP_IDX)

            try
            {
                // Retrieve a specific tag's information
                apiInstance.getTag(tagId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.getTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TagsApi();
$tagId = 56; // Integer | Tag ID (NP_IDX)

try {
    $api_instance->getTag($tagId);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->getTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $tagId = 56; # Integer | Tag ID (NP_IDX)

eval { 
    $api_instance->getTag(tagId => $tagId);
};
if ($@) {
    warn "Exception when calling TagsApi->getTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TagsApi()
tagId = 56 # Integer | Tag ID (NP_IDX)

try: 
    # Retrieve a specific tag's information
    api_instance.get_tag(tagId)
except ApiException as e:
    print("Exception when calling TagsApi->getTag: %s\n" % e)

Parameters

Path parameters
Name Description
tagId*
Integer (int32)
Tag ID (NP_IDX)
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


getTags

List tags

Retrieves a list of the tags.


/tags

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/tags?page=&pageSize=&sort=&npName=&npDesc=&npPeriodType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
 E.g., {"field": "NP_NAME", "dir":"desc"} String npName = npName_example; // String | Name String npDesc = npDesc_example; // String | Description Integer npPeriodType = 56; // Integer | Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry) try { apiInstance.getTags(page, pageSize, sort, npName, npDesc, npPeriodType); } catch (ApiException e) { System.err.println("Exception when calling TagsApi#getTags"); e.printStackTrace(); } } }
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
 E.g., {"field": "NP_NAME", "dir":"desc"} String npName = npName_example; // String | Name String npDesc = npDesc_example; // String | Description Integer npPeriodType = 56; // Integer | Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry) try { apiInstance.getTags(page, pageSize, sort, npName, npDesc, npPeriodType); } catch (ApiException e) { System.err.println("Exception when calling TagsApi#getTags"); e.printStackTrace(); } } }
Integer *page = 56; // Results page to be retrieved (optional)
Integer *pageSize = 56; // Number of records per page (optional)
String *sort = sort_example; // Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
 E.g., {"field": "NP_NAME", "dir":"desc"} (optional) String *npName = npName_example; // Name (optional) String *npDesc = npDesc_example; // Description (optional) Integer *npPeriodType = 56; // Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry) (optional) TagsApi *apiInstance = [[TagsApi alloc] init]; // List tags [apiInstance getTagsWith:page pageSize:pageSize sort:sort npName:npName npDesc:npDesc npPeriodType:npPeriodType completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.TagsApi()

var opts = { 
  'page': 56, // {Integer} Results page to be retrieved
  'pageSize': 56, // {Integer} Number of records per page
  'sort': sort_example, // {String} Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
 E.g., {"field": "NP_NAME", "dir":"desc"} 'npName': npName_example, // {String} Name 'npDesc': npDesc_example, // {String} Description 'npPeriodType': 56 // {Integer} Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry) }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.getTags(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTagsExample
    {
        public void main()
        {
            
            var apiInstance = new TagsApi();
            var page = 56;  // Integer | Results page to be retrieved (optional) 
            var pageSize = 56;  // Integer | Number of records per page (optional) 
            var sort = sort_example;  // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
 E.g., {"field": "NP_NAME", "dir":"desc"} (optional) var npName = npName_example; // String | Name (optional) var npDesc = npDesc_example; // String | Description (optional) var npPeriodType = 56; // Integer | Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry) (optional) try { // List tags apiInstance.getTags(page, pageSize, sort, npName, npDesc, npPeriodType); } catch (Exception e) { Debug.Print("Exception when calling TagsApi.getTags: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TagsApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$sort = sort_example; // String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
 E.g., {"field": "NP_NAME", "dir":"desc"} $npName = npName_example; // String | Name $npDesc = npDesc_example; // String | Description $npPeriodType = 56; // Integer | Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry) try { $api_instance->getTags($page, $pageSize, $sort, $npName, $npDesc, $npPeriodType); } catch (Exception $e) { echo 'Exception when calling TagsApi->getTags: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $sort = sort_example; # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
 E.g., {"field": "NP_NAME", "dir":"desc"} my $npName = npName_example; # String | Name my $npDesc = npDesc_example; # String | Description my $npPeriodType = 56; # Integer | Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry) eval { $api_instance->getTags(page => $page, pageSize => $pageSize, sort => $sort, npName => $npName, npDesc => $npDesc, npPeriodType => $npPeriodType); }; if ($@) { warn "Exception when calling TagsApi->getTags: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TagsApi()
page = 56 # Integer | Results page to be retrieved (optional)
pageSize = 56 # Integer | Number of records per page (optional)
sort = sort_example # String | Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})
 E.g., {"field": "NP_NAME", "dir":"desc"} (optional) npName = npName_example # String | Name (optional) npDesc = npDesc_example # String | Description (optional) npPeriodType = 56 # Integer | Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry) (optional) try: # List tags api_instance.get_tags(page=page, pageSize=pageSize, sort=sort, npName=npName, npDesc=npDesc, npPeriodType=npPeriodType) except ApiException as e: print("Exception when calling TagsApi->getTags: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer (int32)
Results page to be retrieved
pageSize
Integer (int32)
Number of records per page
sort
String
Sorting criteria in the JSON ({"field": "ColumnName", "dir": "Direction"})<br/>&nbsp;E.g., {"field": "NP_NAME", "dir":"desc"}
npName
String
Name
npDesc
String
Description
npPeriodType
Integer (int32)
Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry)

Responses

Status: 401 - Unauthorized

Status: 404 - Not Found


updateTag

Update an existing tag

Updates an existing tag.<br/><br/>The value entered as a parameter will be used for the value for • NP_IDX (Tag ID).<br/>• np_periodtype Schedule (0: No Expiry, 1: Lifetime, 2: Lifetime + Expiry)<br/>• np_period Lifetime (D: day(s), h: hour(s), m: minute(s)) for np_periodtype is 1<br/>&nbsp;&nbsp; E.g., 2D, 48h, 3600m<br/>• np_periodexpire Lifetime + Expiry (D: day(s),0 - 23: Expiry) for np_periodtype is 2<br/>&nbsp;&nbsp; E.g., 2D,22<br/>• np_adminroles An Admin Role can be assigned to grant administrative privilege for Tag settings.<br/>&nbsp;&nbsp; E.g., audit, operator <br/>• np_color Color, e.g., 186AA7 )


/tags/{tagId}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/tags/{tagId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TagsApi;

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

public class TagsApiExample {

    public static void main(String[] args) {
        
        TagsApi apiInstance = new TagsApi();
        Integer tagId = 56; // Integer | Tag ID (NP_IDX)
        NodePropertyVo body = ; // NodePropertyVo | Tag JSON Data
        try {
            apiInstance.updateTag(tagId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#updateTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TagsApi;

public class TagsApiExample {

    public static void main(String[] args) {
        TagsApi apiInstance = new TagsApi();
        Integer tagId = 56; // Integer | Tag ID (NP_IDX)
        NodePropertyVo body = ; // NodePropertyVo | Tag JSON Data
        try {
            apiInstance.updateTag(tagId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TagsApi#updateTag");
            e.printStackTrace();
        }
    }
}
Integer *tagId = 56; // Tag ID (NP_IDX)
NodePropertyVo *body = ; // Tag JSON Data

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

// Update an existing tag
[apiInstance updateTagWith:tagId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.TagsApi()

var tagId = 56; // {Integer} Tag ID (NP_IDX)

var body = ; // {NodePropertyVo} Tag JSON Data


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

namespace Example
{
    public class updateTagExample
    {
        public void main()
        {
            
            var apiInstance = new TagsApi();
            var tagId = 56;  // Integer | Tag ID (NP_IDX)
            var body = new NodePropertyVo(); // NodePropertyVo | Tag JSON Data

            try
            {
                // Update an existing tag
                apiInstance.updateTag(tagId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TagsApi.updateTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TagsApi();
$tagId = 56; // Integer | Tag ID (NP_IDX)
$body = ; // NodePropertyVo | Tag JSON Data

try {
    $api_instance->updateTag($tagId, $body);
} catch (Exception $e) {
    echo 'Exception when calling TagsApi->updateTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TagsApi;

my $api_instance = WWW::SwaggerClient::TagsApi->new();
my $tagId = 56; # Integer | Tag ID (NP_IDX)
my $body = WWW::SwaggerClient::Object::NodePropertyVo->new(); # NodePropertyVo | Tag JSON Data

eval { 
    $api_instance->updateTag(tagId => $tagId, body => $body);
};
if ($@) {
    warn "Exception when calling TagsApi->updateTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TagsApi()
tagId = 56 # Integer | Tag ID (NP_IDX)
body =  # NodePropertyVo | Tag JSON Data

try: 
    # Update an existing tag
    api_instance.update_tag(tagId, body)
except ApiException as e:
    print("Exception when calling TagsApi->updateTag: %s\n" % e)

Parameters

Path parameters
Name Description
tagId*
Integer (int32)
Tag ID (NP_IDX)
Required
Body parameters
Name Description
body *

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


Users

changeMyPassword

Edit my password

Modify the password of the currently connected user.


/users/myinfo/password

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/users/myinfo/password?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String password = password_example; // String | New password
        String locale = locale_example; // String | Locale
        try {
            apiInstance.changeMyPassword(password, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#changeMyPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String password = password_example; // String | New password
        String locale = locale_example; // String | Locale
        try {
            apiInstance.changeMyPassword(password, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#changeMyPassword");
            e.printStackTrace();
        }
    }
}
String *password = password_example; // New password
String *locale = locale_example; // Locale (optional)

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

// Edit my password
[apiInstance changeMyPasswordWith:password
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var password = password_example; // {String} New password

var opts = { 
  'locale': locale_example // {String} Locale
};

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

namespace Example
{
    public class changeMyPasswordExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var password = password_example;  // String | New password
            var locale = locale_example;  // String | Locale (optional) 

            try
            {
                // Edit my password
                apiInstance.changeMyPassword(password, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.changeMyPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$password = password_example; // String | New password
$locale = locale_example; // String | Locale

try {
    $api_instance->changeMyPassword($password, $locale);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->changeMyPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $password = password_example; # String | New password
my $locale = locale_example; # String | Locale

eval { 
    $api_instance->changeMyPassword(password => $password, locale => $locale);
};
if ($@) {
    warn "Exception when calling UsersApi->changeMyPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
password = password_example # String | New password
locale = locale_example # String | Locale (optional)

try: 
    # Edit my password
    api_instance.change_my_password(password, locale=locale)
except ApiException as e:
    print("Exception when calling UsersApi->changeMyPassword: %s\n" % e)

Parameters

Form parameters
Name Description
password*
String
New password
Required
Query parameters
Name Description
locale
String
Locale

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


changePassword

Reset a specific user's password

Resets the password of the user specified.


/users/{userId}/password

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/users/{userId}/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        String password = password_example; // String | New password
        Boolean isEncrytion = true; // Boolean | Password encryption
        try {
            apiInstance.changePassword(userId, password, isEncrytion);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#changePassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        String password = password_example; // String | New password
        Boolean isEncrytion = true; // Boolean | Password encryption
        try {
            apiInstance.changePassword(userId, password, isEncrytion);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#changePassword");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username (USER_ID)
String *password = password_example; // New password
Boolean *isEncrytion = true; // Password encryption (optional)

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

// Reset a specific user's password
[apiInstance changePasswordWith:userId
    password:password
    isEncrytion:isEncrytion
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username (USER_ID)

var password = password_example; // {String} New password

var opts = { 
  'isEncrytion': true // {Boolean} Password encryption
};

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

namespace Example
{
    public class changePasswordExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username (USER_ID)
            var password = password_example;  // String | New password
            var isEncrytion = true;  // Boolean | Password encryption (optional) 

            try
            {
                // Reset a specific user's password
                apiInstance.changePassword(userId, password, isEncrytion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username (USER_ID)
$password = password_example; // String | New password
$isEncrytion = true; // Boolean | Password encryption

try {
    $api_instance->changePassword($userId, $password, $isEncrytion);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->changePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username (USER_ID)
my $password = password_example; # String | New password
my $isEncrytion = true; # Boolean | Password encryption

eval { 
    $api_instance->changePassword(userId => $userId, password => $password, isEncrytion => $isEncrytion);
};
if ($@) {
    warn "Exception when calling UsersApi->changePassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username (USER_ID)
password = password_example # String | New password
isEncrytion = true # Boolean | Password encryption (optional)

try: 
    # Reset a specific user's password
    api_instance.change_password(userId, password, isEncrytion=isEncrytion)
except ApiException as e:
    print("Exception when calling UsersApi->changePassword: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username (USER_ID)
Required
Form parameters
Name Description
password*
String
New password
Required
isEncrytion
Boolean
Password encryption

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


checkAuthCode

Retrieve a specific user's authentication code

Retrieves the authentication code generated to the user specified.


/users/{userId}/authcode

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/users/{userId}/authcode?purpose=&authcode=&idType=&locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        String purpose = purpose_example; // String | Scope (password)
        String authcode = authcode_example; // String | Authentication Code
        String idType = idType_example; // String | Id Type (1:ADMIN, 2:User)
        String locale = locale_example; // String | Locale
        try {
            Message Value Object result = apiInstance.checkAuthCode(userId, purpose, authcode, idType, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#checkAuthCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        String purpose = purpose_example; // String | Scope (password)
        String authcode = authcode_example; // String | Authentication Code
        String idType = idType_example; // String | Id Type (1:ADMIN, 2:User)
        String locale = locale_example; // String | Locale
        try {
            Message Value Object result = apiInstance.checkAuthCode(userId, purpose, authcode, idType, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#checkAuthCode");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username (USER_ID)
String *purpose = purpose_example; // Scope (password) (default to password)
String *authcode = authcode_example; // Authentication Code
String *idType = idType_example; // Id Type (1:ADMIN, 2:User) (default to 2)
String *locale = locale_example; // Locale (optional)

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

// Retrieve a specific user's authentication code
[apiInstance checkAuthCodeWith:userId
    purpose:purpose
    authcode:authcode
    idType:idType
    locale:locale
              completionHandler: ^(Message Value Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username (USER_ID)

var purpose = purpose_example; // {String} Scope (password)

var authcode = authcode_example; // {String} Authentication Code

var idType = idType_example; // {String} Id Type (1:ADMIN, 2:User)

var opts = { 
  'locale': locale_example // {String} Locale
};

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

namespace Example
{
    public class checkAuthCodeExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username (USER_ID)
            var purpose = purpose_example;  // String | Scope (password) (default to password)
            var authcode = authcode_example;  // String | Authentication Code
            var idType = idType_example;  // String | Id Type (1:ADMIN, 2:User) (default to 2)
            var locale = locale_example;  // String | Locale (optional) 

            try
            {
                // Retrieve a specific user's authentication code
                Message Value Object result = apiInstance.checkAuthCode(userId, purpose, authcode, idType, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.checkAuthCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username (USER_ID)
$purpose = purpose_example; // String | Scope (password)
$authcode = authcode_example; // String | Authentication Code
$idType = idType_example; // String | Id Type (1:ADMIN, 2:User)
$locale = locale_example; // String | Locale

try {
    $result = $api_instance->checkAuthCode($userId, $purpose, $authcode, $idType, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->checkAuthCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username (USER_ID)
my $purpose = purpose_example; # String | Scope (password)
my $authcode = authcode_example; # String | Authentication Code
my $idType = idType_example; # String | Id Type (1:ADMIN, 2:User)
my $locale = locale_example; # String | Locale

eval { 
    my $result = $api_instance->checkAuthCode(userId => $userId, purpose => $purpose, authcode => $authcode, idType => $idType, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->checkAuthCode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username (USER_ID)
purpose = purpose_example # String | Scope (password) (default to password)
authcode = authcode_example # String | Authentication Code
idType = idType_example # String | Id Type (1:ADMIN, 2:User) (default to 2)
locale = locale_example # String | Locale (optional)

try: 
    # Retrieve a specific user's authentication code
    api_response = api_instance.check_auth_code(userId, purpose, authcode, idType, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->checkAuthCode: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username (USER_ID)
Required
Query parameters
Name Description
purpose*
String
Scope (password)
Required
authcode*
String
Authentication Code
Required
idType*
String
Id Type (1:ADMIN, 2:User)
Required
locale
String
Locale

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 416 - Range Not Satisfiable

Status: 500 - Internal Server Error


createAuthCode

Generate an authentication code

Generates an authentication code for the user specified.


/users/{userId}/authcode

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/users/{userId}/authcode?idType=&locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        String purpose = purpose_example; // String | Scope (password)
        String method = method_example; // String | Verification Methods
        String value = value_example; // String | Mobile phone / Email
        String idType = idType_example; // String | Id Type (1:ADMIN, 2:User)
        String locale = locale_example; // String | Locale
        try {
            Message Value Object result = apiInstance.createAuthCode(userId, purpose, method, value, idType, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createAuthCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        String purpose = purpose_example; // String | Scope (password)
        String method = method_example; // String | Verification Methods
        String value = value_example; // String | Mobile phone / Email
        String idType = idType_example; // String | Id Type (1:ADMIN, 2:User)
        String locale = locale_example; // String | Locale
        try {
            Message Value Object result = apiInstance.createAuthCode(userId, purpose, method, value, idType, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createAuthCode");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username (USER_ID)
String *purpose = purpose_example; // Scope (password)
String *method = method_example; // Verification Methods
String *value = value_example; // Mobile phone / Email
String *idType = idType_example; // Id Type (1:ADMIN, 2:User) (default to 2)
String *locale = locale_example; // Locale (optional)

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

// Generate an authentication code
[apiInstance createAuthCodeWith:userId
    purpose:purpose
    method:method
    value:value
    idType:idType
    locale:locale
              completionHandler: ^(Message Value Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username (USER_ID)

var purpose = purpose_example; // {String} Scope (password)

var method = method_example; // {String} Verification Methods

var value = value_example; // {String} Mobile phone / Email

var idType = idType_example; // {String} Id Type (1:ADMIN, 2:User)

var opts = { 
  'locale': locale_example // {String} Locale
};

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

namespace Example
{
    public class createAuthCodeExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username (USER_ID)
            var purpose = purpose_example;  // String | Scope (password)
            var method = method_example;  // String | Verification Methods
            var value = value_example;  // String | Mobile phone / Email
            var idType = idType_example;  // String | Id Type (1:ADMIN, 2:User) (default to 2)
            var locale = locale_example;  // String | Locale (optional) 

            try
            {
                // Generate an authentication code
                Message Value Object result = apiInstance.createAuthCode(userId, purpose, method, value, idType, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createAuthCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username (USER_ID)
$purpose = purpose_example; // String | Scope (password)
$method = method_example; // String | Verification Methods
$value = value_example; // String | Mobile phone / Email
$idType = idType_example; // String | Id Type (1:ADMIN, 2:User)
$locale = locale_example; // String | Locale

try {
    $result = $api_instance->createAuthCode($userId, $purpose, $method, $value, $idType, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->createAuthCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username (USER_ID)
my $purpose = purpose_example; # String | Scope (password)
my $method = method_example; # String | Verification Methods
my $value = value_example; # String | Mobile phone / Email
my $idType = idType_example; # String | Id Type (1:ADMIN, 2:User)
my $locale = locale_example; # String | Locale

eval { 
    my $result = $api_instance->createAuthCode(userId => $userId, purpose => $purpose, method => $method, value => $value, idType => $idType, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->createAuthCode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username (USER_ID)
purpose = purpose_example # String | Scope (password)
method = method_example # String | Verification Methods
value = value_example # String | Mobile phone / Email
idType = idType_example # String | Id Type (1:ADMIN, 2:User) (default to 2)
locale = locale_example # String | Locale (optional)

try: 
    # Generate an authentication code
    api_response = api_instance.create_auth_code(userId, purpose, method, value, idType, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->createAuthCode: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username (USER_ID)
Required
Form parameters
Name Description
purpose*
String
Scope (password)
Enum: password
Required
method*
String
Verification Methods
Enum: password sms, email
Required
value*
String
Mobile phone / Email
Required
Query parameters
Name Description
idType*
String
Id Type (1:ADMIN, 2:User)
Required
locale
String
Locale

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 416 - Range Not Satisfiable

Status: 500 - Internal Server Error


createOTPTokens

Generate an OTP

Generates an one-time password for the user specified.


/users/{userId}/otptokens

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/users/{userId}/otptokens"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        try {
            apiInstance.createOTPTokens(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createOTPTokens");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        try {
            apiInstance.createOTPTokens(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createOTPTokens");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username (USER_ID)

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

// Generate an OTP 
[apiInstance createOTPTokensWith:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username (USER_ID)


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

namespace Example
{
    public class createOTPTokensExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username (USER_ID)

            try
            {
                // Generate an OTP 
                apiInstance.createOTPTokens(userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createOTPTokens: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username (USER_ID)

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username (USER_ID)

eval { 
    $api_instance->createOTPTokens(userId => $userId);
};
if ($@) {
    warn "Exception when calling UsersApi->createOTPTokens: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username (USER_ID)

try: 
    # Generate an OTP 
    api_instance.create_otp_tokens(userId)
except ApiException as e:
    print("Exception when calling UsersApi->createOTPTokens: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username (USER_ID)
Required

Responses

Status: 401 - Unauthorized

Status: 403 - Forbidden


createUserTags

Assign a tag

Assigns a tag to the user specified.


/users/{userId}/tags

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/users/{userId}/tags?applyAgent="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
        Integer applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)
        try {
            apiInstance.createUserTags(userId, body, applyAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUserTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username
        array[TagVo] body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
        Integer applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)
        try {
            apiInstance.createUserTags(userId, body, applyAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUserTags");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username
array[TagVo] *body = ; // Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
Integer *applyAgent = 56; // Apply the policy to the agent.(0: false, 1: true) (optional)

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

// Assign a tag
[apiInstance createUserTagsWith:userId
    body:body
    applyAgent:applyAgent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username

var body = ; // {array[TagVo]} Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)

var opts = { 
  'applyAgent': 56 // {Integer} Apply the policy to the agent.(0: false, 1: true)
};

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

namespace Example
{
    public class createUserTagsExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username
            var body = new array[TagVo](); // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
            var applyAgent = 56;  // Integer | Apply the policy to the agent.(0: false, 1: true) (optional) 

            try
            {
                // Assign a tag
                apiInstance.createUserTags(userId, body, applyAgent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createUserTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username
$body = ; // array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
$applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)

try {
    $api_instance->createUserTags($userId, $body, $applyAgent);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->createUserTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username
my $body = [WWW::SwaggerClient::Object::array[TagVo]->new()]; # array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
my $applyAgent = 56; # Integer | Apply the policy to the agent.(0: false, 1: true)

eval { 
    $api_instance->createUserTags(userId => $userId, body => $body, applyAgent => $applyAgent);
};
if ($@) {
    warn "Exception when calling UsersApi->createUserTags: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username
body =  # array[TagVo] | Tag JSON Array (Expiry Format: yyyy-MM-dd HH:mm)
applyAgent = 56 # Integer | Apply the policy to the agent.(0: false, 1: true) (optional)

try: 
    # Assign a tag
    api_instance.create_user_tags(userId, body, applyAgent=applyAgent)
except ApiException as e:
    print("Exception when calling UsersApi->createUserTags: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username
Required
Body parameters
Name Description
body *
Query parameters
Name Description
applyAgent
Integer (int32)
Apply the policy to the agent.(0: false, 1: true)

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


createUsers

Add a new user

Adds a new user.


/users

Usage and SDK Samples

curl -X POST "https://localhost/mc2/rest/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        array[UserWithAdminVo] body = ; // array[UserWithAdminVo] | JSON Data
        try {
            Messages Value Object result = apiInstance.createUsers(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        array[UserWithAdminVo] body = ; // array[UserWithAdminVo] | JSON Data
        try {
            Messages Value Object result = apiInstance.createUsers(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUsers");
            e.printStackTrace();
        }
    }
}
array[UserWithAdminVo] *body = ; // JSON Data

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

// Add a new user
[apiInstance createUsersWith:body
              completionHandler: ^(Messages Value Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var body = ; // {array[UserWithAdminVo]} JSON Data


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

namespace Example
{
    public class createUsersExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var body = new array[UserWithAdminVo](); // array[UserWithAdminVo] | JSON Data

            try
            {
                // Add a new user
                Messages Value Object result = apiInstance.createUsers(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$body = ; // array[UserWithAdminVo] | JSON Data

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $body = [WWW::SwaggerClient::Object::array[UserWithAdminVo]->new()]; # array[UserWithAdminVo] | JSON Data

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

# create an instance of the API class
api_instance = swagger_client.UsersApi()
body =  # array[UserWithAdminVo] | JSON Data

try: 
    # Add a new user
    api_response = api_instance.create_users(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->createUsers: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 401 - Unauthorized


deleteUser

Delete a specific user

Deletes the user specified.


/users/{userId}

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        try {
            apiInstance.deleteUser(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        try {
            apiInstance.deleteUser(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username (USER_ID)

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

// Delete a specific user
[apiInstance deleteUserWith:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username (USER_ID)


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

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username (USER_ID)

            try
            {
                // Delete a specific user
                apiInstance.deleteUser(userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username (USER_ID)

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username (USER_ID)

eval { 
    $api_instance->deleteUser(userId => $userId);
};
if ($@) {
    warn "Exception when calling UsersApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username (USER_ID)

try: 
    # Delete a specific user
    api_instance.delete_user(userId)
except ApiException as e:
    print("Exception when calling UsersApi->deleteUser: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username (USER_ID)
Required

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteUserTags

Remove the tag(s)

Removes the tag(s) from the user specified.


/users/{userId}/tags

Usage and SDK Samples

curl -X DELETE "https://localhost/mc2/rest/users/{userId}/tags?applyAgent="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        array[String] body = ; // array[String] | Tag List
        Integer applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)
        try {
            apiInstance.deleteUserTags(userId, body, applyAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUserTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        array[String] body = ; // array[String] | Tag List
        Integer applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)
        try {
            apiInstance.deleteUserTags(userId, body, applyAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUserTags");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username (USER_ID)
array[String] *body = ; // Tag List
Integer *applyAgent = 56; // Apply the policy to the agent.(0: false, 1: true) (optional)

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

// Remove the tag(s)
[apiInstance deleteUserTagsWith:userId
    body:body
    applyAgent:applyAgent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username (USER_ID)

var body = ; // {array[String]} Tag List

var opts = { 
  'applyAgent': 56 // {Integer} Apply the policy to the agent.(0: false, 1: true)
};

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

namespace Example
{
    public class deleteUserTagsExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username (USER_ID)
            var body = new array[String](); // array[String] | Tag List
            var applyAgent = 56;  // Integer | Apply the policy to the agent.(0: false, 1: true) (optional) 

            try
            {
                // Remove the tag(s)
                apiInstance.deleteUserTags(userId, body, applyAgent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.deleteUserTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username (USER_ID)
$body = ; // array[String] | Tag List
$applyAgent = 56; // Integer | Apply the policy to the agent.(0: false, 1: true)

try {
    $api_instance->deleteUserTags($userId, $body, $applyAgent);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->deleteUserTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username (USER_ID)
my $body = [WWW::SwaggerClient::Object::array[String]->new()]; # array[String] | Tag List
my $applyAgent = 56; # Integer | Apply the policy to the agent.(0: false, 1: true)

eval { 
    $api_instance->deleteUserTags(userId => $userId, body => $body, applyAgent => $applyAgent);
};
if ($@) {
    warn "Exception when calling UsersApi->deleteUserTags: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username (USER_ID)
body =  # array[String] | Tag List
applyAgent = 56 # Integer | Apply the policy to the agent.(0: false, 1: true) (optional)

try: 
    # Remove the tag(s)
    api_instance.delete_user_tags(userId, body, applyAgent=applyAgent)
except ApiException as e:
    print("Exception when calling UsersApi->deleteUserTags: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username (USER_ID)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
applyAgent
Integer (int32)
Apply the policy to the agent.(0: false, 1: true)

Responses

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getUser

Retrieve a specific user's information

Retrieves the information of the user specified.


/users/{userId}

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        try {
            UserVo result = apiInstance.getUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        try {
            UserVo result = apiInstance.getUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username (USER_ID)

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

// Retrieve a specific user's information
[apiInstance getUserWith:userId
              completionHandler: ^(UserVo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username (USER_ID)


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

namespace Example
{
    public class getUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username (USER_ID)

            try
            {
                // Retrieve a specific user's information
                UserVo result = apiInstance.getUser(userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username (USER_ID)

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username (USER_ID)

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

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username (USER_ID)

try: 
    # Retrieve a specific user's information
    api_response = api_instance.get_user(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUser: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username (USER_ID)
Required

Responses

Status: 200 - successful operation

Status: 401 - Unauthorized

Status: 404 - Not Found


getUserTags

Retrieve a specific user's tag(s)

Retrieves the tag(s) assigned to the user specified.


/users/{userId}/tags

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/users/{userId}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        try {
            apiInstance.getUserTags(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | Username (USER_ID)
        try {
            apiInstance.getUserTags(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUserTags");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // Username (USER_ID)

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

// Retrieve a specific user's tag(s)
[apiInstance getUserTagsWith:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} Username (USER_ID)


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

namespace Example
{
    public class getUserTagsExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | Username (USER_ID)

            try
            {
                // Retrieve a specific user's tag(s)
                apiInstance.getUserTags(userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUserTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | Username (USER_ID)

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | Username (USER_ID)

eval { 
    $api_instance->getUserTags(userId => $userId);
};
if ($@) {
    warn "Exception when calling UsersApi->getUserTags: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | Username (USER_ID)

try: 
    # Retrieve a specific user's tag(s)
    api_instance.get_user_tags(userId)
except ApiException as e:
    print("Exception when calling UsersApi->getUserTags: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Username (USER_ID)
Required

Responses

Status: 401 - Unauthorized

Status: 404 - Username Not Found


getUsers

List users

Retrieves a list of the users.


/users

Usage and SDK Samples

curl -X GET "https://localhost/mc2/rest/users?page=&pageSize=&view=&qsearch2=&type=&searchFlag=&id=&name=&dept=&position=&cdept=&deptpath=&cposition=&status=&right=&authstatus=&newadd=&noAuthDays=&authsynctype=&roleId=&property=&purpose=&userGrp=&quickSearch=&customKey=&customField=&customFieldVal=&customParam="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String view = view_example; // String | View
        String qsearch2 = qsearch2_example; // String | qsearch2
        String type = type_example; // String | type
        String searchFlag = searchFlag_example; // String | searchFlag
        String id = id_example; // String | id
        String name = name_example; // String | name
        String dept = dept_example; // String | dept
        String position = position_example; // String | position
        String cdept = cdept_example; // String | cdept
        String deptpath = deptpath_example; // String | deptpath
        String cposition = cposition_example; // String | cposition
        String status = status_example; // String | status
        String right = right_example; // String | right
        String authstatus = authstatus_example; // String | authstatus
        String newadd = newadd_example; // String | newadd
        String noAuthDays = noAuthDays_example; // String | noAuthDays
        String authsynctype = authsynctype_example; // String | authsynctype
        String roleId = roleId_example; // String | roleId
        String property = property_example; // String | property
        String purpose = purpose_example; // String | purpose
        String userGrp = userGrp_example; // String | userGrp
        String quickSearch = quickSearch_example; // String | quickSearch
        String customKey = customKey_example; // String | customKey
        String customField = customField_example; // String | customField
        String customFieldVal = customFieldVal_example; // String | customFieldVal
        String customParam = customParam_example; // String | customParam (e.g., authlast;gt;2020-01-03 23:59:59)
        try {
            map['String', Object] result = apiInstance.getUsers(page, pageSize, view, qsearch2, type, searchFlag, id, name, dept, position, cdept, deptpath, cposition, status, right, authstatus, newadd, noAuthDays, authsynctype, roleId, property, purpose, userGrp, quickSearch, customKey, customField, customFieldVal, customParam);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer page = 56; // Integer | Results page to be retrieved
        Integer pageSize = 56; // Integer | Number of records per page
        String view = view_example; // String | View
        String qsearch2 = qsearch2_example; // String | qsearch2
        String type = type_example; // String | type
        String searchFlag = searchFlag_example; // String | searchFlag
        String id = id_example; // String | id
        String name = name_example; // String | name
        String dept = dept_example; // String | dept
        String position = position_example; // String | position
        String cdept = cdept_example; // String | cdept
        String deptpath = deptpath_example; // String | deptpath
        String cposition = cposition_example; // String | cposition
        String status = status_example; // String | status
        String right = right_example; // String | right
        String authstatus = authstatus_example; // String | authstatus
        String newadd = newadd_example; // String | newadd
        String noAuthDays = noAuthDays_example; // String | noAuthDays
        String authsynctype = authsynctype_example; // String | authsynctype
        String roleId = roleId_example; // String | roleId
        String property = property_example; // String | property
        String purpose = purpose_example; // String | purpose
        String userGrp = userGrp_example; // String | userGrp
        String quickSearch = quickSearch_example; // String | quickSearch
        String customKey = customKey_example; // String | customKey
        String customField = customField_example; // String | customField
        String customFieldVal = customFieldVal_example; // String | customFieldVal
        String customParam = customParam_example; // String | customParam (e.g., authlast;gt;2020-01-03 23:59:59)
        try {
            map['String', Object] result = apiInstance.getUsers(page, pageSize, view, qsearch2, type, searchFlag, id, name, dept, position, cdept, deptpath, cposition, status, right, authstatus, newadd, noAuthDays, authsynctype, roleId, property, purpose, userGrp, quickSearch, customKey, customField, customFieldVal, customParam);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // Results page to be retrieved (default to 1)
Integer *pageSize = 56; // Number of records per page (default to 30)
String *view = view_example; // View (default to user)
String *qsearch2 = qsearch2_example; // qsearch2 (optional)
String *type = type_example; // type (optional)
String *searchFlag = searchFlag_example; // searchFlag (optional)
String *id = id_example; // id (optional)
String *name = name_example; // name (optional)
String *dept = dept_example; // dept (optional)
String *position = position_example; // position (optional)
String *cdept = cdept_example; // cdept (optional)
String *deptpath = deptpath_example; // deptpath (optional)
String *cposition = cposition_example; // cposition (optional)
String *status = status_example; // status (optional)
String *right = right_example; // right (optional)
String *authstatus = authstatus_example; // authstatus (optional)
String *newadd = newadd_example; // newadd (optional)
String *noAuthDays = noAuthDays_example; // noAuthDays (optional)
String *authsynctype = authsynctype_example; // authsynctype (optional)
String *roleId = roleId_example; // roleId (optional)
String *property = property_example; // property (optional)
String *purpose = purpose_example; // purpose (optional)
String *userGrp = userGrp_example; // userGrp (optional)
String *quickSearch = quickSearch_example; // quickSearch (optional)
String *customKey = customKey_example; // customKey (optional)
String *customField = customField_example; // customField (optional)
String *customFieldVal = customFieldVal_example; // customFieldVal (optional)
String *customParam = customParam_example; // customParam (e.g., authlast;gt;2020-01-03 23:59:59) (optional)

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

// List users
[apiInstance getUsersWith:page
    pageSize:pageSize
    view:view
    qsearch2:qsearch2
    type:type
    searchFlag:searchFlag
    id:id
    name:name
    dept:dept
    position:position
    cdept:cdept
    deptpath:deptpath
    cposition:cposition
    status:status
    right:right
    authstatus:authstatus
    newadd:newadd
    noAuthDays:noAuthDays
    authsynctype:authsynctype
    roleId:roleId
    property:property
    purpose:purpose
    userGrp:userGrp
    quickSearch:quickSearch
    customKey:customKey
    customField:customField
    customFieldVal:customFieldVal
    customParam:customParam
              completionHandler: ^(map['String', Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var page = 56; // {Integer} Results page to be retrieved

var pageSize = 56; // {Integer} Number of records per page

var view = view_example; // {String} View

var opts = { 
  'qsearch2': qsearch2_example, // {String} qsearch2
  'type': type_example, // {String} type
  'searchFlag': searchFlag_example, // {String} searchFlag
  'id': id_example, // {String} id
  'name': name_example, // {String} name
  'dept': dept_example, // {String} dept
  'position': position_example, // {String} position
  'cdept': cdept_example, // {String} cdept
  'deptpath': deptpath_example, // {String} deptpath
  'cposition': cposition_example, // {String} cposition
  'status': status_example, // {String} status
  'right': right_example, // {String} right
  'authstatus': authstatus_example, // {String} authstatus
  'newadd': newadd_example, // {String} newadd
  'noAuthDays': noAuthDays_example, // {String} noAuthDays
  'authsynctype': authsynctype_example, // {String} authsynctype
  'roleId': roleId_example, // {String} roleId
  'property': property_example, // {String} property
  'purpose': purpose_example, // {String} purpose
  'userGrp': userGrp_example, // {String} userGrp
  'quickSearch': quickSearch_example, // {String} quickSearch
  'customKey': customKey_example, // {String} customKey
  'customField': customField_example, // {String} customField
  'customFieldVal': customFieldVal_example, // {String} customFieldVal
  'customParam': customParam_example // {String} customParam (e.g., authlast;gt;2020-01-03 23:59:59)
};

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

namespace Example
{
    public class getUsersExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var page = 56;  // Integer | Results page to be retrieved (default to 1)
            var pageSize = 56;  // Integer | Number of records per page (default to 30)
            var view = view_example;  // String | View (default to user)
            var qsearch2 = qsearch2_example;  // String | qsearch2 (optional) 
            var type = type_example;  // String | type (optional) 
            var searchFlag = searchFlag_example;  // String | searchFlag (optional) 
            var id = id_example;  // String | id (optional) 
            var name = name_example;  // String | name (optional) 
            var dept = dept_example;  // String | dept (optional) 
            var position = position_example;  // String | position (optional) 
            var cdept = cdept_example;  // String | cdept (optional) 
            var deptpath = deptpath_example;  // String | deptpath (optional) 
            var cposition = cposition_example;  // String | cposition (optional) 
            var status = status_example;  // String | status (optional) 
            var right = right_example;  // String | right (optional) 
            var authstatus = authstatus_example;  // String | authstatus (optional) 
            var newadd = newadd_example;  // String | newadd (optional) 
            var noAuthDays = noAuthDays_example;  // String | noAuthDays (optional) 
            var authsynctype = authsynctype_example;  // String | authsynctype (optional) 
            var roleId = roleId_example;  // String | roleId (optional) 
            var property = property_example;  // String | property (optional) 
            var purpose = purpose_example;  // String | purpose (optional) 
            var userGrp = userGrp_example;  // String | userGrp (optional) 
            var quickSearch = quickSearch_example;  // String | quickSearch (optional) 
            var customKey = customKey_example;  // String | customKey (optional) 
            var customField = customField_example;  // String | customField (optional) 
            var customFieldVal = customFieldVal_example;  // String | customFieldVal (optional) 
            var customParam = customParam_example;  // String | customParam (e.g., authlast;gt;2020-01-03 23:59:59) (optional) 

            try
            {
                // List users
                map['String', Object] result = apiInstance.getUsers(page, pageSize, view, qsearch2, type, searchFlag, id, name, dept, position, cdept, deptpath, cposition, status, right, authstatus, newadd, noAuthDays, authsynctype, roleId, property, purpose, userGrp, quickSearch, customKey, customField, customFieldVal, customParam);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$page = 56; // Integer | Results page to be retrieved
$pageSize = 56; // Integer | Number of records per page
$view = view_example; // String | View
$qsearch2 = qsearch2_example; // String | qsearch2
$type = type_example; // String | type
$searchFlag = searchFlag_example; // String | searchFlag
$id = id_example; // String | id
$name = name_example; // String | name
$dept = dept_example; // String | dept
$position = position_example; // String | position
$cdept = cdept_example; // String | cdept
$deptpath = deptpath_example; // String | deptpath
$cposition = cposition_example; // String | cposition
$status = status_example; // String | status
$right = right_example; // String | right
$authstatus = authstatus_example; // String | authstatus
$newadd = newadd_example; // String | newadd
$noAuthDays = noAuthDays_example; // String | noAuthDays
$authsynctype = authsynctype_example; // String | authsynctype
$roleId = roleId_example; // String | roleId
$property = property_example; // String | property
$purpose = purpose_example; // String | purpose
$userGrp = userGrp_example; // String | userGrp
$quickSearch = quickSearch_example; // String | quickSearch
$customKey = customKey_example; // String | customKey
$customField = customField_example; // String | customField
$customFieldVal = customFieldVal_example; // String | customFieldVal
$customParam = customParam_example; // String | customParam (e.g., authlast;gt;2020-01-03 23:59:59)

try {
    $result = $api_instance->getUsers($page, $pageSize, $view, $qsearch2, $type, $searchFlag, $id, $name, $dept, $position, $cdept, $deptpath, $cposition, $status, $right, $authstatus, $newadd, $noAuthDays, $authsynctype, $roleId, $property, $purpose, $userGrp, $quickSearch, $customKey, $customField, $customFieldVal, $customParam);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $page = 56; # Integer | Results page to be retrieved
my $pageSize = 56; # Integer | Number of records per page
my $view = view_example; # String | View
my $qsearch2 = qsearch2_example; # String | qsearch2
my $type = type_example; # String | type
my $searchFlag = searchFlag_example; # String | searchFlag
my $id = id_example; # String | id
my $name = name_example; # String | name
my $dept = dept_example; # String | dept
my $position = position_example; # String | position
my $cdept = cdept_example; # String | cdept
my $deptpath = deptpath_example; # String | deptpath
my $cposition = cposition_example; # String | cposition
my $status = status_example; # String | status
my $right = right_example; # String | right
my $authstatus = authstatus_example; # String | authstatus
my $newadd = newadd_example; # String | newadd
my $noAuthDays = noAuthDays_example; # String | noAuthDays
my $authsynctype = authsynctype_example; # String | authsynctype
my $roleId = roleId_example; # String | roleId
my $property = property_example; # String | property
my $purpose = purpose_example; # String | purpose
my $userGrp = userGrp_example; # String | userGrp
my $quickSearch = quickSearch_example; # String | quickSearch
my $customKey = customKey_example; # String | customKey
my $customField = customField_example; # String | customField
my $customFieldVal = customFieldVal_example; # String | customFieldVal
my $customParam = customParam_example; # String | customParam (e.g., authlast;gt;2020-01-03 23:59:59)

eval { 
    my $result = $api_instance->getUsers(page => $page, pageSize => $pageSize, view => $view, qsearch2 => $qsearch2, type => $type, searchFlag => $searchFlag, id => $id, name => $name, dept => $dept, position => $position, cdept => $cdept, deptpath => $deptpath, cposition => $cposition, status => $status, right => $right, authstatus => $authstatus, newadd => $newadd, noAuthDays => $noAuthDays, authsynctype => $authsynctype, roleId => $roleId, property => $property, purpose => $purpose, userGrp => $userGrp, quickSearch => $quickSearch, customKey => $customKey, customField => $customField, customFieldVal => $customFieldVal, customParam => $customParam);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUsers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
page = 56 # Integer | Results page to be retrieved (default to 1)
pageSize = 56 # Integer | Number of records per page (default to 30)
view = view_example # String | View (default to user)
qsearch2 = qsearch2_example # String | qsearch2 (optional)
type = type_example # String | type (optional)
searchFlag = searchFlag_example # String | searchFlag (optional)
id = id_example # String | id (optional)
name = name_example # String | name (optional)
dept = dept_example # String | dept (optional)
position = position_example # String | position (optional)
cdept = cdept_example # String | cdept (optional)
deptpath = deptpath_example # String | deptpath (optional)
cposition = cposition_example # String | cposition (optional)
status = status_example # String | status (optional)
right = right_example # String | right (optional)
authstatus = authstatus_example # String | authstatus (optional)
newadd = newadd_example # String | newadd (optional)
noAuthDays = noAuthDays_example # String | noAuthDays (optional)
authsynctype = authsynctype_example # String | authsynctype (optional)
roleId = roleId_example # String | roleId (optional)
property = property_example # String | property (optional)
purpose = purpose_example # String | purpose (optional)
userGrp = userGrp_example # String | userGrp (optional)
quickSearch = quickSearch_example # String | quickSearch (optional)
customKey = customKey_example # String | customKey (optional)
customField = customField_example # String | customField (optional)
customFieldVal = customFieldVal_example # String | customFieldVal (optional)
customParam = customParam_example # String | customParam (e.g., authlast;gt;2020-01-03 23:59:59) (optional)

try: 
    # List users
    api_response = api_instance.get_users(page, pageSize, view, qsearch2=qsearch2, type=type, searchFlag=searchFlag, id=id, name=name, dept=dept, position=position, cdept=cdept, deptpath=deptpath, cposition=cposition, status=status, right=right, authstatus=authstatus, newadd=newadd, noAuthDays=noAuthDays, authsynctype=authsynctype, roleId=roleId, property=property, purpose=purpose, userGrp=userGrp, quickSearch=quickSearch, customKey=customKey, customField=customField, customFieldVal=customFieldVal, customParam=customParam)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUsers: %s\n" % e)

Parameters

Query parameters
Name Description
page*
Integer (int32)
Results page to be retrieved
Required
pageSize*
Integer (int32)
Number of records per page
Required
view*
String
View
Required
qsearch2
String
qsearch2
type
String
type
searchFlag
String
searchFlag
id
String
id
name
String
name
dept
String
dept
position
String
position
cdept
String
cdept
deptpath
String
deptpath
cposition
String
cposition
status
String
status
right
String
right
authstatus
String
authstatus
newadd
String
newadd
noAuthDays
String
noAuthDays
authsynctype
String
authsynctype
roleId
String
roleId
property
String
property
purpose
String
purpose
userGrp
String
userGrp
quickSearch
String
quickSearch
customKey
String
customKey
customField
String
customField
customFieldVal
String
customFieldVal
customParam
String
customParam (e.g., authlast;gt;2020-01-03 23:59:59)

Responses

Status: 200 - successful operation

Status: 401 - Unauthorized

Status: 404 - Not Found


updateMyinfo

Edit my information

Modify the information of the currently connected user.


/users/myinfo

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/users/myinfo?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        UserVo body = ; // UserVo | UserVo JSON Data
        String locale = locale_example; // String | Locale
        try {
            apiInstance.updateMyinfo(body, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateMyinfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserVo body = ; // UserVo | UserVo JSON Data
        String locale = locale_example; // String | Locale
        try {
            apiInstance.updateMyinfo(body, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateMyinfo");
            e.printStackTrace();
        }
    }
}
UserVo *body = ; // UserVo JSON Data
String *locale = locale_example; // Locale (optional)

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

// Edit my information
[apiInstance updateMyinfoWith:body
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var body = ; // {UserVo} UserVo JSON Data

var opts = { 
  'locale': locale_example // {String} Locale
};

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

namespace Example
{
    public class updateMyinfoExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var body = new UserVo(); // UserVo | UserVo JSON Data
            var locale = locale_example;  // String | Locale (optional) 

            try
            {
                // Edit my information
                apiInstance.updateMyinfo(body, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateMyinfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$body = ; // UserVo | UserVo JSON Data
$locale = locale_example; // String | Locale

try {
    $api_instance->updateMyinfo($body, $locale);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->updateMyinfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $body = WWW::SwaggerClient::Object::UserVo->new(); # UserVo | UserVo JSON Data
my $locale = locale_example; # String | Locale

eval { 
    $api_instance->updateMyinfo(body => $body, locale => $locale);
};
if ($@) {
    warn "Exception when calling UsersApi->updateMyinfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
body =  # UserVo | UserVo JSON Data
locale = locale_example # String | Locale (optional)

try: 
    # Edit my information
    api_instance.update_myinfo(body, locale=locale)
except ApiException as e:
    print("Exception when calling UsersApi->updateMyinfo: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
locale
String
Locale

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


updateUser

Update an existing user

Updates an existing user.


/users/{userId}

Usage and SDK Samples

curl -X PUT "https://localhost/mc2/rest/users/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | User ID
        UserVo body = ; // UserVo | UserVo JSON Data
        try {
            apiInstance.updateUser(userId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | User ID
        UserVo body = ; // UserVo | UserVo JSON Data
        try {
            apiInstance.updateUser(userId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // User ID
UserVo *body = ; // UserVo JSON Data

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

// Update an existing user
[apiInstance updateUserWith:userId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GenianZtnaRestApi = require('genian_ztna_rest_api');

var api = new GenianZtnaRestApi.UsersApi()

var userId = userId_example; // {String} User ID

var body = ; // {UserVo} UserVo JSON Data


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

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | User ID
            var body = new UserVo(); // UserVo | UserVo JSON Data

            try
            {
                // Update an existing user
                apiInstance.updateUser(userId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | User ID
$body = ; // UserVo | UserVo JSON Data

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | User ID
my $body = WWW::SwaggerClient::Object::UserVo->new(); # UserVo | UserVo JSON Data

eval { 
    $api_instance->updateUser(userId => $userId, body => $body);
};
if ($@) {
    warn "Exception when calling UsersApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | User ID
body =  # UserVo | UserVo JSON Data

try: 
    # Update an existing user
    api_instance.update_user(userId, body)
except ApiException as e:
    print("Exception when calling UsersApi->updateUser: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
User ID
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error