Create a new user (SAML)
{ createUserSaml }
Adds a new user in the system for SAML Authentication.
Method
- Enterprise Admin
- Domain Admin
Input Parameters
Name
createUserSaml
Object Type
Description
The object used to create a new user when SAML authentication is used.
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
First create the User object with all its settings. Use other methods for alternative authentication providers
Examples
![Closed](../../../../../../../../Skins/Default/Stylesheets/Images/transparent.gif)
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/createUserSaml",{
"id":userId,//you can set the user id to a specific valid GUID/UUID. Otherwise a GUID will be auto generated
"userName": "jhon.doe",
"samlprincipleName":"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/updateUsersSaml",[{
"id":userId,
"firstName":"Paul"
}],token // admin token generated above
);
//step 4: find user by SAML principle name
let getByPrincipalName=callApi("access/getUserBySamlPrincipalName","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.
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/createUserSaml" \
-d '{
"lastName" : "lastName",
"proxyAccount" : "proxyAccount",
"principalName" : "principalName",
"userName" : "userName",
"firstName" : "firstName",
"password" : "password",
"roleIds" : [ "roleIds", "roleIds" ],
"privateProfileId" : "privateProfileId",
"phone" : "phone",
"tenantId" : "tenantId",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"proxy2" : "proxy2",
"email" : "email"
}'
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 createUserSaml parameter object for the call
CreateUserSamlObject createUserSaml = ; // Create the input object for the operation, type: CreateUserSamlObject
try {
ModifiedItemsResult result = apiInstance.createUserSaml(createUserSaml);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccessServiceApi#createUserSaml");
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 createUserSaml = ; // {CreateUserSamlObject}
api.createUserSaml(createUserSaml).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 createUserSamlExample
{
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 createUserSaml parameter object for the call
var createUserSaml = new CreateUserSamlObject(); // CreateUserSamlObject |
try {
// Adds a new user in the system for SAML Authentication.
ModifiedItemsResult result = apiInstance.createUserSaml(createUserSaml);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling AccessServiceApi.createUserSaml: " + 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 createUserSaml parameter object for the call
createUserSaml = # CreateUserSamlObject |
try:
# Adds a new user in the system for SAML Authentication.
api_response = api_instance.create_user_saml(createUserSaml)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessServiceApi->createUserSaml: %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();
$createUserSaml = ; // CreateUserSamlObject |
try {
$result = $api_instance->createUserSaml($createUserSaml);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccessServiceApi->createUserSaml: ', $e->getMessage(), PHP_EOL;
}
?>