Get a User by UPN (SAML)
{ getUserBySamlPrincipalName }
Get a user using the SAML Principal Name (UPN)
Method
/API2/access/getUserBySamlPrincipalName
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 SAML UPN, rather than the user's name or other details.
Examples
Create new SAML user (JavaScript):
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.