List Users
Lists the users within a team on your Dropbox for Business instance.
Options
Field |
Definition |
Type |
Required |
---|---|---|---|
Include Removed? |
Specify if removed users should be included. |
Dropdown |
TRUE |
Result Set |
Specify how you want to have the results returned. Select either the First 200 Records or Stream Records. |
Dropdown |
TRUE |
To learn how to use the Stream Records option and set up a helper flow to return a large number of records, see Stream matching records with a helper flow.
Input
Field | Definition | Type | Required |
---|---|---|---|
Streaming |
|||
Flow |
Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow. This field displays when Stream Records is selected from the Result Set field. |
Flow |
TRUE |
List Criteria |
|||
Record Limit |
Specify the number of records to stream.
Appears when Stream Records is selected from the Result Set option. |
Number |
FALSE |
Output
Field | Definition | Type |
---|---|---|
Records Streamed |
Number of records streamed in a streaming flow. This field appears when you select Stream Records from the Result Set option. |
Number |
Users | This field appears when First 200 Records is selected from the Result Set field. | |
ID |
Unique identifier of the user. |
Text |
Account ID | Unique identifier for the account. |
Text |
External ID |
Unique external ID of the user. |
Text |
Email address of the user. |
Text |
|
Given Name |
First name of the user. |
Text |
Surname | Family name of the user. |
Text |
Familiar Name | Locale-dependent name. Possibilities include the Given Name, or a combination of the Given Name and the Surname. |
Text |
Display Name | A name used to represent the Dropbox for Business account of the user. |
Text |
Abbreviated Name | An abbreviated version of the user's name. For most locales, this is the user initials. |
Text |
Status |
The membership status for the user:
|
String |
Role |
The role the user has in the group:
|
Text |
Groups |
The groups that the user belongs to. |
Text |
Raw Output | Raw payload returned from the API. |
Object |