Search User’s external groups

{ searchUserGroups }

Get a list of all a user's associated external groups

Method

/API3/access/searchUserGroups

  • 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

    searchData

    Object Type

    Description

    The object used to specify users in the external IDP.

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    External group object with details of the groups found in the search.. Note that the response is returned as a list of items of this object type.

    Notes

    Currently only supported in LDAP based 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/searchUserGroups" \
     -d '{
      "domainName" : "domainName",
      "username" : "username"
    }'
    
    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 searchData parameter object for the call
            ExternalUserIdentifier searchData = ; // Create the input object for the operation, type: ExternalUserIdentifier 
    
            try {
                // "array[ExternalGroupModel]" is only psaudo-code to symbolize list of type and not the actual usage 
                array[ExternalGroupModel] result = apiInstance.searchUserGroups(searchData);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling AccessServiceApi#searchUserGroups");
                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 searchData = ; // {ExternalUserIdentifier} 
    
    api.searchUserGroups(searchData).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 searchUserGroupsExample
    {
        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 searchData parameter object for the call
            var searchData = new ExternalUserIdentifier(); // ExternalUserIdentifier | 
    
            try {
                // Get a list of all a user's associated external groups
                // "array[ExternalGroupModel]" is only psaudo-code to symbolize array of type and not the actual usage 
                array[ExternalGroupModel] result = apiInstance.searchUserGroups(searchData);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccessServiceApi.searchUserGroups: " + 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 searchData parameter object for the call
        searchData =  # ExternalUserIdentifier | 
    
        try:
            # Get a list of all a user's associated external groups
            api_response = api_instance.search_user_groups(searchData)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling AccessServiceApi->searchUserGroups: %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();
    $searchData = ; // ExternalUserIdentifier | 
    
    try {
        $result = $api_instance->searchUserGroups($searchData);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling AccessServiceApi->searchUserGroups: ', $e->getMessage(), PHP_EOL;
    }
    ?>