Article Content
| Overview |
| User Account Requirements |
| Related Information/Setup |
| Retrieving a User ID from the User Management screen |
| Retrieving a User ID from Swagger |
Overview
The user ID is a unique identifier that is generated when a new user is created. The user ID is used when resetting multi-factor authentication (MFA) for an individual user, creating API keys, and generating SCIM tokens.
User Account Requirements
To retrieve the user ID from the User Management screen, users must have Administrator permissions or User Management advanced permissions. To retrieve the user ID from Swagger, users must have Administrator permissions.
Related Information/Setup
Please refer to the following articles for further information on using user IDs:
Retrieving a User ID from the User Management screen
- From the Home screen, click the Administration icon.
Administration Icon
- From the Administrator Settings menu, click the User Management link.
User Management Link
- From the User Management screen, click the name of the user that you want to retrieve the user ID for.
- On the User Management: Edit User screen, from the URL, copy the number (the user ID) after userManagement/ and before /edit.
User ID
Retrieving a User ID from Swagger
- From the Home screen, click the Administration icon.
Administration Icon
- From the Administrator settings menu, click the Admin Overview link.
Admin Overview Link
- From the Admin Overview screen, click the Swagger Docs tile in the Tools section.
Swagger Docs Tile
- From the Admin: Help screen, enter the keyword user in the search text box, then click the user topic from the results.
User Topic
- Click the GET /user/users endpoint to open the parameters.
API Endpoint
- In the search field, enter the user’s email address.
Search Field
- Click the Execute button.
Execute Button
- In the Response Body section, locate the user ID next to “id:”
User ID