Method: projects.tenants.profiles.list

Lists profiles by filter. The order is unspecified.

HTTP request

GET https://jobs.googleapis.com/v4beta1/{parent=projects/*/tenants/*}/profiles

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the tenant under which the profile is created.

The format is "projects/{project_id}/tenants/{tenantId}". For example, "projects/foo/tenants/bar".

Query parameters

Parameters
filter

string

The filter string specifies the profiles to be enumerated.

Supported operator: =, AND

The field(s) eligible for filtering are:

  • externalId
  • groupId

externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error.

Sample Query:

  • externalId = "externalId-1"
  • groupId = "groupId-1"

pageToken

string

The token that specifies the current offset (that is, starting result).

Please set the value to ListProfilesResponse.next_page_token to continue the list.

pageSize

number

The maximum number of profiles to be returned, at most 100.

Default is 100 unless a positive number smaller than 100 is specified.

readMask

string (FieldMask format)

A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset.

Valid values are:

  • name

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body must be empty.

Response body

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

The List profiles response object.

JSON representation
{
  "profiles": [
    {
      object (Profile)
    }
  ],
  "nextPageToken": string
}
Fields
profiles[]

object (Profile)

Profiles for the specific tenant.

nextPageToken

string

A token to retrieve the next page of results. This is empty if there are no more results.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

Try it!