Create multiple users

This example demonstrates how to create a new tenant, user and roles in Pyramid, when using database 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":"adminUser1",
	"password":"abc123!"
},"",false);
log("got token "+token);

// step 2: create a new tenant to house new users
let createTenantResult = callApi("access/createTenant",{
	"name": "Test Tenant 1", //tenant caption
	"viewerSeats": 1, //number of allocated seats
	"proSeats": 1  //number of allocated seats
},token // admin token generated above
);

// step 3: get auto generated tenant ID from step 2 result.
let tenantId = createTenantResult.modifiedList[0].id;

log("created tenant, id= "+tenantId);


// step 4: create new user in new tenant. using DB method, because using local db authentication
let createUser = callApi("access/createUsers",[
	{
	"userName": "user1",
	"password": "1234",
	"firstName": "first",
	"lastName": "last",
	"email": "email@pyramidanalytics.com",
	"adminType": 0, //admin type enumeration: normal user
	"clientLicenseType": 100, //license type enumeration: viewer
	"tenantId": tenantId //tenant Id from previous step
}
],token // admin token generated above
);

// step 5: get auto generated user ID from step 4 result.
let userId = createUser.modifiedList[0].id;
log("created user "+userId);

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

//step 7: create new role in tenant
let createRole=callApi("access/createRole",{
	"roleName": "new role",
	"isHidden": false, // hidden roles appear only in the admin - not for end users.
	"tenantId": tenantId
},token);

// step 8: get auto generated role ID from step 7 result.
let roleId = createRole.modifiedList[0].id;
log("created role "+roleId);

// step 9: associate user with role
let addUserToRole = callApi("access/addUserToRole",{
	"userId": userId,
	"roleId": roleId
},token);

log("addUserToRole was successful since errorMessage is empty "+addUserToRole.errorMessage.length==0);


// ##### 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;
	}
}

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;
	}
}