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
| Name | Description |
|---|---|
| principalUid* |
String
Principal identifier
Required
|
| 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
|