You are here:

Delete a User

Removes a user from the system.

Method

/API3/access/deleteUser

API Section: /API3/access
API Version: 3.0
From Release: 2023.10
Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
Usage by:
- Enterprise Admin
- Domain Admin

Method Signature

Input Parameters

Name

userId

Type

string

Description

The system user ID

Output Response

Successful Result Code

200

Response Type

ModifiedItemsResult

Description of Response Type

Generic API response object with success or failure flag and related messages.

Notes

Removing users will place their private content into the recycle bin folder

Examples

User Operations (JavaScript):

This example demonstrates how to find and delete users, roles and tenants.

The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";

// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser1",
		"password":"abc123!"
},"",false);
log("got token "+token);

//########## user ################

//step 2: searching for a user by it's name
let findUser= callApi("access/getUsersByName", {
	"searchValue":"john"
	}, token // admin token generated above
);
				
// get user ID				
let userId=findUser[0].id;
				
log("found user with id= "+ userId);

//step 3: deleting the role
let deleteUser=callApi("access/deleteUser", userId, //from step 2
	token // admin token generated above
	);


//########## role ################

//step 4: searching for a role by it's name
let findRole= callApi("access/findRoles",{
	"searchValue": "test role",
	"searchMatchType": 2// search flag enumerations. 2 = SearchMatchType.Equals
},token);
// get role ID	
let roleId=findRole[0].roleId;
				
log("found role with id= "+ roleId);

//step 5: deleting the role
let deleteRole=callApi("access/deleteRole", roleId, // from step 4
	token);


//########## tenant ################

//step 6: search for tenant
let findTenenat=callApi("access/getTenantByName","Test Tenant 1",token);
// get tenant ID					
let tenantId=findTenenat.id;
				
log("found tenant by name "+ tenantId);

//step 7: delete the tenant we found in step 2
let deleteTenants=callApi("access/deleteTenants",{
	"tenantIds": [
		tenantId
	], // use the array method, because it can accept multiple ID's
	"deleteUsers": true, //delete all tenant users
	"deleteServers": true //delete all data source servers associated with tenant
},token);



// ##### optional generic logging method for debugging ##############
function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript

Curl

Java

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/deleteUser" \
 -d ''

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 userId parameter object for the call
        String userId = userId_example; // Create the input object for the operation, type: String 

        try {
            ModifiedItemsResult result = apiInstance.deleteUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessServiceApi#deleteUser");
            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 userId = userId_example; // {String} 

api.deleteUser(userId).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 deleteUserExample
{
    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 userId parameter object for the call
        var userId = userId_example;  // Create the input object for the operation, type: String | 

        try {
            // Removes a user from the system.
            ModifiedItemsResult result = apiInstance.deleteUser(userId);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AccessServiceApi.deleteUser: " + 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 userId parameter object for the call
    userId = userId_example # String | 

    try:
        # Removes a user from the system.
        api_response = api_instance.delete_user(userId)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccessServiceApi->deleteUser: %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();
$userId = userId_example; // String | 

try {
    $result = $api_instance->deleteUser($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessServiceApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>

Feedback

Couldn't find what I was looking for

Help was confusing, unclear or incomplete

Instructions didn't work