REST Resource: projects.locations.accountConnectors

Resource: AccountConnector

AccountConnector encapsulates what a platform administrator needs to configure for users to connect to the service providers, which includes, among other fields, the OAuth client ID, client secret, and authorization and token endpoints.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "annotations": {
    string: string,
    ...
  },
  "etag": string,
  "labels": {
    string: string,
    ...
  },
  "oauthStartUri": string,

  // Union field account_connector_config can be only one of the following:
  "providerOauthConfig": {
    object (ProviderOAuthConfig)
  }
  // End of list of possible types for union field account_connector_config.
}
Fields
name

string

Identifier. The resource name of the accountConnector, in the format projects/{project}/locations/{location}/accountConnectors/{accountConnectorId}.
createTime

string (Timestamp format)

Output only. The timestamp when the accountConnector was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The timestamp when the accountConnector was updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
annotations

map (key: string, value: string)

Optional. Allows users to store small amounts of arbitrary data.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
etag

string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels

map (key: string, value: string)

Optional. Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
oauthStartUri

string

Output only. Start OAuth flow by clicking on this URL.
Union field account_connector_config. The AccountConnector config. account_connector_config can be only one of the following:
providerOauthConfig

object (ProviderOAuthConfig)

Provider OAuth config.

ProviderOAuthConfig

ProviderOAuthConfig is the OAuth config for a provider.

JSON representation 
{
  "scopes": [
    string
  ],

  // Union field oauth_provider_id can be only one of the following:
  "systemProviderId": enum (SystemProvider)
  // End of list of possible types for union field oauth_provider_id.
}
Fields
scopes[]

string

Required. User selected scopes to apply to the Oauth config In the event of changing scopes, user records under AccountConnector will be deleted and users will re-auth again.
Union field oauth_provider_id. OAuth Provider ID. It could be Developer Connect owned or providers provided. oauth_provider_id can be only one of the following:
systemProviderId

enum (SystemProvider)

Immutable. Developer Connect provided OAuth.

SystemProvider

SystemProvider is a list of providers that are owned by Developer Connect.

Enums
SYSTEM_PROVIDER_UNSPECIFIED No system provider specified.
GITHUB GitHub provider. Scopes can be found at https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes
GITLAB GitLab provider. Scopes can be found at https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes
GOOGLE Google provider. Recommended scopes: "https://www.googleapis.com/auth/drive.readonly", "https://www.googleapis.com/auth/documents.readonly"
SENTRY Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/
ROVO Rovo provider. Must select the "rovo" scope.
NEW_RELIC New Relic provider. No scopes are allowed.
DATASTAX Datastax provider. No scopes are allowed.

Methods

create

 Creates a new AccountConnector in a given project and location.

delete

 Deletes a single AccountConnector.

get

 Gets details of a single AccountConnector.

list

 Lists AccountConnectors in a given project and location.

patch

 Updates the parameters of a single AccountConnector.