lookup_users
Search and filter users in your Sauce Labs organization by ID, username, team, role, or status to manage access and identify specific accounts.
Instructions
Queries the organization of the requesting account and returns the number of users matching the query and a basic
profile of each user, including the ID value, which may be a required parameter of other API calls related to a
specific user. You can narrow the results of your query using any of the following filtering parameters.
:param id: Optional. Comma-separated user IDs. Allows to receive details of multiple user at once. For example,
id=3d60780314724ab8ac688b50aadd9ff9,f9acc7c5b1da4fd0902b184c4f0b6324 would return details of users with IDs
included in the provided list.
:param username: Optional. Limits the results to usernames that begin with the specified value. For example,
username=an would return all users in the organization with usernames beginning with "an".
:param teams: Optional. Limit results to users who belong to the specified team_ids. Specify multiple teams as
comma-separated values.
:param roles: Optional. Limit results to users who are assigned certain roles. Valid values are: 1 - Organization Admin,
4 - Team Admin, 3 - Member. Specify multiple roles as comma-separated values.
:param phrase: Optional. Limit results to users whose first name, last name, or email address begins with the specified value.
:param status: Optional. Limit results to users of the specifid status. Valid values are: 'active', 'pending', 'inactive'
:param limit: Optional. Limit results to a maximum number per page. Default value is 20.
:param offset: Optional. The starting record number from which to return results.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| username | No | ||
| teams | No | ||
| roles | No | ||
| phrase | No | ||
| status | No | ||
| limit | No | ||
| offset | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | ||
| links | Yes | ||
| results | Yes |