Update a User’s Roles
{ updateUserRoles }
Adds or deletes the roles assigned to the selected user.
Method
/API3/access/updateUserRoles
- Enterprise Admin
Input Parameters
Name
userRolesData
Object Type
Description
The user-role object contains a list of all roles to add or remove for the specified user.
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
Returns a generic response object with the list of all user's final role IDs. Note that the response is returned as a list of items of this object type.
Notes
Provide the list of roles to add and a list of roles to delete for the specified user.
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/access/updateUserRoles" \
-d '{
"rolesToRemove" : [ "rolesToRemove", "rolesToRemove" ],
"rolesToAdd" : [ "rolesToAdd", "rolesToAdd" ],
"userId" : "userId"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AccessServiceApi;
import java.util.*;
import java.time.*;
public class AccessServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
AccessServiceApi apiInstance = new AccessServiceApi();
// Initialize the userRolesData parameter object for the call
UserRolesData userRolesData = ; // Create the input object for the operation, type: UserRolesData
try {
// "array[ItemId]" is only psaudo-code to symbolize list of type and not the actual usage
array[ItemId] result = apiInstance.updateUserRoles(userRolesData);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessServiceApi#updateUserRoles");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AccessServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const userRolesData = ; // {UserRolesData}
api.updateUserRoles(userRolesData).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class updateUserRolesExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new AccessServiceApi();
// Initialize the userRolesData parameter object for the call
var userRolesData = new UserRolesData(); // UserRolesData |
try {
// Adds or deletes the roles assigned to the selected user.
// "array[ItemId]" is only psaudo-code to symbolize array of type and not the actual usage
array[ItemId] result = apiInstance.updateUserRoles(userRolesData);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling AccessServiceApi.updateUserRoles: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import AccessServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = AccessServiceApi(api_client)
# Initialize the userRolesData parameter object for the call
userRolesData = # UserRolesData |
try:
# Adds or deletes the roles assigned to the selected user.
api_response = api_instance.update_user_roles(userRolesData)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessServiceApi->updateUserRoles: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccessServiceApi();
$userRolesData = ; // UserRolesData |
try {
$result = $api_instance->updateUserRoles($userRolesData);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccessServiceApi->updateUserRoles: ', $e->getMessage(), PHP_EOL;
}
?>