Delegation Api

VirtualTenants

createVirtualTenant

Create a virtual tenant

Creates a virtual tenant, using the VirtualTenant in the body. See also: https://help.coreview.com/organize-and-manage-virtual-tenants/create-virtual-tenant.


/delegation/virtual-tenants

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://uknapiproxy.coreview.com/public/delegation/virtual-tenants?api-version=apiVersion_example" \
 -d '{
  "deviceFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "userFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "deviceSecurityGroups" : [ {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  }, {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  } ],
  "usersGroups" : [ {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  }, {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  } ],
  "distributionGroupDomainFilters" : [ "distributionGroupDomainFilters", "distributionGroupDomainFilters" ],
  "description" : "description",
  "operatorsGroups" : [ {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  }, {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  } ],
  "userDomainFilters" : [ "userDomainFilters", "userDomainFilters" ],
  "organizationalUnitFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "operators" : [ "operators", "operators" ],
  "name" : "name",
  "distributionGroupFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "id" : "id",
  "microsoft365GroupFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "securityGroupFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ]
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VirtualTenantsApi;

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

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

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String apiVersion = apiVersion_example; // String | 
        VirtualTenant virtualTenant = ; // VirtualTenant | 

        try {
            CreatedResult result = apiInstance.createVirtualTenant(apiVersion, virtualTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#createVirtualTenant");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String apiVersion = new String(); // String | 
final VirtualTenant virtualTenant = new VirtualTenant(); // VirtualTenant | 

try {
    final result = await api_instance.createVirtualTenant(apiVersion, virtualTenant);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createVirtualTenant: $e\n');
}


import org.openapitools.client.api.VirtualTenantsApi;

public class VirtualTenantsApiExample {
    public static void main(String[] args) {
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String apiVersion = apiVersion_example; // String | 
        VirtualTenant virtualTenant = ; // VirtualTenant | 

        try {
            CreatedResult result = apiInstance.createVirtualTenant(apiVersion, virtualTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#createVirtualTenant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
VirtualTenantsApi *apiInstance = [[VirtualTenantsApi alloc] init];
String *apiVersion = apiVersion_example; //  (default to null)
VirtualTenant *virtualTenant = ; //  (optional)

// Create a virtual tenant
[apiInstance createVirtualTenantWith:apiVersion
    virtualTenant:virtualTenant
              completionHandler: ^(CreatedResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DelegationApi = require('delegation_api');
var defaultClient = DelegationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new DelegationApi.VirtualTenantsApi()
var apiVersion = apiVersion_example; // {String} 
var opts = {
  'virtualTenant':  // {VirtualTenant} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createVirtualTenant(apiVersion, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createVirtualTenantExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VirtualTenantsApi();
            var apiVersion = apiVersion_example;  // String |  (default to null)
            var virtualTenant = new VirtualTenant(); // VirtualTenant |  (optional) 

            try {
                // Create a virtual tenant
                CreatedResult result = apiInstance.createVirtualTenant(apiVersion, virtualTenant);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VirtualTenantsApi.createVirtualTenant: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VirtualTenantsApi();
$apiVersion = apiVersion_example; // String | 
$virtualTenant = ; // VirtualTenant | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VirtualTenantsApi->new();
my $apiVersion = apiVersion_example; # String | 
my $virtualTenant = WWW::OPenAPIClient::Object::VirtualTenant->new(); # VirtualTenant | 

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

# Configure OAuth2 access token for authorization: oauth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VirtualTenantsApi()
apiVersion = apiVersion_example # String |  (default to null)
virtualTenant =  # VirtualTenant |  (optional)

try:
    # Create a virtual tenant
    api_response = api_instance.create_virtual_tenant(apiVersion, virtualTenant=virtualTenant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualTenantsApi->createVirtualTenant: %s\n" % e)
extern crate VirtualTenantsApi;

pub fn main() {
    let apiVersion = apiVersion_example; // String
    let virtualTenant = ; // VirtualTenant

    let mut context = VirtualTenantsApi::Context::default();
    let result = client.createVirtualTenant(apiVersion, virtualTenant, &context).wait();

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

Scopes

delegation.write Write access to delegation resources

Parameters

Body parameters
Name Description
virtualTenant

Query parameters
Name Description
api-version*
String
Required

Responses

deleteVirtualTenant

Delete a specific virtual tenant

Deletes a virtual tenant with the given id. See also: https://help.coreview.com/organize-and-manage-virtual-tenants/delete-virtual-tenants.


/delegation/virtual-tenants/{id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/json" \
 "https://uknapiproxy.coreview.com/public/delegation/virtual-tenants/{id}?api-version=apiVersion_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VirtualTenantsApi;

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

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

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String id = id_example; // String | The unique identifier for the VirtualTenant.
        String apiVersion = apiVersion_example; // String | 

        try {
            OkResult result = apiInstance.deleteVirtualTenant(id, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#deleteVirtualTenant");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The unique identifier for the VirtualTenant.
final String apiVersion = new String(); // String | 

try {
    final result = await api_instance.deleteVirtualTenant(id, apiVersion);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteVirtualTenant: $e\n');
}


import org.openapitools.client.api.VirtualTenantsApi;

public class VirtualTenantsApiExample {
    public static void main(String[] args) {
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String id = id_example; // String | The unique identifier for the VirtualTenant.
        String apiVersion = apiVersion_example; // String | 

        try {
            OkResult result = apiInstance.deleteVirtualTenant(id, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#deleteVirtualTenant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
VirtualTenantsApi *apiInstance = [[VirtualTenantsApi alloc] init];
String *id = id_example; // The unique identifier for the VirtualTenant. (default to null)
String *apiVersion = apiVersion_example; //  (default to null)

// Delete a specific virtual tenant
[apiInstance deleteVirtualTenantWith:id
    apiVersion:apiVersion
              completionHandler: ^(OkResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DelegationApi = require('delegation_api');
var defaultClient = DelegationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new DelegationApi.VirtualTenantsApi()
var id = id_example; // {String} The unique identifier for the VirtualTenant.
var apiVersion = apiVersion_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteVirtualTenant(id, apiVersion, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteVirtualTenantExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VirtualTenantsApi();
            var id = id_example;  // String | The unique identifier for the VirtualTenant. (default to null)
            var apiVersion = apiVersion_example;  // String |  (default to null)

            try {
                // Delete a specific virtual tenant
                OkResult result = apiInstance.deleteVirtualTenant(id, apiVersion);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VirtualTenantsApi.deleteVirtualTenant: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VirtualTenantsApi();
$id = id_example; // String | The unique identifier for the VirtualTenant.
$apiVersion = apiVersion_example; // String | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VirtualTenantsApi->new();
my $id = id_example; # String | The unique identifier for the VirtualTenant.
my $apiVersion = apiVersion_example; # String | 

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

# Configure OAuth2 access token for authorization: oauth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VirtualTenantsApi()
id = id_example # String | The unique identifier for the VirtualTenant. (default to null)
apiVersion = apiVersion_example # String |  (default to null)

try:
    # Delete a specific virtual tenant
    api_response = api_instance.delete_virtual_tenant(id, apiVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualTenantsApi->deleteVirtualTenant: %s\n" % e)
extern crate VirtualTenantsApi;

pub fn main() {
    let id = id_example; // String
    let apiVersion = apiVersion_example; // String

    let mut context = VirtualTenantsApi::Context::default();
    let result = client.deleteVirtualTenant(id, apiVersion, &context).wait();

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

Scopes

delegation.write Write access to delegation resources

Parameters

Path parameters
Name Description
id*
String
The unique identifier for the VirtualTenant.
Required
Query parameters
Name Description
api-version*
String
Required

Responses

getVirtualTenant

Get a single virtual tenant

Returns a single virtual tenant having the given id.


/delegation/virtual-tenants/{id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://uknapiproxy.coreview.com/public/delegation/virtual-tenants/{id}?api-version=apiVersion_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VirtualTenantsApi;

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

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

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String id = id_example; // String | The unique identifier for the VirtualTenant.
        String apiVersion = apiVersion_example; // String | 

        try {
            VirtualTenant result = apiInstance.getVirtualTenant(id, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#getVirtualTenant");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The unique identifier for the VirtualTenant.
final String apiVersion = new String(); // String | 

try {
    final result = await api_instance.getVirtualTenant(id, apiVersion);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getVirtualTenant: $e\n');
}


import org.openapitools.client.api.VirtualTenantsApi;

public class VirtualTenantsApiExample {
    public static void main(String[] args) {
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String id = id_example; // String | The unique identifier for the VirtualTenant.
        String apiVersion = apiVersion_example; // String | 

        try {
            VirtualTenant result = apiInstance.getVirtualTenant(id, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#getVirtualTenant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
VirtualTenantsApi *apiInstance = [[VirtualTenantsApi alloc] init];
String *id = id_example; // The unique identifier for the VirtualTenant. (default to null)
String *apiVersion = apiVersion_example; //  (default to null)

// Get a single virtual tenant
[apiInstance getVirtualTenantWith:id
    apiVersion:apiVersion
              completionHandler: ^(VirtualTenant output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DelegationApi = require('delegation_api');
var defaultClient = DelegationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new DelegationApi.VirtualTenantsApi()
var id = id_example; // {String} The unique identifier for the VirtualTenant.
var apiVersion = apiVersion_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualTenant(id, apiVersion, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVirtualTenantExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VirtualTenantsApi();
            var id = id_example;  // String | The unique identifier for the VirtualTenant. (default to null)
            var apiVersion = apiVersion_example;  // String |  (default to null)

            try {
                // Get a single virtual tenant
                VirtualTenant result = apiInstance.getVirtualTenant(id, apiVersion);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VirtualTenantsApi.getVirtualTenant: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VirtualTenantsApi();
$id = id_example; // String | The unique identifier for the VirtualTenant.
$apiVersion = apiVersion_example; // String | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VirtualTenantsApi->new();
my $id = id_example; # String | The unique identifier for the VirtualTenant.
my $apiVersion = apiVersion_example; # String | 

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

# Configure OAuth2 access token for authorization: oauth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VirtualTenantsApi()
id = id_example # String | The unique identifier for the VirtualTenant. (default to null)
apiVersion = apiVersion_example # String |  (default to null)

try:
    # Get a single virtual tenant
    api_response = api_instance.get_virtual_tenant(id, apiVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualTenantsApi->getVirtualTenant: %s\n" % e)
extern crate VirtualTenantsApi;

pub fn main() {
    let id = id_example; // String
    let apiVersion = apiVersion_example; // String

    let mut context = VirtualTenantsApi::Context::default();
    let result = client.getVirtualTenant(id, apiVersion, &context).wait();

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

Scopes

delegation.read Read access to delegation resources

Parameters

Path parameters
Name Description
id*
String
The unique identifier for the VirtualTenant.
Required
Query parameters
Name Description
api-version*
String
Required

Responses

getVirtualTenants

Get a list of virtual tenants

Returns a paginated and sorted list of virtual tenants. See also: https://help.coreview.com/organize-and-manage-virtual-tenants.


/delegation/virtual-tenants

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://uknapiproxy.coreview.com/public/delegation/virtual-tenants?PageNumber=56&PageSize=56&Sort=sort_example&SortOrder=sortOrder_example&Fields=&RetrieveTotal=true&api-version=apiVersion_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VirtualTenantsApi;

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

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

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String apiVersion = apiVersion_example; // String | 
        Integer pageNumber = 56; // Integer | 
        Integer pageSize = 56; // Integer | 
        String sort = sort_example; // String | 
        String sortOrder = sortOrder_example; // String | 
        array[String] fields = ; // array[String] | 
        Boolean retrieveTotal = true; // Boolean | 

        try {
            VirtualTenantPagedResponse result = apiInstance.getVirtualTenants(apiVersion, pageNumber, pageSize, sort, sortOrder, fields, retrieveTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#getVirtualTenants");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String apiVersion = new String(); // String | 
final Integer pageNumber = new Integer(); // Integer | 
final Integer pageSize = new Integer(); // Integer | 
final String sort = new String(); // String | 
final String sortOrder = new String(); // String | 
final array[String] fields = new array[String](); // array[String] | 
final Boolean retrieveTotal = new Boolean(); // Boolean | 

try {
    final result = await api_instance.getVirtualTenants(apiVersion, pageNumber, pageSize, sort, sortOrder, fields, retrieveTotal);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getVirtualTenants: $e\n');
}


import org.openapitools.client.api.VirtualTenantsApi;

public class VirtualTenantsApiExample {
    public static void main(String[] args) {
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String apiVersion = apiVersion_example; // String | 
        Integer pageNumber = 56; // Integer | 
        Integer pageSize = 56; // Integer | 
        String sort = sort_example; // String | 
        String sortOrder = sortOrder_example; // String | 
        array[String] fields = ; // array[String] | 
        Boolean retrieveTotal = true; // Boolean | 

        try {
            VirtualTenantPagedResponse result = apiInstance.getVirtualTenants(apiVersion, pageNumber, pageSize, sort, sortOrder, fields, retrieveTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#getVirtualTenants");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
VirtualTenantsApi *apiInstance = [[VirtualTenantsApi alloc] init];
String *apiVersion = apiVersion_example; //  (default to null)
Integer *pageNumber = 56; //  (optional) (default to null)
Integer *pageSize = 56; //  (optional) (default to null)
String *sort = sort_example; //  (optional) (default to null)
String *sortOrder = sortOrder_example; //  (optional) (default to null)
array[String] *fields = ; //  (optional) (default to null)
Boolean *retrieveTotal = true; //  (optional) (default to null)

// Get a list of virtual tenants
[apiInstance getVirtualTenantsWith:apiVersion
    pageNumber:pageNumber
    pageSize:pageSize
    sort:sort
    sortOrder:sortOrder
    fields:fields
    retrieveTotal:retrieveTotal
              completionHandler: ^(VirtualTenantPagedResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DelegationApi = require('delegation_api');
var defaultClient = DelegationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new DelegationApi.VirtualTenantsApi()
var apiVersion = apiVersion_example; // {String} 
var opts = {
  'pageNumber': 56, // {Integer} 
  'pageSize': 56, // {Integer} 
  'sort': sort_example, // {String} 
  'sortOrder': sortOrder_example, // {String} 
  'fields': , // {array[String]} 
  'retrieveTotal': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVirtualTenants(apiVersion, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVirtualTenantsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VirtualTenantsApi();
            var apiVersion = apiVersion_example;  // String |  (default to null)
            var pageNumber = 56;  // Integer |  (optional)  (default to null)
            var pageSize = 56;  // Integer |  (optional)  (default to null)
            var sort = sort_example;  // String |  (optional)  (default to null)
            var sortOrder = sortOrder_example;  // String |  (optional)  (default to null)
            var fields = new array[String](); // array[String] |  (optional)  (default to null)
            var retrieveTotal = true;  // Boolean |  (optional)  (default to null)

            try {
                // Get a list of virtual tenants
                VirtualTenantPagedResponse result = apiInstance.getVirtualTenants(apiVersion, pageNumber, pageSize, sort, sortOrder, fields, retrieveTotal);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VirtualTenantsApi.getVirtualTenants: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VirtualTenantsApi();
$apiVersion = apiVersion_example; // String | 
$pageNumber = 56; // Integer | 
$pageSize = 56; // Integer | 
$sort = sort_example; // String | 
$sortOrder = sortOrder_example; // String | 
$fields = ; // array[String] | 
$retrieveTotal = true; // Boolean | 

try {
    $result = $api_instance->getVirtualTenants($apiVersion, $pageNumber, $pageSize, $sort, $sortOrder, $fields, $retrieveTotal);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VirtualTenantsApi->getVirtualTenants: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VirtualTenantsApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VirtualTenantsApi->new();
my $apiVersion = apiVersion_example; # String | 
my $pageNumber = 56; # Integer | 
my $pageSize = 56; # Integer | 
my $sort = sort_example; # String | 
my $sortOrder = sortOrder_example; # String | 
my $fields = []; # array[String] | 
my $retrieveTotal = true; # Boolean | 

eval {
    my $result = $api_instance->getVirtualTenants(apiVersion => $apiVersion, pageNumber => $pageNumber, pageSize => $pageSize, sort => $sort, sortOrder => $sortOrder, fields => $fields, retrieveTotal => $retrieveTotal);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VirtualTenantsApi->getVirtualTenants: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VirtualTenantsApi()
apiVersion = apiVersion_example # String |  (default to null)
pageNumber = 56 # Integer |  (optional) (default to null)
pageSize = 56 # Integer |  (optional) (default to null)
sort = sort_example # String |  (optional) (default to null)
sortOrder = sortOrder_example # String |  (optional) (default to null)
fields =  # array[String] |  (optional) (default to null)
retrieveTotal = true # Boolean |  (optional) (default to null)

try:
    # Get a list of virtual tenants
    api_response = api_instance.get_virtual_tenants(apiVersion, pageNumber=pageNumber, pageSize=pageSize, sort=sort, sortOrder=sortOrder, fields=fields, retrieveTotal=retrieveTotal)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualTenantsApi->getVirtualTenants: %s\n" % e)
extern crate VirtualTenantsApi;

pub fn main() {
    let apiVersion = apiVersion_example; // String
    let pageNumber = 56; // Integer
    let pageSize = 56; // Integer
    let sort = sort_example; // String
    let sortOrder = sortOrder_example; // String
    let fields = ; // array[String]
    let retrieveTotal = true; // Boolean

    let mut context = VirtualTenantsApi::Context::default();
    let result = client.getVirtualTenants(apiVersion, pageNumber, pageSize, sort, sortOrder, fields, retrieveTotal, &context).wait();

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

Scopes

delegation.read Read access to delegation resources

Parameters

Query parameters
Name Description
PageNumber
Integer (int32)
PageSize
Integer (int32)
Sort
String
SortOrder
String
Fields
array[String]
RetrieveTotal
Boolean
api-version*
String
Required

Responses

updateVirtualTenant

Replace a specific virtual tenant

Replaces an existing virtual tenant with the given id, using the VirtualTenant in the body.


/delegation/virtual-tenants/{id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://uknapiproxy.coreview.com/public/delegation/virtual-tenants/{id}?api-version=apiVersion_example" \
 -d '{
  "deviceFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "userFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "deviceSecurityGroups" : [ {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  }, {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  } ],
  "usersGroups" : [ {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  }, {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  } ],
  "distributionGroupDomainFilters" : [ "distributionGroupDomainFilters", "distributionGroupDomainFilters" ],
  "description" : "description",
  "operatorsGroups" : [ {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  }, {
    "name" : "name",
    "id" : "id",
    "type" : "DistributionGroup",
    "parentId" : "parentId"
  } ],
  "userDomainFilters" : [ "userDomainFilters", "userDomainFilters" ],
  "organizationalUnitFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "operators" : [ "operators", "operators" ],
  "name" : "name",
  "distributionGroupFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "id" : "id",
  "microsoft365GroupFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ],
  "securityGroupFilters" : [ {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  }, {
    "condition" : "condition",
    "name" : "name",
    "valueDate" : "valueDate",
    "value" : "value",
    "operation" : "operation"
  } ]
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VirtualTenantsApi;

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

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

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String id = id_example; // String | The unique identifier for the VirtualTenant.
        String apiVersion = apiVersion_example; // String | 
        VirtualTenant virtualTenant = ; // VirtualTenant | 

        try {
            NoContentResult result = apiInstance.updateVirtualTenant(id, apiVersion, virtualTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#updateVirtualTenant");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The unique identifier for the VirtualTenant.
final String apiVersion = new String(); // String | 
final VirtualTenant virtualTenant = new VirtualTenant(); // VirtualTenant | 

try {
    final result = await api_instance.updateVirtualTenant(id, apiVersion, virtualTenant);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateVirtualTenant: $e\n');
}


import org.openapitools.client.api.VirtualTenantsApi;

public class VirtualTenantsApiExample {
    public static void main(String[] args) {
        VirtualTenantsApi apiInstance = new VirtualTenantsApi();
        String id = id_example; // String | The unique identifier for the VirtualTenant.
        String apiVersion = apiVersion_example; // String | 
        VirtualTenant virtualTenant = ; // VirtualTenant | 

        try {
            NoContentResult result = apiInstance.updateVirtualTenant(id, apiVersion, virtualTenant);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualTenantsApi#updateVirtualTenant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
VirtualTenantsApi *apiInstance = [[VirtualTenantsApi alloc] init];
String *id = id_example; // The unique identifier for the VirtualTenant. (default to null)
String *apiVersion = apiVersion_example; //  (default to null)
VirtualTenant *virtualTenant = ; //  (optional)

// Replace a specific virtual tenant
[apiInstance updateVirtualTenantWith:id
    apiVersion:apiVersion
    virtualTenant:virtualTenant
              completionHandler: ^(NoContentResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DelegationApi = require('delegation_api');
var defaultClient = DelegationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new DelegationApi.VirtualTenantsApi()
var id = id_example; // {String} The unique identifier for the VirtualTenant.
var apiVersion = apiVersion_example; // {String} 
var opts = {
  'virtualTenant':  // {VirtualTenant} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateVirtualTenant(id, apiVersion, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateVirtualTenantExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VirtualTenantsApi();
            var id = id_example;  // String | The unique identifier for the VirtualTenant. (default to null)
            var apiVersion = apiVersion_example;  // String |  (default to null)
            var virtualTenant = new VirtualTenant(); // VirtualTenant |  (optional) 

            try {
                // Replace a specific virtual tenant
                NoContentResult result = apiInstance.updateVirtualTenant(id, apiVersion, virtualTenant);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VirtualTenantsApi.updateVirtualTenant: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VirtualTenantsApi();
$id = id_example; // String | The unique identifier for the VirtualTenant.
$apiVersion = apiVersion_example; // String | 
$virtualTenant = ; // VirtualTenant | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VirtualTenantsApi->new();
my $id = id_example; # String | The unique identifier for the VirtualTenant.
my $apiVersion = apiVersion_example; # String | 
my $virtualTenant = WWW::OPenAPIClient::Object::VirtualTenant->new(); # VirtualTenant | 

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

# Configure OAuth2 access token for authorization: oauth2
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VirtualTenantsApi()
id = id_example # String | The unique identifier for the VirtualTenant. (default to null)
apiVersion = apiVersion_example # String |  (default to null)
virtualTenant =  # VirtualTenant |  (optional)

try:
    # Replace a specific virtual tenant
    api_response = api_instance.update_virtual_tenant(id, apiVersion, virtualTenant=virtualTenant)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VirtualTenantsApi->updateVirtualTenant: %s\n" % e)
extern crate VirtualTenantsApi;

pub fn main() {
    let id = id_example; // String
    let apiVersion = apiVersion_example; // String
    let virtualTenant = ; // VirtualTenant

    let mut context = VirtualTenantsApi::Context::default();
    let result = client.updateVirtualTenant(id, apiVersion, virtualTenant, &context).wait();

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

Scopes

delegation.write Write access to delegation resources

Parameters

Path parameters
Name Description
id*
String
The unique identifier for the VirtualTenant.
Required
Body parameters
Name Description
virtualTenant

Query parameters
Name Description
api-version*
String
Required

Responses