Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method.


You will need authorization for the scope to make a valid call.

If unset, the scope for this method defaults to You can set the scope for this method like this: displayvideo1 --scope <scope> users list ...

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p filter=string

    • Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator AND. * A restriction has the form of {field} {operator} {value}. * The budget.budget_segments.date_range.end_date field must use the LESS THAN (&lt;) operator. * The displayName andemailfield must use theHAS (:)operator. * All other fields must use theEQUALS (=)operator. Supported fields: *assignedUserRole.advertiserId*assignedUserRole.entityType* This is synthetic field ofAssignedUserRoleused for filtering. Identifies the type of entity to which the user role is assigned. Valid values arePartnerandAdvertiser. *assignedUserRole.parentPartnerId* This is a synthetic field ofAssignedUserRoleused for filtering. Identifies the parent partner of the entity to which the user role is assigned. *assignedUserRole.partnerId*assignedUserRole.userRole*displayName*emailExamples: * The user withdisplayNamecontaining &#34;foo&#34;:displayName:"foo"* The user withemailcontaining &#34;bar&#34;:email:"bar"* All users with standard user roles:assignedUserRole.userRole="STANDARD"* All users with user roles for partner 123:assignedUserRole.partnerId="123"* All users with user roles for advertiser 123:assignedUserRole.advertiserId="123"* All users with partner level user roles:entityType="PARTNER"* All users with user roles for partner 123 and advertisers under partner 123:parentPartnerId="123"The length of this field should be no more than 500 characters. Reference our [filterLIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
  • -p order-by=string

    • Field by which to sort the list. Acceptable values are: * displayName (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.
  • -p page-size=integer

    • Requested page size. Must be between 1 and 200. If unspecified will default to 100.
  • -p page-token=string

    • A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListUsers method. If not specified, the first page of results will be returned.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").