Add an Analyst User Profile

Adds a Analyst User Profile definition to the system.

Method

/API3/access/addAnalystProfile

  • 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

Method Signature

Input Parameters

Name

analystProfileApiData

Object Type

Description

An object that contains the profile definition for analyst users.

Output Response

Successful Result Code

200

Response Type

Description of Response Type

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

Notes

Analyst profiles are used to customize Analyst end-user access to application functionality. Profiles can be set for both roles and users. Note that certain switch combinations can be mutually exclusive.

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/addAnalystProfile" \
 -d '{
  "permissions" : {
    "permissionBitIndexList" : [ null, null ],
    "numeric" : 0
  },
  "profileId" : "profileId",
  "name" : "name",
  "tenantId" : "tenantId",
  "description" : "description"
}'
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 analystProfileApiData parameter object for the call
        AnalystProfileApiData analystProfileApiData = ; // Create the input object for the operation, type: AnalystProfileApiData 

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

api.addAnalystProfile(analystProfileApiData).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 addAnalystProfileExample
{
    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 analystProfileApiData parameter object for the call
        var analystProfileApiData = new AnalystProfileApiData(); // AnalystProfileApiData | 

        try {
            // Adds a Analyst User Profile  definition to the system.
            ModifiedItemsResult result = apiInstance.addAnalystProfile(analystProfileApiData);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AccessServiceApi.addAnalystProfile: " + 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 analystProfileApiData parameter object for the call
    analystProfileApiData =  # AnalystProfileApiData | 

    try:
        # Adds a Analyst User Profile  definition to the system.
        api_response = api_instance.add_analyst_profile(analystProfileApiData)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccessServiceApi->addAnalystProfile: %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();
$analystProfileApiData = ; // AnalystProfileApiData | 

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