Method: legacySoarUsers.list

Full name: projects.locations.instances.legacySoarUsers.list

Lists LegacySoarUsers.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list LegacySoarUsers for. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarUsers

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of LegacySoarUsers to return. The service may return fewer than this value. If unspecified, at most 50 LegacySoarUsers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous legacySoarUsers.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of LegacySoarUsers. Supported filter fields: * given_name * family_name * socRole * email * avatar * userType * lastLoginTime * environments * permissionGroups * accountState * login_id * provider_display_name

Example: filter="email='some_name'"
orderBy

string

Optional. Configures ordering of LegacySoarUsers in the response. If not specified, LegacySoarUsers are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. Supported sort fields: * given_name * family_name * socRole * email * avatar * userType * lastLoginTime * environments * accountState * login_id * provider_display_name

example: "given_name desc, family_name"

Request body

The request body must be empty.

Response body

Response message for legacySoarUsers.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "legacySoarUsers": [
    {
      object (LegacySoarUser)
    }
  ],
  "nextPageToken": string
}
Fields
legacySoarUsers[]

object (LegacySoarUser)

The list of LegacySoarUsers.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.