Get a User by UPN

{ getUserByPrincipalName }

Get a user using the user's Principal Name (UPN)

Method

/API3/access/getUserByPrincipalName

  • API Section: /API3/access
  • API Version: 3.0
  • From Release: 2023.14
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
  • Input Parameters

    Name

    PrincipalName

    Type

    string

    Description

    The user's UPN

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    The user object contains all relevant meta-data for the user.

    Notes

    Use this function to find users in the system using the UPN, rather than the user's name or other details. Currently only supported in OpenID/SAML authentications.

    Examples

    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/getUserByPrincipalName" \
     -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 principalName parameter object for the call
            String principalName = principalName_example; // Create the input object for the operation, type: String 
    
            try {
                PyramidUserObject result = apiInstance.getUserByPrincipalName(principalName);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling AccessServiceApi#getUserByPrincipalName");
                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 principalName = principalName_example; // {String} 
    
    api.getUserByPrincipalName(principalName).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 getUserByPrincipalNameExample
    {
        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 principalName parameter object for the call
            var principalName = principalName_example;  // Create the input object for the operation, type: String | 
    
            try {
                // Get a user using the user's Principal Name (UPN)
                PyramidUserObject result = apiInstance.getUserByPrincipalName(principalName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccessServiceApi.getUserByPrincipalName: " + 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 principalName parameter object for the call
        principalName = principalName_example # String | 
    
        try:
            # Get a user using the user's Principal Name (UPN)
            api_response = api_instance.get_user_by_principal_name(principalName)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling AccessServiceApi->getUserByPrincipalName: %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();
    $principalName = principalName_example; // String | 
    
    try {
        $result = $api_instance->getUserByPrincipalName($principalName);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling AccessServiceApi->getUserByPrincipalName: ', $e->getMessage(), PHP_EOL;
    }
    ?>