Get a User by UserName
{ getUsersByName }
Returns a list of users based on search criteria
Method
- Enterprise Admin
Input Parameters
Name
searchCriteria
Object Type
Description
The search criteria for finding materialized data elements.
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
User response object with details of the user found in the system.. Note that the response is returned as a list of items of this object type.
Notes
The user object can be used in other operations where it is required, the returned user object does not contain user roles use getUser API to get full data.
Examples
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;
}
}
This example demonstrates how to authenticate users for the main application.
import com.sun.net.httpserver.HttpExchange;
import com.sun.net.httpserver.HttpHandler;
import com.sun.net.httpserver.HttpServer;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.BasicResponseHandler;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.json.simple.JSONObject;
import java.io.IOException;
import java.net.InetSocketAddress;
public class Main {
private static final String pyramidPath = "http://mySite.com/API3/";
public static void main(String[] args) throws IOException {
HttpServer server = HttpServer.create(new InetSocketAddress(8000), 0);
server.createContext("/login", new LoginHandler());
server.setExecutor(null); // creates a default executor
server.start();
}
private static class LoginHandler implements HttpHandler {
@Override
public void handle(HttpExchange httpExchange) throws IOException {
//logging the user
JSONObject adminCredentials = new JSONObject();
adminCredentials.put("userName", "testUser1");
adminCredentials.put("password", "abc456!");
String adminToken = getToken("authenticateUser", adminCredentials);
//logging the user in using the admin's token
JSONObject userCredentials = new JSONObject();
userCredentials.put("userIdentity", "test.user1@mySite.com");
userCredentials.put("token", adminToken);
String userToken = getToken("authenticateUserByToken", userCredentials);
//searching the user by name
JSONObject results = callApi("access/getUsersByName", "testUser1", adminToken);
String userId = ((JSONObject) ((JSONArray) results.get("data")).get(0)).get("id").toString();
//reading the user's private folder
JSONObject privateFolder = callApi("content/getFolderItems",
userId,//the user private folder id is the same as the user id
adminToken
);
String messageStr = "private folder id is " + userId + " and it contains ";
JSONArray folderContent = ((JSONArray) privateFolder.get("data"));
for (int i = 0; i < folderContent.size(); ++i) {
messageStr += ((JSONObject) folderContent.get(i)).get("caption") + ",";
}
byte[] message = messageStr.getBytes(StandardCharsets.UTF_8);
httpExchange.getResponseHeaders().add("Set-Cookie", "PyramidAuth=" + userToken);
httpExchange.sendResponseHeaders(200, message.length);
httpExchange.getResponseBody().write(message);
}
}
protected static String getToken(String service, JSONObject data) throws IOException {
return sendPost("authentication/" + service, data.toJSONString(),null);
}
protected static String sendPost(String path, String data, String token) throws IOException {
try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
String address = pyramidPath + path;
HttpPost request = new HttpPost(address);
StringEntity params = new StringEntity(data);
request.addHeader("content-type", "application/x-www-form-urlencoded");
if (token !=null) {
request.addHeader("paToken", token);
}
request.setEntity(params);
CloseableHttpResponse response = httpClient.execute(request);
return new BasicResponseHandler().handleResponse(response);
}
}
}
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
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/getUsersByName" \
-d '{
"searchValue" : "searchValue"
}'
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 searchCriteria parameter object for the call
SearchCriteria searchCriteria = ; // Create the input object for the operation, type: SearchCriteria
try {
// "array[PyramidUserObject]" is only psaudo-code to symbolize list of type and not the actual usage
array[PyramidUserObject] result = apiInstance.getUsersByName(searchCriteria);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessServiceApi#getUsersByName");
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 searchCriteria = ; // {SearchCriteria}
api.getUsersByName(searchCriteria).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 getUsersByNameExample
{
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 searchCriteria parameter object for the call
var searchCriteria = new SearchCriteria(); // SearchCriteria |
try {
// Returns a list of users based on search criteria
// "array[PyramidUserObject]" is only psaudo-code to symbolize array of type and not the actual usage
array[PyramidUserObject] result = apiInstance.getUsersByName(searchCriteria);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling AccessServiceApi.getUsersByName: " + 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 searchCriteria parameter object for the call
searchCriteria = # SearchCriteria |
try:
# Returns a list of users based on search criteria
api_response = api_instance.get_users_by_name(searchCriteria)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessServiceApi->getUsersByName: %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();
$searchCriteria = ; // SearchCriteria |
try {
$result = $api_instance->getUsersByName($searchCriteria);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccessServiceApi->getUsersByName: ', $e->getMessage(), PHP_EOL;
}
?>