Get a User by UPN
{ getUserByExternalId }
Get a user using the user's external identifier
Method
/API3/access/getUserByExternalId
- Enterprise Admin
- Domain Admin
Input Parameters
Name
externalId
Type
string
Description
The user's external identifier
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 UPN, rather than the user's name or other details. Currently only supported in OpenID/SAML 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