Method: projects.locations.providers.connectors.versions.fetchAuthSchema

fetch and return the list of auth config variables required to override the connection backend auth.

HTTP request

GET https://connectors.googleapis.com/v1/{name=projects/*/locations/*/providers/*/connectors/*/versions/*}:fetchAuthSchema

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Parent resource of the Connector Version, of the form: projects/*/locations/*/providers/*/connectors/*/versions/*

Query parameters

Parameters
view

enum (AuthSchemaView)

Optional. View of the AuthSchema. The default value is BASIC.

Request body

The request body must be empty.

Response body

Response message for Connectors.GetAuthSchema.

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

JSON representation 
{
  "authSchemas": [
    {
      object (AuthSchema)
    }
  ],
  "jsonSchema": {
    object (JsonAuthSchema)
  }
}
Fields
authSchemas[]

object (AuthSchema)

List of AuthSchemas.
jsonSchema

object (JsonAuthSchema)

JSON schema of the AuthSchemas. This is only populated if the view is JSON_SCHEMA. The schema is in draft-07 format.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

AuthSchemaView

View of the AuthSchema.

Enums
AUTH_SCHEMA_VIEW_UNSPECIFIED Default value.
BASIC Basic view of the AuthSchema.
JSON_SCHEMA JSON schema view of the AuthSchema.
EUA_SCHEMA EUA Schema view of the AuthSchema.

AuthSchema

AuthSchema defines the schema of an authentication type.

JSON representation 
{
  "authFields": [
    {
      object (AuthField)
    }
  ],
  "isDefault": boolean,
  "authType": enum (AuthType),
  "authKey": string,
  "displayName": string,
  "description": string
}
Fields
authFields[]

object (AuthField)

List of AuthFields.
isDefault

boolean

Whether the auth schema is the default one.
authType

enum (AuthType)

Auth type of the schema.
authKey

string

Auth key of the schema.
displayName

string

Display name of the schema.
description

string

Description of the schema.

AuthField

AuthField defines a field in an authentication type.

JSON representation 
{
  "key": string,
  "dataType": string,
  "description": string
}
Fields
key

string

Key of the field.
dataType

string

Data type of the field.
description

string

Description of the field.

JsonAuthSchema

JsonAuthSchema defines the JSON schema of all authentication types.

JSON representation 
{
  "$schema": string,
  "oneOf": [
    {
      object (AuthObject)
    }
  ]
}
Fields
$schema

string

JSON schema of the AuthSchemas.
oneOf[]

object (AuthObject)

List of AuthObjects.

AuthObject

AuthObject defines a JSON schema of an authentication type.

JSON representation 
{
  "type": string,
  "description": string,
  "isDefault": boolean,
  "authType": string,
  "authKey": string,
  "additionalProperties": boolean,
  "properties": {
    string: {
      object (AuthProperty)
    },
    ...
  }
}
Fields
type

string

Type of the object.
description

string

Description of the object.
isDefault

boolean

Whether the object is the default one.
authType

string

Auth type of the object.
authKey

string

Auth key of the object.
additionalProperties

boolean

Whether the object has additional properties.
properties

map (key: string, value: object (AuthProperty))

Properties of the object.

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

AuthProperty

AuthProperty defines a property of an authentication type.

JSON representation 
{
  "type": string,
  "description": string
}
Fields
type

string

Type of the property.
description

string

Description of the property.