Permission Webservices

Permissions

getAttributesPermissions

Get Attributes Permissions

Endpoint to retrieve attributes permissions for a principal. This will look in the principal hierarchy


/v1/permissions/principals/{principalUid}/attributes

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/principals/{principalUid}/attributes?attributes=&fields=&permissionNames=&requestWrapper="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

        PermissionsApi apiInstance = new PermissionsApi();
        String attributes = attributes_example; // String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String principalUid = principalUid_example; // String | Principal identifier
        AttributesPermissionsRequestWrapper requestWrapper = ; // AttributesPermissionsRequestWrapper | 
        String fields = fields_example; // String | Response configuration
        try {
            PermissionsList result = apiInstance.getAttributesPermissions(attributes, permissionNames, principalUid, requestWrapper, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getAttributesPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        String attributes = attributes_example; // String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String principalUid = principalUid_example; // String | Principal identifier
        AttributesPermissionsRequestWrapper requestWrapper = ; // AttributesPermissionsRequestWrapper | 
        String fields = fields_example; // String | Response configuration
        try {
            PermissionsList result = apiInstance.getAttributesPermissions(attributes, permissionNames, principalUid, requestWrapper, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getAttributesPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *attributes = attributes_example; // Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
String *permissionNames = permissionNames_example; // Permission names separated by comma
String *principalUid = principalUid_example; // Principal identifier
AttributesPermissionsRequestWrapper *requestWrapper = ; // 
String *fields = fields_example; // Response configuration (optional) (default to DEFAULT)

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

// Get Attributes Permissions
[apiInstance getAttributesPermissionsWith:attributes
    permissionNames:permissionNames
    principalUid:principalUid
    requestWrapper:requestWrapper
    fields:fields
              completionHandler: ^(PermissionsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var attributes = attributes_example; // {{String}} Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
var permissionNames = permissionNames_example; // {{String}} Permission names separated by comma
var principalUid = principalUid_example; // {{String}} Principal identifier
var requestWrapper = ; // {{AttributesPermissionsRequestWrapper}} 
var opts = { 
  'fields': fields_example // {{String}} Response configuration
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAttributesPermissions(attributes, permissionNames, principalUid, requestWrapper, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var attributes = attributes_example;  // String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
            var permissionNames = permissionNames_example;  // String | Permission names separated by comma
            var principalUid = principalUid_example;  // String | Principal identifier
            var requestWrapper = new AttributesPermissionsRequestWrapper(); // AttributesPermissionsRequestWrapper | 
            var fields = fields_example;  // String | Response configuration (optional)  (default to DEFAULT)

            try
            {
                // Get Attributes Permissions
                PermissionsList result = apiInstance.getAttributesPermissions(attributes, permissionNames, principalUid, requestWrapper, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.getAttributesPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$attributes = attributes_example; // String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
$permissionNames = permissionNames_example; // String | Permission names separated by comma
$principalUid = principalUid_example; // String | Principal identifier
$requestWrapper = ; // AttributesPermissionsRequestWrapper | 
$fields = fields_example; // String | Response configuration

try {
    $result = $api_instance->getAttributesPermissions($attributes, $permissionNames, $principalUid, $requestWrapper, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PermissionsApi->getAttributesPermissions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PermissionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermissionsApi->new();
my $attributes = attributes_example; # String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
my $permissionNames = permissionNames_example; # String | Permission names separated by comma
my $principalUid = principalUid_example; # String | Principal identifier
my $requestWrapper = ; # AttributesPermissionsRequestWrapper | 
my $fields = fields_example; # String | Response configuration

eval { 
    my $result = $api_instance->getAttributesPermissions(attributes => $attributes, permissionNames => $permissionNames, principalUid => $principalUid, requestWrapper => $requestWrapper, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PermissionsApi->getAttributesPermissions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermissionsApi()
attributes = attributes_example # String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
permissionNames = permissionNames_example # String | Permission names separated by comma
principalUid = principalUid_example # String | Principal identifier
requestWrapper =  # AttributesPermissionsRequestWrapper | 
fields = fields_example # String | Response configuration (optional) (default to DEFAULT)

try: 
    # Get Attributes Permissions
    api_response = api_instance.get_attributes_permissions(attributes, permissionNames, principalUid, requestWrapper, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->getAttributesPermissions: %s\n" % e)

Parameters

Path parameters
Name Description
principalUid*
String
Principal identifier
Required
Query parameters
Name Description
attributes*
String
Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
Required
fields
String
Response configuration
permissionNames*
String
Permission names separated by comma
Required
requestWrapper*
AttributesPermissionsRequestWrapper
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found


getCatalogPermissions

Get Catalog Permissions

Endpoint to retrieve catalog permissions for a principal. This will look in the principal hierarchy.


/v1/permissions/principals/{principalUid}/catalogs

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/principals/{principalUid}/catalogs?catalogId=&catalogVersion=&fields=&requestWrapper="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

        PermissionsApi apiInstance = new PermissionsApi();
        String catalogId = catalogId_example; // String | Catalog identifiers separated by comma
        String catalogVersion = catalogVersion_example; // String | Catalog version identifiers separated by comma
        String principalUid = principalUid_example; // String | Principal identifier
        CatalogPermissionsRequestWrapper requestWrapper = ; // CatalogPermissionsRequestWrapper | 
        String fields = fields_example; // String | Response configuration
        try {
            CatalogPermissionsList result = apiInstance.getCatalogPermissions(catalogId, catalogVersion, principalUid, requestWrapper, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getCatalogPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        String catalogId = catalogId_example; // String | Catalog identifiers separated by comma
        String catalogVersion = catalogVersion_example; // String | Catalog version identifiers separated by comma
        String principalUid = principalUid_example; // String | Principal identifier
        CatalogPermissionsRequestWrapper requestWrapper = ; // CatalogPermissionsRequestWrapper | 
        String fields = fields_example; // String | Response configuration
        try {
            CatalogPermissionsList result = apiInstance.getCatalogPermissions(catalogId, catalogVersion, principalUid, requestWrapper, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getCatalogPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *catalogId = catalogId_example; // Catalog identifiers separated by comma
String *catalogVersion = catalogVersion_example; // Catalog version identifiers separated by comma
String *principalUid = principalUid_example; // Principal identifier
CatalogPermissionsRequestWrapper *requestWrapper = ; // 
String *fields = fields_example; // Response configuration (optional) (default to DEFAULT)

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

// Get Catalog Permissions
[apiInstance getCatalogPermissionsWith:catalogId
    catalogVersion:catalogVersion
    principalUid:principalUid
    requestWrapper:requestWrapper
    fields:fields
              completionHandler: ^(CatalogPermissionsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var catalogId = catalogId_example; // {{String}} Catalog identifiers separated by comma
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifiers separated by comma
var principalUid = principalUid_example; // {{String}} Principal identifier
var requestWrapper = ; // {{CatalogPermissionsRequestWrapper}} 
var opts = { 
  'fields': fields_example // {{String}} Response configuration
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCatalogPermissions(catalogId, catalogVersion, principalUid, requestWrapper, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var catalogId = catalogId_example;  // String | Catalog identifiers separated by comma
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifiers separated by comma
            var principalUid = principalUid_example;  // String | Principal identifier
            var requestWrapper = new CatalogPermissionsRequestWrapper(); // CatalogPermissionsRequestWrapper | 
            var fields = fields_example;  // String | Response configuration (optional)  (default to DEFAULT)

            try
            {
                // Get Catalog Permissions
                CatalogPermissionsList result = apiInstance.getCatalogPermissions(catalogId, catalogVersion, principalUid, requestWrapper, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.getCatalogPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$catalogId = catalogId_example; // String | Catalog identifiers separated by comma
$catalogVersion = catalogVersion_example; // String | Catalog version identifiers separated by comma
$principalUid = principalUid_example; // String | Principal identifier
$requestWrapper = ; // CatalogPermissionsRequestWrapper | 
$fields = fields_example; // String | Response configuration

try {
    $result = $api_instance->getCatalogPermissions($catalogId, $catalogVersion, $principalUid, $requestWrapper, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PermissionsApi->getCatalogPermissions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PermissionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermissionsApi->new();
my $catalogId = catalogId_example; # String | Catalog identifiers separated by comma
my $catalogVersion = catalogVersion_example; # String | Catalog version identifiers separated by comma
my $principalUid = principalUid_example; # String | Principal identifier
my $requestWrapper = ; # CatalogPermissionsRequestWrapper | 
my $fields = fields_example; # String | Response configuration

eval { 
    my $result = $api_instance->getCatalogPermissions(catalogId => $catalogId, catalogVersion => $catalogVersion, principalUid => $principalUid, requestWrapper => $requestWrapper, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PermissionsApi->getCatalogPermissions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermissionsApi()
catalogId = catalogId_example # String | Catalog identifiers separated by comma
catalogVersion = catalogVersion_example # String | Catalog version identifiers separated by comma
principalUid = principalUid_example # String | Principal identifier
requestWrapper =  # CatalogPermissionsRequestWrapper | 
fields = fields_example # String | Response configuration (optional) (default to DEFAULT)

try: 
    # Get Catalog Permissions
    api_response = api_instance.get_catalog_permissions(catalogId, catalogVersion, principalUid, requestWrapper, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->getCatalogPermissions: %s\n" % e)

Parameters

Path parameters
Name Description
principalUid*
String
Principal identifier
Required
Query parameters
Name Description
catalogId*
String
Catalog identifiers separated by comma
Required
catalogVersion*
String
Catalog version identifiers separated by comma
Required
fields
String
Response configuration
requestWrapper*
CatalogPermissionsRequestWrapper
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found


getGlobalPermissions

Get Global Permissions

Endpoint to retrieve global permissions for a principal. This will look in the principal hierarchy


/v1/permissions/principals/{principalUid}/global

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/principals/{principalUid}/global?fields=&permissionNames="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

        PermissionsApi apiInstance = new PermissionsApi();
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String principalUid = principalUid_example; // String | Principal identifier
        String fields = fields_example; // String | Response configuration
        try {
            Permissions result = apiInstance.getGlobalPermissions(permissionNames, principalUid, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getGlobalPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String principalUid = principalUid_example; // String | Principal identifier
        String fields = fields_example; // String | Response configuration
        try {
            Permissions result = apiInstance.getGlobalPermissions(permissionNames, principalUid, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getGlobalPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *permissionNames = permissionNames_example; // Permission names separated by comma
String *principalUid = principalUid_example; // Principal identifier
String *fields = fields_example; // Response configuration (optional) (default to DEFAULT)

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

// Get Global Permissions
[apiInstance getGlobalPermissionsWith:permissionNames
    principalUid:principalUid
    fields:fields
              completionHandler: ^(Permissions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var permissionNames = permissionNames_example; // {{String}} Permission names separated by comma
var principalUid = principalUid_example; // {{String}} Principal identifier
var opts = { 
  'fields': fields_example // {{String}} Response configuration
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGlobalPermissions(permissionNames, principalUid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var permissionNames = permissionNames_example;  // String | Permission names separated by comma
            var principalUid = principalUid_example;  // String | Principal identifier
            var fields = fields_example;  // String | Response configuration (optional)  (default to DEFAULT)

            try
            {
                // Get Global Permissions
                Permissions result = apiInstance.getGlobalPermissions(permissionNames, principalUid, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.getGlobalPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$permissionNames = permissionNames_example; // String | Permission names separated by comma
$principalUid = principalUid_example; // String | Principal identifier
$fields = fields_example; // String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermissionsApi->new();
my $permissionNames = permissionNames_example; # String | Permission names separated by comma
my $principalUid = principalUid_example; # String | Principal identifier
my $fields = fields_example; # String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermissionsApi()
permissionNames = permissionNames_example # String | Permission names separated by comma
principalUid = principalUid_example # String | Principal identifier
fields = fields_example # String | Response configuration (optional) (default to DEFAULT)

try: 
    # Get Global Permissions
    api_response = api_instance.get_global_permissions(permissionNames, principalUid, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->getGlobalPermissions: %s\n" % e)

Parameters

Path parameters
Name Description
principalUid*
String
Principal identifier
Required
Query parameters
Name Description
fields
String
Response configuration
permissionNames*
String
Permission names separated by comma
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found


getTypesPermissions

Get Types Permissions

Endpoint to retrieve types permissions for a principal. This will look in the principal hierarchy


/v1/permissions/principals/{principalUid}/types

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/principals/{principalUid}/types?fields=&permissionNames=&types="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

        PermissionsApi apiInstance = new PermissionsApi();
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String principalUid = principalUid_example; // String | Principal identifier
        String types = types_example; // String | Type names separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            PermissionsList result = apiInstance.getTypesPermissions(permissionNames, principalUid, types, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getTypesPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String principalUid = principalUid_example; // String | Principal identifier
        String types = types_example; // String | Type names separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            PermissionsList result = apiInstance.getTypesPermissions(permissionNames, principalUid, types, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#getTypesPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *permissionNames = permissionNames_example; // Permission names separated by comma
String *principalUid = principalUid_example; // Principal identifier
String *types = types_example; // Type names separated by comma
String *fields = fields_example; // Response configuration (optional) (default to DEFAULT)

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

// Get Types Permissions
[apiInstance getTypesPermissionsWith:permissionNames
    principalUid:principalUid
    types:types
    fields:fields
              completionHandler: ^(PermissionsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var permissionNames = permissionNames_example; // {{String}} Permission names separated by comma
var principalUid = principalUid_example; // {{String}} Principal identifier
var types = types_example; // {{String}} Type names separated by comma
var opts = { 
  'fields': fields_example // {{String}} Response configuration
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTypesPermissions(permissionNames, principalUid, types, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var permissionNames = permissionNames_example;  // String | Permission names separated by comma
            var principalUid = principalUid_example;  // String | Principal identifier
            var types = types_example;  // String | Type names separated by comma
            var fields = fields_example;  // String | Response configuration (optional)  (default to DEFAULT)

            try
            {
                // Get Types Permissions
                PermissionsList result = apiInstance.getTypesPermissions(permissionNames, principalUid, types, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.getTypesPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$permissionNames = permissionNames_example; // String | Permission names separated by comma
$principalUid = principalUid_example; // String | Principal identifier
$types = types_example; // String | Type names separated by comma
$fields = fields_example; // String | Response configuration

try {
    $result = $api_instance->getTypesPermissions($permissionNames, $principalUid, $types, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PermissionsApi->getTypesPermissions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PermissionsApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermissionsApi->new();
my $permissionNames = permissionNames_example; # String | Permission names separated by comma
my $principalUid = principalUid_example; # String | Principal identifier
my $types = types_example; # String | Type names separated by comma
my $fields = fields_example; # String | Response configuration

eval { 
    my $result = $api_instance->getTypesPermissions(permissionNames => $permissionNames, principalUid => $principalUid, types => $types, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PermissionsApi->getTypesPermissions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermissionsApi()
permissionNames = permissionNames_example # String | Permission names separated by comma
principalUid = principalUid_example # String | Principal identifier
types = types_example # String | Type names separated by comma
fields = fields_example # String | Response configuration (optional) (default to DEFAULT)

try: 
    # Get Types Permissions
    api_response = api_instance.get_types_permissions(permissionNames, principalUid, types, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->getTypesPermissions: %s\n" % e)

Parameters

Path parameters
Name Description
principalUid*
String
Principal identifier
Required
Query parameters
Name Description
fields
String
Response configuration
permissionNames*
String
Permission names separated by comma
Required
types*
String
Type names separated by comma
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found


replaceTypePermissions

Insert or Update Type Permissions

Endpoint to insert or update permissions of one or more types for a principal.


/v1/permissions/types

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

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

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        TypePermissionsList body = ; // TypePermissionsList | 
        try {
            TypePermissionsList result = apiInstance.replaceTypePermissions(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#replaceTypePermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
TypePermissionsList *body = ; // 

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

// Insert or Update Type Permissions
[apiInstance replaceTypePermissionsWith:body
              completionHandler: ^(TypePermissionsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var body = ; // {{TypePermissionsList}} 

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var body = new TypePermissionsList(); // TypePermissionsList | 

            try
            {
                // Insert or Update Type Permissions
                TypePermissionsList result = apiInstance.replaceTypePermissions(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.replaceTypePermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$body = ; // TypePermissionsList | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

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

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

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

try: 
    # Insert or Update Type Permissions
    api_response = api_instance.replace_type_permissions(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->replaceTypePermissions: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found


searchAttributesPermissions

Search Attributes Permissions

Endpoint to retrieve attributes permissions for a principal. This will look in the principal hierarchy


/v1/permissions/attributes/search

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/attributes/search?attributes=&fields=&permissionNames="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

        PermissionsApi apiInstance = new PermissionsApi();
        Attributes_search_body body = ; // Attributes_search_body | 
        String attributes = attributes_example; // String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            PermissionsList result = apiInstance.searchAttributesPermissions(body, attributes, permissionNames, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#searchAttributesPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        Attributes_search_body body = ; // Attributes_search_body | 
        String attributes = attributes_example; // String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            PermissionsList result = apiInstance.searchAttributesPermissions(body, attributes, permissionNames, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#searchAttributesPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Attributes_search_body *body = ; // 
String *attributes = attributes_example; // Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
String *permissionNames = permissionNames_example; // Permission names separated by comma
String *fields = fields_example; // Response configuration (optional) (default to DEFAULT)

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

// Search Attributes Permissions
[apiInstance searchAttributesPermissionsWith:body
    attributes:attributes
    permissionNames:permissionNames
    fields:fields
              completionHandler: ^(PermissionsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var body = ; // {{Attributes_search_body}} 
var attributes = attributes_example; // {{String}} Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
var permissionNames = permissionNames_example; // {{String}} Permission names separated by comma
var opts = { 
  'fields': fields_example // {{String}} Response configuration
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchAttributesPermissions(bodyattributespermissionNames, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var body = new Attributes_search_body(); // Attributes_search_body | 
            var attributes = attributes_example;  // String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
            var permissionNames = permissionNames_example;  // String | Permission names separated by comma
            var fields = fields_example;  // String | Response configuration (optional)  (default to DEFAULT)

            try
            {
                // Search Attributes Permissions
                PermissionsList result = apiInstance.searchAttributesPermissions(body, attributes, permissionNames, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.searchAttributesPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$body = ; // Attributes_search_body | 
$attributes = attributes_example; // String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
$permissionNames = permissionNames_example; // String | Permission names separated by comma
$fields = fields_example; // String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermissionsApi->new();
my $body = WWW::SwaggerClient::Object::Attributes_search_body->new(); # Attributes_search_body | 
my $attributes = attributes_example; # String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
my $permissionNames = permissionNames_example; # String | Permission names separated by comma
my $fields = fields_example; # String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermissionsApi()
body =  # Attributes_search_body | 
attributes = attributes_example # String | Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
permissionNames = permissionNames_example # String | Permission names separated by comma
fields = fields_example # String | Response configuration (optional) (default to DEFAULT)

try: 
    # Search Attributes Permissions
    api_response = api_instance.search_attributes_permissions(body, attributes, permissionNames, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->searchAttributesPermissions: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
attributes*
String
Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)
Required
fields
String
Response configuration
permissionNames*
String
Permission names separated by comma
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found


searchCatalogPermissions

Search Catalog Permissions

Endpoint to retrieve catalog permissions for a principal. This will look in the principal hierarchy.


/v1/permissions/catalogs/search

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/catalogs/search?catalogId=&catalogVersion=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

        PermissionsApi apiInstance = new PermissionsApi();
        Catalogs_search_body body = ; // Catalogs_search_body | 
        String catalogId = catalogId_example; // String | Catalog identifiers separated by comma
        String catalogVersion = catalogVersion_example; // String | Catalog version identifiers separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            CatalogPermissionsList result = apiInstance.searchCatalogPermissions(body, catalogId, catalogVersion, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#searchCatalogPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        Catalogs_search_body body = ; // Catalogs_search_body | 
        String catalogId = catalogId_example; // String | Catalog identifiers separated by comma
        String catalogVersion = catalogVersion_example; // String | Catalog version identifiers separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            CatalogPermissionsList result = apiInstance.searchCatalogPermissions(body, catalogId, catalogVersion, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#searchCatalogPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Catalogs_search_body *body = ; // 
String *catalogId = catalogId_example; // Catalog identifiers separated by comma
String *catalogVersion = catalogVersion_example; // Catalog version identifiers separated by comma
String *fields = fields_example; // Response configuration (optional) (default to DEFAULT)

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

// Search Catalog Permissions
[apiInstance searchCatalogPermissionsWith:body
    catalogId:catalogId
    catalogVersion:catalogVersion
    fields:fields
              completionHandler: ^(CatalogPermissionsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var body = ; // {{Catalogs_search_body}} 
var catalogId = catalogId_example; // {{String}} Catalog identifiers separated by comma
var catalogVersion = catalogVersion_example; // {{String}} Catalog version identifiers separated by comma
var opts = { 
  'fields': fields_example // {{String}} Response configuration
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchCatalogPermissions(bodycatalogIdcatalogVersion, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var body = new Catalogs_search_body(); // Catalogs_search_body | 
            var catalogId = catalogId_example;  // String | Catalog identifiers separated by comma
            var catalogVersion = catalogVersion_example;  // String | Catalog version identifiers separated by comma
            var fields = fields_example;  // String | Response configuration (optional)  (default to DEFAULT)

            try
            {
                // Search Catalog Permissions
                CatalogPermissionsList result = apiInstance.searchCatalogPermissions(body, catalogId, catalogVersion, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.searchCatalogPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$body = ; // Catalogs_search_body | 
$catalogId = catalogId_example; // String | Catalog identifiers separated by comma
$catalogVersion = catalogVersion_example; // String | Catalog version identifiers separated by comma
$fields = fields_example; // String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermissionsApi->new();
my $body = WWW::SwaggerClient::Object::Catalogs_search_body->new(); # Catalogs_search_body | 
my $catalogId = catalogId_example; # String | Catalog identifiers separated by comma
my $catalogVersion = catalogVersion_example; # String | Catalog version identifiers separated by comma
my $fields = fields_example; # String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermissionsApi()
body =  # Catalogs_search_body | 
catalogId = catalogId_example # String | Catalog identifiers separated by comma
catalogVersion = catalogVersion_example # String | Catalog version identifiers separated by comma
fields = fields_example # String | Response configuration (optional) (default to DEFAULT)

try: 
    # Search Catalog Permissions
    api_response = api_instance.search_catalog_permissions(body, catalogId, catalogVersion, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->searchCatalogPermissions: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
catalogId*
String
Catalog identifiers separated by comma
Required
catalogVersion*
String
Catalog version identifiers separated by comma
Required
fields
String
Response configuration

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found


searchGlobalPermissions

Search Global Permissions

Endpoint to retrieve global permissions for a principal. This will look in the principal hierarchy


/v1/permissions/global/search

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/global/search?fields=&permissionNames="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

        PermissionsApi apiInstance = new PermissionsApi();
        PermissionsPrincipal body = ; // PermissionsPrincipal | 
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            Permissions result = apiInstance.searchGlobalPermissions(body, permissionNames, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#searchGlobalPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        PermissionsPrincipal body = ; // PermissionsPrincipal | 
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            Permissions result = apiInstance.searchGlobalPermissions(body, permissionNames, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#searchGlobalPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PermissionsPrincipal *body = ; // 
String *permissionNames = permissionNames_example; // Permission names separated by comma
String *fields = fields_example; // Response configuration (optional) (default to DEFAULT)

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

// Search Global Permissions
[apiInstance searchGlobalPermissionsWith:body
    permissionNames:permissionNames
    fields:fields
              completionHandler: ^(Permissions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var body = ; // {{PermissionsPrincipal}} 
var permissionNames = permissionNames_example; // {{String}} Permission names separated by comma
var opts = { 
  'fields': fields_example // {{String}} Response configuration
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchGlobalPermissions(bodypermissionNames, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var body = new PermissionsPrincipal(); // PermissionsPrincipal | 
            var permissionNames = permissionNames_example;  // String | Permission names separated by comma
            var fields = fields_example;  // String | Response configuration (optional)  (default to DEFAULT)

            try
            {
                // Search Global Permissions
                Permissions result = apiInstance.searchGlobalPermissions(body, permissionNames, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.searchGlobalPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$body = ; // PermissionsPrincipal | 
$permissionNames = permissionNames_example; // String | Permission names separated by comma
$fields = fields_example; // String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermissionsApi->new();
my $body = WWW::SwaggerClient::Object::PermissionsPrincipal->new(); # PermissionsPrincipal | 
my $permissionNames = permissionNames_example; # String | Permission names separated by comma
my $fields = fields_example; # String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermissionsApi()
body =  # PermissionsPrincipal | 
permissionNames = permissionNames_example # String | Permission names separated by comma
fields = fields_example # String | Response configuration (optional) (default to DEFAULT)

try: 
    # Search Global Permissions
    api_response = api_instance.search_global_permissions(body, permissionNames, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->searchGlobalPermissions: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration
permissionNames*
String
Permission names separated by comma
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found


searchTypesPermissions

Search Types Permissions

Endpoint to retrieve types permissions for a principal. This will look in the principal hierarchy


/v1/permissions/types/search

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/permissionswebservices/v1/permissions/types/search?fields=&permissionNames=&types="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermissionsApi;

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

public class PermissionsApiExample {

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

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

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

        PermissionsApi apiInstance = new PermissionsApi();
        PermissionsPrincipal body = ; // PermissionsPrincipal | 
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String types = types_example; // String | Type names separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            PermissionsList result = apiInstance.searchTypesPermissions(body, permissionNames, types, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#searchTypesPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermissionsApi;

public class PermissionsApiExample {

    public static void main(String[] args) {
        PermissionsApi apiInstance = new PermissionsApi();
        PermissionsPrincipal body = ; // PermissionsPrincipal | 
        String permissionNames = permissionNames_example; // String | Permission names separated by comma
        String types = types_example; // String | Type names separated by comma
        String fields = fields_example; // String | Response configuration
        try {
            PermissionsList result = apiInstance.searchTypesPermissions(body, permissionNames, types, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermissionsApi#searchTypesPermissions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PermissionsPrincipal *body = ; // 
String *permissionNames = permissionNames_example; // Permission names separated by comma
String *types = types_example; // Type names separated by comma
String *fields = fields_example; // Response configuration (optional) (default to DEFAULT)

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

// Search Types Permissions
[apiInstance searchTypesPermissionsWith:body
    permissionNames:permissionNames
    types:types
    fields:fields
              completionHandler: ^(PermissionsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PermissionWebservices = require('permission_webservices');
var defaultClient = PermissionWebservices.ApiClient.instance;

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

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

var api = new PermissionWebservices.PermissionsApi()
var body = ; // {{PermissionsPrincipal}} 
var permissionNames = permissionNames_example; // {{String}} Permission names separated by comma
var types = types_example; // {{String}} Type names separated by comma
var opts = { 
  'fields': fields_example // {{String}} Response configuration
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchTypesPermissions(bodypermissionNamestypes, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermissionsApi();
            var body = new PermissionsPrincipal(); // PermissionsPrincipal | 
            var permissionNames = permissionNames_example;  // String | Permission names separated by comma
            var types = types_example;  // String | Type names separated by comma
            var fields = fields_example;  // String | Response configuration (optional)  (default to DEFAULT)

            try
            {
                // Search Types Permissions
                PermissionsList result = apiInstance.searchTypesPermissions(body, permissionNames, types, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermissionsApi.searchTypesPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPermissionsApi();
$body = ; // PermissionsPrincipal | 
$permissionNames = permissionNames_example; // String | Permission names separated by comma
$types = types_example; // String | Type names separated by comma
$fields = fields_example; // String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermissionsApi->new();
my $body = WWW::SwaggerClient::Object::PermissionsPrincipal->new(); # PermissionsPrincipal | 
my $permissionNames = permissionNames_example; # String | Permission names separated by comma
my $types = types_example; # String | Type names separated by comma
my $fields = fields_example; # String | Response configuration

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermissionsApi()
body =  # PermissionsPrincipal | 
permissionNames = permissionNames_example # String | Permission names separated by comma
types = types_example # String | Type names separated by comma
fields = fields_example # String | Response configuration (optional) (default to DEFAULT)

try: 
    # Search Types Permissions
    api_response = api_instance.search_types_permissions(body, permissionNames, types, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermissionsApi->searchTypesPermissions: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
fields
String
Response configuration
permissionNames*
String
Permission names separated by comma
Required
types*
String
Type names separated by comma
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request e.g. incorrect parameter value

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this endpoint or no access to principal's permissions

Status: 404 - Not Found