OAUTH Application API, REST: Application.List

Field

Description

organizationId

string

Required field. ID of the organization to list OAuth applications in.

pageSize

string (int64)

The maximum number of results per page to return.
If the number of available results is larger than pageSize,
the service returns a ListApplicationsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken
to the ListApplicationsResponse.nextPageToken
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.

Field

Description

applications[]

Application

List of OAuth applications.

nextPageToken

string

This token allows you to get the next page of results for list requests.
If the number of results is larger than ListApplicationsRequest.pageSize,
use the nextPageToken as the value for the ListApplicationsRequest.pageToken
query parameter in the next list request.

Field

Description

id

string

ID of the application.

name

string

Name of the application.
The name is unique within the organization. 3-63 characters long.

organizationId

string

ID of the organization that the application belongs to.

description

string

Description of the application. 0-256 characters long.

groupClaimsSettings

GroupClaimsSettings

Settings of the group claims

clientGrant

ClientGrant

Represents current connection to the OAuth client with specified scopes

status

enum (Status)

Current status of the application.

• STATUS_UNSPECIFIED: The status is not specified.
• CREATING: The apllication is in the process of being created.
• ACTIVE: The apllication is active and operational.
• SUSPENDED: The apllication is suspended. I.e. authentication via this application is disabled.
• DELETING: The apllication is in the process of being deleted.

labels

object (map<string, string>)

Resource labels as key:value pairs.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Modification timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Field

Description

groupDistributionType

enum (GroupDistributionType)

Represents current distribution type of the groups. I.e. which groups are visible for the application users.

• GROUP_DISTRIBUTION_TYPE_UNSPECIFIED: The distribution type is unspecified
• NONE: No groups are visible for the application users
• ASSIGNED_GROUPS: Only assigned groups are visible for the application users
• ALL_GROUPS: All groups are visible for the application users

Field

Description

clientId

string

Required field. OAuth client id

authorizedScopes[]

string

List of authorized client scopes by the application