This product is not supported for your selected
Datadog site. (
).
gcp_integrations_auth_config
ancestors
Type: UNORDERED_LIST_STRING
certificate_id
Type: STRING
Provider name: certificateId
Description: Certificate id for client certificate
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. The timestamp when the auth config is created.
creator_email
Type: STRING
Provider name: creatorEmail
Description: The creator’s email address. Generated based on the End User Credentials/LOAS role of the user making the call.
credential_type
Type: STRING
Provider name: credentialType
Description: Required. Credential type of the encrypted credential.
Possible values:
CREDENTIAL_TYPE_UNSPECIFIED - Unspecified credential type
USERNAME_AND_PASSWORD - Regular username/password pair.
API_KEY - API key.
OAUTH2_AUTHORIZATION_CODE - OAuth 2.0 Authorization Code Grant Type.
OAUTH2_IMPLICIT - OAuth 2.0 Implicit Grant Type.
OAUTH2_CLIENT_CREDENTIALS - OAuth 2.0 Client Credentials Grant Type.
OAUTH2_RESOURCE_OWNER_CREDENTIALS - OAuth 2.0 Resource Owner Credentials Grant Type.
JWT - JWT Token.
AUTH_TOKEN - Auth Token, e.g. bearer token.
SERVICE_ACCOUNT - Service Account which can be used to generate token for authentication.
CLIENT_CERTIFICATE_ONLY - Client Certificate only.
OIDC_TOKEN - Google OIDC ID Token
decrypted_credential
Type: STRUCT
Provider name: decryptedCredential
Description: Raw auth credentials.
auth_token
Type: STRUCT
Provider name: authToken
Description: Auth token credential
token
Type: STRING
Provider name: token
Description: The token for the auth type.
type
Type: STRING
Provider name: type
Description: Authentication type, e.g. “Basic”, “Bearer”, etc.
credential_type
Type: STRING
Provider name: credentialType
Description: Credential type associated with auth config.
Possible values:
CREDENTIAL_TYPE_UNSPECIFIED - Unspecified credential type
USERNAME_AND_PASSWORD - Regular username/password pair.
API_KEY - API key.
OAUTH2_AUTHORIZATION_CODE - OAuth 2.0 Authorization Code Grant Type.
OAUTH2_IMPLICIT - OAuth 2.0 Implicit Grant Type.
OAUTH2_CLIENT_CREDENTIALS - OAuth 2.0 Client Credentials Grant Type.
OAUTH2_RESOURCE_OWNER_CREDENTIALS - OAuth 2.0 Resource Owner Credentials Grant Type.
JWT - JWT Token.
AUTH_TOKEN - Auth Token, e.g. bearer token.
SERVICE_ACCOUNT - Service Account which can be used to generate token for authentication.
CLIENT_CERTIFICATE_ONLY - Client Certificate only.
OIDC_TOKEN - Google OIDC ID Token
jwt
Type: STRUCT
Provider name: jwt
Description: JWT credential
jwt
Type: STRING
Provider name: jwt
Description: The token calculated by the header, payload and signature.
jwt_header
Type: STRING
Provider name: jwtHeader
Description: Identifies which algorithm is used to generate the signature.
jwt_payload
Type: STRING
Provider name: jwtPayload
Description: Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
secret
Type: STRING
Provider name: secret
Description: User’s pre-shared secret to sign the token.
oauth2_authorization_code
Type: STRUCT
Provider name: oauth2AuthorizationCode
Description: The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
access_token
Type: STRUCT
Provider name: accessToken
Description: The access token received from the token endpoint.
access_token
Type: STRING
Provider name: accessToken
Description: The access token encapsulating the security identity of a process or thread.
access_token_expire_time
Type: TIMESTAMP
Provider name: accessTokenExpireTime
Description: Required. The approximate time until the access token retrieved is valid.
refresh_token
Type: STRING
Provider name: refreshToken
Description: If the access token will expire, use the refresh token to obtain another access token.
refresh_token_expire_time
Type: TIMESTAMP
Provider name: refreshTokenExpireTime
Description: The approximate time until the refresh token retrieved is valid.
token_type
Type: STRING
Provider name: tokenType
Description: Only support “bearer” token in v1 as bearer token is the predominant type used with OAuth 2.0.
apply_reauth_policy
Type: BOOLEAN
Provider name: applyReauthPolicy
Description: Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
auth_code
Type: STRING
Provider name: authCode
Description: The Auth Code that is used to initially retrieve the access token.
auth_endpoint
Type: STRING
Provider name: authEndpoint
Description: The auth url endpoint to send the auth code request to.
auth_params
Type: STRUCT
Provider name: authParams
Description: The auth parameters sent along with the auth code request.
entries
Type: UNORDERED_LIST_STRUCT
Provider name: entries
Description: A list of parameter map entries.
key
Type: STRUCT
Provider name: key
Description: Key of the map entry.
literal_value
Type: STRUCT
Provider name: literalValue
Description: Passing a literal value.
boolean_array
Type: STRUCT
Provider name: booleanArray
Description: Boolean Array.
boolean_values
Type: UNORDERED_LIST_BOOLEAN
Provider name: booleanValues
Description: Boolean array.
boolean_value
Type: BOOLEAN
Provider name: booleanValue
Description: Boolean.
double_array
Type: STRUCT
Provider name: doubleArray
Description: Double Number Array.
double_values
Type: UNORDERED_LIST_DOUBLE
Provider name: doubleValues
Description: Double number array.
double_value
Type: DOUBLE
Provider name: doubleValue
Description: Double Number.
int_array
Type: STRUCT
Provider name: intArray
Description: Integer Array.
int_values
Type: UNORDERED_LIST_INT64
Provider name: intValues
Description: Integer array.
int_value
Type: INT64
Provider name: intValue
Description: Integer.
json_value
Type: STRING
Provider name: jsonValue
Description: Json.
string_array
Type: STRUCT
Provider name: stringArray
Description: String Array.
string_values
Type: UNORDERED_LIST_STRING
Provider name: stringValues
Description: String array.
string_value
Type: STRING
Provider name: stringValue
Description: String.
reference_key
Type: STRING
Provider name: referenceKey
Description: Referencing one of the Integration variables.
value
Type: STRUCT
Provider name: value
Description: Value of the map entry.
literal_value
Type: STRUCT
Provider name: literalValue
Description: Passing a literal value.
boolean_array
Type: STRUCT
Provider name: booleanArray
Description: Boolean Array.
boolean_values
Type: UNORDERED_LIST_BOOLEAN
Provider name: booleanValues
Description: Boolean array.
boolean_value
Type: BOOLEAN
Provider name: booleanValue
Description: Boolean.
double_array
Type: STRUCT
Provider name: doubleArray
Description: Double Number Array.
double_values
Type: UNORDERED_LIST_DOUBLE
Provider name: doubleValues
Description: Double number array.
double_value
Type: DOUBLE
Provider name: doubleValue
Description: Double Number.
int_array
Type: STRUCT
Provider name: intArray
Description: Integer Array.
int_values
Type: UNORDERED_LIST_INT64
Provider name: intValues
Description: Integer array.
int_value
Type: INT64
Provider name: intValue
Description: Integer.
json_value
Type: STRING
Provider name: jsonValue
Description: Json.
string_array
Type: STRUCT
Provider name: stringArray
Description: String Array.
string_values
Type: UNORDERED_LIST_STRING
Provider name: stringValues
Description: String array.
string_value
Type: STRING
Provider name: stringValue
Description: String.
reference_key
Type: STRING
Provider name: referenceKey
Description: Referencing one of the Integration variables.
key_type
Type: STRING
Provider name: keyType
Description: Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
Possible values:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - Unspecified.
STRING_VALUE - String.
INT_VALUE - Integer.
DOUBLE_VALUE - Double Number.
BOOLEAN_VALUE - Boolean.
STRING_ARRAY - String Array.
INT_ARRAY - Integer Array.
DOUBLE_ARRAY - Double Number Array.
BOOLEAN_ARRAY - Boolean Array.
JSON_VALUE - Json.
PROTO_VALUE - Proto Value (Internal use only).
PROTO_ARRAY - Proto Array (Internal use only).
NON_SERIALIZABLE_OBJECT - // Non-serializable object (Internal use only).
PROTO_ENUM - Proto Enum (Internal use only).
SERIALIZED_OBJECT_VALUE - Serialized object (Internal use only).
PROTO_ENUM_ARRAY - Proto Enum Array (Internal use only).
BYTES - BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY - BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
value_type
Type: STRING
Provider name: valueType
Description: Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
Possible values:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - Unspecified.
STRING_VALUE - String.
INT_VALUE - Integer.
DOUBLE_VALUE - Double Number.
BOOLEAN_VALUE - Boolean.
STRING_ARRAY - String Array.
INT_ARRAY - Integer Array.
DOUBLE_ARRAY - Double Number Array.
BOOLEAN_ARRAY - Boolean Array.
JSON_VALUE - Json.
PROTO_VALUE - Proto Value (Internal use only).
PROTO_ARRAY - Proto Array (Internal use only).
NON_SERIALIZABLE_OBJECT - // Non-serializable object (Internal use only).
PROTO_ENUM - Proto Enum (Internal use only).
SERIALIZED_OBJECT_VALUE - Serialized object (Internal use only).
PROTO_ENUM_ARRAY - Proto Enum Array (Internal use only).
BYTES - BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY - BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
client_id
Type: STRING
Provider name: clientId
Description: The client’s id.
client_secret
Type: STRING
Provider name: clientSecret
Description: The client’s secret.
request_type
Type: STRING
Provider name: requestType
Description: Represent how to pass parameters to fetch access token
Possible values:
REQUEST_TYPE_UNSPECIFIED - Unspecified request type
REQUEST_BODY - To pass all the parameters in post body.
QUERY_PARAMETERS - To pass all the parameters as a part of query parameter.
ENCODED_HEADER - To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body.
scope
Type: STRING
Provider name: scope
Description: A space-delimited list of requested scope permissions.
token_endpoint
Type: STRING
Provider name: tokenEndpoint
Description: The token url endpoint to send the token request to.
token_params
Type: STRUCT
Provider name: tokenParams
Description: The token parameters sent along with the token request.
entries
Type: UNORDERED_LIST_STRUCT
Provider name: entries
Description: A list of parameter map entries.
key
Type: STRUCT
Provider name: key
Description: Key of the map entry.
literal_value
Type: STRUCT
Provider name: literalValue
Description: Passing a literal value.
boolean_array
Type: STRUCT
Provider name: booleanArray
Description: Boolean Array.
boolean_values
Type: UNORDERED_LIST_BOOLEAN
Provider name: booleanValues
Description: Boolean array.
boolean_value
Type: BOOLEAN
Provider name: booleanValue
Description: Boolean.
double_array
Type: STRUCT
Provider name: doubleArray
Description: Double Number Array.
double_values
Type: UNORDERED_LIST_DOUBLE
Provider name: doubleValues
Description: Double number array.
double_value
Type: DOUBLE
Provider name: doubleValue
Description: Double Number.
int_array
Type: STRUCT
Provider name: intArray
Description: Integer Array.
int_values
Type: UNORDERED_LIST_INT64
Provider name: intValues
Description: Integer array.
int_value
Type: INT64
Provider name: intValue
Description: Integer.
json_value
Type: STRING
Provider name: jsonValue
Description: Json.
string_array
Type: STRUCT
Provider name: stringArray
Description: String Array.
string_values
Type: UNORDERED_LIST_STRING
Provider name: stringValues
Description: String array.
string_value
Type: STRING
Provider name: stringValue
Description: String.
reference_key
Type: STRING
Provider name: referenceKey
Description: Referencing one of the Integration variables.
value
Type: STRUCT
Provider name: value
Description: Value of the map entry.
literal_value
Type: STRUCT
Provider name: literalValue
Description: Passing a literal value.
boolean_array
Type: STRUCT
Provider name: booleanArray
Description: Boolean Array.
boolean_values
Type: UNORDERED_LIST_BOOLEAN
Provider name: booleanValues
Description: Boolean array.
boolean_value
Type: BOOLEAN
Provider name: booleanValue
Description: Boolean.
double_array
Type: STRUCT
Provider name: doubleArray
Description: Double Number Array.
double_values
Type: UNORDERED_LIST_DOUBLE
Provider name: doubleValues
Description: Double number array.
double_value
Type: DOUBLE
Provider name: doubleValue
Description: Double Number.
int_array
Type: STRUCT
Provider name: intArray
Description: Integer Array.
int_values
Type: UNORDERED_LIST_INT64
Provider name: intValues
Description: Integer array.
int_value
Type: INT64
Provider name: intValue
Description: Integer.
json_value
Type: STRING
Provider name: jsonValue
Description: Json.
string_array
Type: STRUCT
Provider name: stringArray
Description: String Array.
string_values
Type: UNORDERED_LIST_STRING
Provider name: stringValues
Description: String array.
string_value
Type: STRING
Provider name: stringValue
Description: String.
reference_key
Type: STRING
Provider name: referenceKey
Description: Referencing one of the Integration variables.
key_type
Type: STRING
Provider name: keyType
Description: Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
Possible values:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - Unspecified.
STRING_VALUE - String.
INT_VALUE - Integer.
DOUBLE_VALUE - Double Number.
BOOLEAN_VALUE - Boolean.
STRING_ARRAY - String Array.
INT_ARRAY - Integer Array.
DOUBLE_ARRAY - Double Number Array.
BOOLEAN_ARRAY - Boolean Array.
JSON_VALUE - Json.
PROTO_VALUE - Proto Value (Internal use only).
PROTO_ARRAY - Proto Array (Internal use only).
NON_SERIALIZABLE_OBJECT - // Non-serializable object (Internal use only).
PROTO_ENUM - Proto Enum (Internal use only).
SERIALIZED_OBJECT_VALUE - Serialized object (Internal use only).
PROTO_ENUM_ARRAY - Proto Enum Array (Internal use only).
BYTES - BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY - BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
value_type
Type: STRING
Provider name: valueType
Description: Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
Possible values:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - Unspecified.
STRING_VALUE - String.
INT_VALUE - Integer.
DOUBLE_VALUE - Double Number.
BOOLEAN_VALUE - Boolean.
STRING_ARRAY - String Array.
INT_ARRAY - Integer Array.
DOUBLE_ARRAY - Double Number Array.
BOOLEAN_ARRAY - Boolean Array.
JSON_VALUE - Json.
PROTO_VALUE - Proto Value (Internal use only).
PROTO_ARRAY - Proto Array (Internal use only).
NON_SERIALIZABLE_OBJECT - // Non-serializable object (Internal use only).
PROTO_ENUM - Proto Enum (Internal use only).
SERIALIZED_OBJECT_VALUE - Serialized object (Internal use only).
PROTO_ENUM_ARRAY - Proto Enum Array (Internal use only).
BYTES - BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY - BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
oauth2_client_credentials
Type: STRUCT
Provider name: oauth2ClientCredentials
Description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
access_token
Type: STRUCT
Provider name: accessToken
Description: Access token fetched from the authorization server.
access_token
Type: STRING
Provider name: accessToken
Description: The access token encapsulating the security identity of a process or thread.
access_token_expire_time
Type: TIMESTAMP
Provider name: accessTokenExpireTime
Description: Required. The approximate time until the access token retrieved is valid.
refresh_token
Type: STRING
Provider name: refreshToken
Description: If the access token will expire, use the refresh token to obtain another access token.
refresh_token_expire_time
Type: TIMESTAMP
Provider name: refreshTokenExpireTime
Description: The approximate time until the refresh token retrieved is valid.
token_type
Type: STRING
Provider name: tokenType
Description: Only support “bearer” token in v1 as bearer token is the predominant type used with OAuth 2.0.
client_id
Type: STRING
Provider name: clientId
Description: The client’s ID.
client_secret
Type: STRING
Provider name: clientSecret
Description: The client’s secret.
request_type
Type: STRING
Provider name: requestType
Description: Represent how to pass parameters to fetch access token
Possible values:
REQUEST_TYPE_UNSPECIFIED - Unspecified request type
REQUEST_BODY - To pass all the parameters in post body.
QUERY_PARAMETERS - To pass all the parameters as a part of query parameter.
ENCODED_HEADER - To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body.
scope
Type: STRING
Provider name: scope
Description: A space-delimited list of requested scope permissions.
token_endpoint
Type: STRING
Provider name: tokenEndpoint
Description: The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
token_params
Type: STRUCT
Provider name: tokenParams
Description: Token parameters for the auth request.
entries
Type: UNORDERED_LIST_STRUCT
Provider name: entries
Description: A list of parameter map entries.
key
Type: STRUCT
Provider name: key
Description: Key of the map entry.
literal_value
Type: STRUCT
Provider name: literalValue
Description: Passing a literal value.
boolean_array
Type: STRUCT
Provider name: booleanArray
Description: Boolean Array.
boolean_values
Type: UNORDERED_LIST_BOOLEAN
Provider name: booleanValues
Description: Boolean array.
boolean_value
Type: BOOLEAN
Provider name: booleanValue
Description: Boolean.
double_array
Type: STRUCT
Provider name: doubleArray
Description: Double Number Array.
double_values
Type: UNORDERED_LIST_DOUBLE
Provider name: doubleValues
Description: Double number array.
double_value
Type: DOUBLE
Provider name: doubleValue
Description: Double Number.
int_array
Type: STRUCT
Provider name: intArray
Description: Integer Array.
int_values
Type: UNORDERED_LIST_INT64
Provider name: intValues
Description: Integer array.
int_value
Type: INT64
Provider name: intValue
Description: Integer.
json_value
Type: STRING
Provider name: jsonValue
Description: Json.
string_array
Type: STRUCT
Provider name: stringArray
Description: String Array.
string_values
Type: UNORDERED_LIST_STRING
Provider name: stringValues
Description: String array.
string_value
Type: STRING
Provider name: stringValue
Description: String.
reference_key
Type: STRING
Provider name: referenceKey
Description: Referencing one of the Integration variables.
value
Type: STRUCT
Provider name: value
Description: Value of the map entry.
literal_value
Type: STRUCT
Provider name: literalValue
Description: Passing a literal value.
boolean_array
Type: STRUCT
Provider name: booleanArray
Description: Boolean Array.
boolean_values
Type: UNORDERED_LIST_BOOLEAN
Provider name: booleanValues
Description: Boolean array.
boolean_value
Type: BOOLEAN
Provider name: booleanValue
Description: Boolean.
double_array
Type: STRUCT
Provider name: doubleArray
Description: Double Number Array.
double_values
Type: UNORDERED_LIST_DOUBLE
Provider name: doubleValues
Description: Double number array.
double_value
Type: DOUBLE
Provider name: doubleValue
Description: Double Number.
int_array
Type: STRUCT
Provider name: intArray
Description: Integer Array.
int_values
Type: UNORDERED_LIST_INT64
Provider name: intValues
Description: Integer array.
int_value
Type: INT64
Provider name: intValue
Description: Integer.
json_value
Type: STRING
Provider name: jsonValue
Description: Json.
string_array
Type: STRUCT
Provider name: stringArray
Description: String Array.
string_values
Type: UNORDERED_LIST_STRING
Provider name: stringValues
Description: String array.
string_value
Type: STRING
Provider name: stringValue
Description: String.
reference_key
Type: STRING
Provider name: referenceKey
Description: Referencing one of the Integration variables.
key_type
Type: STRING
Provider name: keyType
Description: Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
Possible values:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - Unspecified.
STRING_VALUE - String.
INT_VALUE - Integer.
DOUBLE_VALUE - Double Number.
BOOLEAN_VALUE - Boolean.
STRING_ARRAY - String Array.
INT_ARRAY - Integer Array.
DOUBLE_ARRAY - Double Number Array.
BOOLEAN_ARRAY - Boolean Array.
JSON_VALUE - Json.
PROTO_VALUE - Proto Value (Internal use only).
PROTO_ARRAY - Proto Array (Internal use only).
NON_SERIALIZABLE_OBJECT - // Non-serializable object (Internal use only).
PROTO_ENUM - Proto Enum (Internal use only).
SERIALIZED_OBJECT_VALUE - Serialized object (Internal use only).
PROTO_ENUM_ARRAY - Proto Enum Array (Internal use only).
BYTES - BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY - BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
value_type
Type: STRING
Provider name: valueType
Description: Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
Possible values:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - Unspecified.
STRING_VALUE - String.
INT_VALUE - Integer.
DOUBLE_VALUE - Double Number.
BOOLEAN_VALUE - Boolean.
STRING_ARRAY - String Array.
INT_ARRAY - Integer Array.
DOUBLE_ARRAY - Double Number Array.
BOOLEAN_ARRAY - Boolean Array.
JSON_VALUE - Json.
PROTO_VALUE - Proto Value (Internal use only).
PROTO_ARRAY - Proto Array (Internal use only).
NON_SERIALIZABLE_OBJECT - // Non-serializable object (Internal use only).
PROTO_ENUM - Proto Enum (Internal use only).
SERIALIZED_OBJECT_VALUE - Serialized object (Internal use only).
PROTO_ENUM_ARRAY - Proto Enum Array (Internal use only).
BYTES - BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY - BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
oauth2_resource_owner_credentials
Type: STRUCT
Provider name: oauth2ResourceOwnerCredentials
Description: OAuth2 resource owner credentials
access_token
Type: STRUCT
Provider name: accessToken
Description: Access token fetched from the authorization server.
access_token
Type: STRING
Provider name: accessToken
Description: The access token encapsulating the security identity of a process or thread.
access_token_expire_time
Type: TIMESTAMP
Provider name: accessTokenExpireTime
Description: Required. The approximate time until the access token retrieved is valid.
refresh_token
Type: STRING
Provider name: refreshToken
Description: If the access token will expire, use the refresh token to obtain another access token.
refresh_token_expire_time
Type: TIMESTAMP
Provider name: refreshTokenExpireTime
Description: The approximate time until the refresh token retrieved is valid.
token_type
Type: STRING
Provider name: tokenType
Description: Only support “bearer” token in v1 as bearer token is the predominant type used with OAuth 2.0.
client_id
Type: STRING
Provider name: clientId
Description: The client’s ID.
client_secret
Type: STRING
Provider name: clientSecret
Description: The client’s secret.
password
Type: STRING
Provider name: password
Description: The user’s password.
request_type
Type: STRING
Provider name: requestType
Description: Represent how to pass parameters to fetch access token
Possible values:
REQUEST_TYPE_UNSPECIFIED - Unspecified request type
REQUEST_BODY - To pass all the parameters in post body.
QUERY_PARAMETERS - To pass all the parameters as a part of query parameter.
ENCODED_HEADER - To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body.
scope
Type: STRING
Provider name: scope
Description: A space-delimited list of requested scope permissions.
token_endpoint
Type: STRING
Provider name: tokenEndpoint
Description: The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
token_params
Type: STRUCT
Provider name: tokenParams
Description: Token parameters for the auth request.
entries
Type: UNORDERED_LIST_STRUCT
Provider name: entries
Description: A list of parameter map entries.
key
Type: STRUCT
Provider name: key
Description: Key of the map entry.
literal_value
Type: STRUCT
Provider name: literalValue
Description: Passing a literal value.
boolean_array
Type: STRUCT
Provider name: booleanArray
Description: Boolean Array.
boolean_values
Type: UNORDERED_LIST_BOOLEAN
Provider name: booleanValues
Description: Boolean array.
boolean_value
Type: BOOLEAN
Provider name: booleanValue
Description: Boolean.
double_array
Type: STRUCT
Provider name: doubleArray
Description: Double Number Array.
double_values
Type: UNORDERED_LIST_DOUBLE
Provider name: doubleValues
Description: Double number array.
double_value
Type: DOUBLE
Provider name: doubleValue
Description: Double Number.
int_array
Type: STRUCT
Provider name: intArray
Description: Integer Array.
int_values
Type: UNORDERED_LIST_INT64
Provider name: intValues
Description: Integer array.
int_value
Type: INT64
Provider name: intValue
Description: Integer.
json_value
Type: STRING
Provider name: jsonValue
Description: Json.
string_array
Type: STRUCT
Provider name: stringArray
Description: String Array.
string_values
Type: UNORDERED_LIST_STRING
Provider name: stringValues
Description: String array.
string_value
Type: STRING
Provider name: stringValue
Description: String.
reference_key
Type: STRING
Provider name: referenceKey
Description: Referencing one of the Integration variables.
value
Type: STRUCT
Provider name: value
Description: Value of the map entry.
literal_value
Type: STRUCT
Provider name: literalValue
Description: Passing a literal value.
boolean_array
Type: STRUCT
Provider name: booleanArray
Description: Boolean Array.
boolean_values
Type: UNORDERED_LIST_BOOLEAN
Provider name: booleanValues
Description: Boolean array.
boolean_value
Type: BOOLEAN
Provider name: booleanValue
Description: Boolean.
double_array
Type: STRUCT
Provider name: doubleArray
Description: Double Number Array.
double_values
Type: UNORDERED_LIST_DOUBLE
Provider name: doubleValues
Description: Double number array.
double_value
Type: DOUBLE
Provider name: doubleValue
Description: Double Number.
int_array
Type: STRUCT
Provider name: intArray
Description: Integer Array.
int_values
Type: UNORDERED_LIST_INT64
Provider name: intValues
Description: Integer array.
int_value
Type: INT64
Provider name: intValue
Description: Integer.
json_value
Type: STRING
Provider name: jsonValue
Description: Json.
string_array
Type: STRUCT
Provider name: stringArray
Description: String Array.
string_values
Type: UNORDERED_LIST_STRING
Provider name: stringValues
Description: String array.
string_value
Type: STRING
Provider name: stringValue
Description: String.
reference_key
Type: STRING
Provider name: referenceKey
Description: Referencing one of the Integration variables.
key_type
Type: STRING
Provider name: keyType
Description: Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
Possible values:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - Unspecified.
STRING_VALUE - String.
INT_VALUE - Integer.
DOUBLE_VALUE - Double Number.
BOOLEAN_VALUE - Boolean.
STRING_ARRAY - String Array.
INT_ARRAY - Integer Array.
DOUBLE_ARRAY - Double Number Array.
BOOLEAN_ARRAY - Boolean Array.
JSON_VALUE - Json.
PROTO_VALUE - Proto Value (Internal use only).
PROTO_ARRAY - Proto Array (Internal use only).
NON_SERIALIZABLE_OBJECT - // Non-serializable object (Internal use only).
PROTO_ENUM - Proto Enum (Internal use only).
SERIALIZED_OBJECT_VALUE - Serialized object (Internal use only).
PROTO_ENUM_ARRAY - Proto Enum Array (Internal use only).
BYTES - BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY - BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
value_type
Type: STRING
Provider name: valueType
Description: Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
Possible values:
INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - Unspecified.
STRING_VALUE - String.
INT_VALUE - Integer.
DOUBLE_VALUE - Double Number.
BOOLEAN_VALUE - Boolean.
STRING_ARRAY - String Array.
INT_ARRAY - Integer Array.
DOUBLE_ARRAY - Double Number Array.
BOOLEAN_ARRAY - Boolean Array.
JSON_VALUE - Json.
PROTO_VALUE - Proto Value (Internal use only).
PROTO_ARRAY - Proto Array (Internal use only).
NON_SERIALIZABLE_OBJECT - // Non-serializable object (Internal use only).
PROTO_ENUM - Proto Enum (Internal use only).
SERIALIZED_OBJECT_VALUE - Serialized object (Internal use only).
PROTO_ENUM_ARRAY - Proto Enum Array (Internal use only).
BYTES - BYTES data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
BYTES_ARRAY - BYTES_ARRAY data types are not allowed for top-level params. They’re only meant to support protobufs with BYTES (sub)fields.
username
Type: STRING
Provider name: username
Description: The user’s username.
oidc_token
Type: STRUCT
Provider name: oidcToken
Description: Google OIDC ID Token
audience
Type: STRING
Provider name: audience
Description: Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
service_account_email
Type: STRING
Provider name: serviceAccountEmail
Description: The service account email to be used as the identity for the token.
token
Type: STRING
Provider name: token
Description: ID token obtained for the service account
token_expire_time
Type: TIMESTAMP
Provider name: tokenExpireTime
Description: The approximate time until the token retrieved is valid.
service_account_credentials
Type: STRUCT
Provider name: serviceAccountCredentials
Description: Service account credential
scope
Type: STRING
Provider name: scope
Description: A space-delimited list of requested scope permissions.
service_account
Type: STRING
Provider name: serviceAccount
Description: Name of the service account that has the permission to make the request.
username_and_password
Type: STRUCT
Provider name: usernameAndPassword
Description: Username and password credential
password
Type: STRING
Provider name: password
Description: Password to be used
username
Type: STRING
Provider name: username
Description: Username to be used
description
Type: STRING
Provider name: description
Description: Optional. A description of the auth config.
expiry_notification_duration
Type: UNORDERED_LIST_STRING
Provider name: expiryNotificationDuration
Description: Optional. User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
gcp_display_name
Type: STRING
Provider name: displayName
Description: Required. The name of the auth config.
labels
Type: UNORDERED_LIST_STRING
last_modifier_email
Type: STRING
Provider name: lastModifierEmail
Description: The last modifier’s email address. Generated based on the End User Credentials/LOAS role of the user making the call.
name
Type: STRING
Provider name: name
Description: Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
organization_id
Type: STRING
override_valid_time
Type: TIMESTAMP
Provider name: overrideValidTime
Description: Optional. User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
reason
Type: STRING
Provider name: reason
Description: Output only. The reason / details of the current status.
resource_name
Type: STRING
state
Type: STRING
Provider name: state
Description: Output only. The status of the auth config.
Possible values:
STATE_UNSPECIFIED - Status not specified.
VALID - Valid Auth config.
INVALID - General invalidity, if it doesn’t fits in the detailed issue below.
SOFT_DELETED - Auth config soft deleted.
EXPIRED - Auth config expired.
UNAUTHORIZED - Auth config unauthorized.
UNSUPPORTED - Auth config not supported.
Type: UNORDERED_LIST_STRING
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The timestamp when the auth config is modified.
valid_time
Type: TIMESTAMP
Provider name: validTime
Description: Optional. The time until the auth config is valid. Empty or max value is considered the auth config won’t expire.
visibility
Type: STRING
Provider name: visibility
Description: Optional. The visibility of the auth config.
Possible values:
AUTH_CONFIG_VISIBILITY_UNSPECIFIED - Visibility not specified.
PRIVATE - Profile visible to the creator only.
CLIENT_VISIBLE - Profile visible within the client.
