You are here:

Get User's System Status by User ID

{ getUserStatusById }

Gets the user's status in the system.

Method

/API3/access/getUserStatusById

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

Input Parameters

Name

userId

Type

string

Description

The system user ID

Output Response

Successful Result Code

200

Response Type

string

Description of Response Type

Enabled/Disabled flag

Notes

Used with the 'toggleEnableUser' method.

Examples

Create new SAML user (JavaScript):

This example demonstrates how to create a new tenant, user and roles in Pyramid, when using SAML based authentication.

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":"adminUser",
	"password":"abc123!"
},false);
log("got token "+token);

// step 2: creating a SAML user
let userId="83e631f5-98ca-4424-a696-33e109690ffb"

let createSamlUsers = callApi("access/createUsers",[
	{
	"id":userId,//you can set the user id to a specific valid GUID/UUID. Otherwise a GUID will be auto generated
	"userName": "jhon.doe",
	"principalName":"user@samlDomain.com",//this is the SAML user ID provided by the saml provider
	"firstName": "john",
	"lastName":"doe",
	"adminType":0,//AdminType.None
	"clientLicenseType":100,//ClientLicenseType.Viewer
	"email":"user@mySite.com",
}
],token // admin token generated above
);

// step 3: optional step to update user's first name
let updateUser=callApi("access/updateUsers",[{
	"id":userId,
	"firstName":"Paul"
}],token // admin token generated above
);


//step 4: find user by SAML principle name
let getByPrincipalName=callApi("access/getUserByPrincipalName","user@samlDomain.com" //this is the SAML user ID provided by the saml provider
,toekn);

//step 5: get user status by id
let userStatus=callApi("access/getUserStatusById",userId,token);
log("user status "+userStatus);




// ##### 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/getUserStatusById" \
 -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 {
            String result = apiInstance.getUserStatusById(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessServiceApi#getUserStatusById");
            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.getUserStatusById(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 getUserStatusByIdExample
{
    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 {
            // Gets the user's status in the system.
            string result = apiInstance.getUserStatusById(userId);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AccessServiceApi.getUserStatusById: " + 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:
        # Gets the user's status in the system.
        api_response = api_instance.get_user_status_by_id(userId)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccessServiceApi->getUserStatusById: %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->getUserStatusById($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessServiceApi->getUserStatusById: ', $e->getMessage(), PHP_EOL;
}
?>

Feedback

Couldn't find what I was looking for

Help was confusing, unclear or incomplete

Instructions didn't work