Close httplib2 connections.
Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
Deletes an auth config.
Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Retrieves the next page of results.
Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
close()
Close httplib2 connections.
create(parent, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, x__xgafv=None)
Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
Args:
parent: string, Required. "projects/{project}/locations/{location}" format. (required)
body: object, The request body.
The object takes the form of:
{ # The AuthConfig resource use to hold channels and connection config data.
"certificateId": "A String", # Certificate id for client certificate
"createTime": "A String", # Output only. The timestamp when the auth config is created.
"creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"credentialType": "A String", # Credential type of the encrypted credential.
"decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
"authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
"token": "A String", # The token for the auth type.
"type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
},
"credentialType": "A String", # Credential type associated with auth config.
"jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
"jwt": "A String", # The token calculated by the header, payload and signature.
"jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
"jwtPayload": "A String", # 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": "A String", # User's pre-shared secret to sign the token.
},
"oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # 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
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"applyReauthPolicy": True or False, # 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.
"authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
"authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
"authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"clientId": "A String", # The client's id.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token url endpoint to send the token request to.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"password": "A String", # The user's password.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"username": "A String", # The user's username.
},
"oidcToken": { # OIDC Token # Google OIDC ID Token
"audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
"serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
"token": "A String", # ID token obtained for the service account
"tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
},
"serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
"scope": "A String", # A space-delimited list of requested scope permissions.
"serviceAccount": "A String", # Name of the service account that has the permission to make the request.
},
"usernameAndPassword": { # Username and password pair. # Username and password credential
"password": "A String", # Password to be used
"username": "A String", # Username to be used
},
},
"description": "A String", # A description of the auth config.
"displayName": "A String", # Required. The name of the auth config.
"encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
"expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
"A String",
],
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
"overrideValidTime": "A String", # 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.
"reason": "A String", # The reason / details of the current status.
"state": "A String", # The status of the auth config.
"updateTime": "A String", # Output only. The timestamp when the auth config is modified.
"validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
"visibility": "A String", # The visibility of the auth config.
}
clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The AuthConfig resource use to hold channels and connection config data.
"certificateId": "A String", # Certificate id for client certificate
"createTime": "A String", # Output only. The timestamp when the auth config is created.
"creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"credentialType": "A String", # Credential type of the encrypted credential.
"decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
"authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
"token": "A String", # The token for the auth type.
"type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
},
"credentialType": "A String", # Credential type associated with auth config.
"jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
"jwt": "A String", # The token calculated by the header, payload and signature.
"jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
"jwtPayload": "A String", # 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": "A String", # User's pre-shared secret to sign the token.
},
"oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # 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
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"applyReauthPolicy": True or False, # 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.
"authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
"authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
"authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"clientId": "A String", # The client's id.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token url endpoint to send the token request to.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"password": "A String", # The user's password.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"username": "A String", # The user's username.
},
"oidcToken": { # OIDC Token # Google OIDC ID Token
"audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
"serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
"token": "A String", # ID token obtained for the service account
"tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
},
"serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
"scope": "A String", # A space-delimited list of requested scope permissions.
"serviceAccount": "A String", # Name of the service account that has the permission to make the request.
},
"usernameAndPassword": { # Username and password pair. # Username and password credential
"password": "A String", # Password to be used
"username": "A String", # Username to be used
},
},
"description": "A String", # A description of the auth config.
"displayName": "A String", # Required. The name of the auth config.
"encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
"expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
"A String",
],
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
"overrideValidTime": "A String", # 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.
"reason": "A String", # The reason / details of the current status.
"state": "A String", # The status of the auth config.
"updateTime": "A String", # Output only. The timestamp when the auth config is modified.
"validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
"visibility": "A String", # The visibility of the auth config.
}
delete(name, x__xgafv=None)
Deletes an auth config.
Args:
name: string, Required. The name that is associated with the AuthConfig. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
Args:
name: string, Required. The name that is associated with the AuthConfig. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The AuthConfig resource use to hold channels and connection config data.
"certificateId": "A String", # Certificate id for client certificate
"createTime": "A String", # Output only. The timestamp when the auth config is created.
"creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"credentialType": "A String", # Credential type of the encrypted credential.
"decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
"authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
"token": "A String", # The token for the auth type.
"type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
},
"credentialType": "A String", # Credential type associated with auth config.
"jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
"jwt": "A String", # The token calculated by the header, payload and signature.
"jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
"jwtPayload": "A String", # 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": "A String", # User's pre-shared secret to sign the token.
},
"oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # 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
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"applyReauthPolicy": True or False, # 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.
"authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
"authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
"authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"clientId": "A String", # The client's id.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token url endpoint to send the token request to.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"password": "A String", # The user's password.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"username": "A String", # The user's username.
},
"oidcToken": { # OIDC Token # Google OIDC ID Token
"audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
"serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
"token": "A String", # ID token obtained for the service account
"tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
},
"serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
"scope": "A String", # A space-delimited list of requested scope permissions.
"serviceAccount": "A String", # Name of the service account that has the permission to make the request.
},
"usernameAndPassword": { # Username and password pair. # Username and password credential
"password": "A String", # Password to be used
"username": "A String", # Username to be used
},
},
"description": "A String", # A description of the auth config.
"displayName": "A String", # Required. The name of the auth config.
"encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
"expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
"A String",
],
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
"overrideValidTime": "A String", # 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.
"reason": "A String", # The reason / details of the current status.
"state": "A String", # The status of the auth config.
"updateTime": "A String", # Output only. The timestamp when the auth config is modified.
"validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
"visibility": "A String", # The visibility of the auth config.
}
list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Args:
parent: string, Required. The client, which owns this collection of AuthConfigs. (required)
filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.
pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
pageToken: string, The token returned in the previous response.
readMask: string, The mask which specifies fields that need to be returned in the AuthConfig's response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to list AuthConfigs.
"authConfigs": [ # The list of AuthConfigs retrieved.
{ # The AuthConfig resource use to hold channels and connection config data.
"certificateId": "A String", # Certificate id for client certificate
"createTime": "A String", # Output only. The timestamp when the auth config is created.
"creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"credentialType": "A String", # Credential type of the encrypted credential.
"decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
"authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
"token": "A String", # The token for the auth type.
"type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
},
"credentialType": "A String", # Credential type associated with auth config.
"jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
"jwt": "A String", # The token calculated by the header, payload and signature.
"jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
"jwtPayload": "A String", # 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": "A String", # User's pre-shared secret to sign the token.
},
"oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # 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
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"applyReauthPolicy": True or False, # 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.
"authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
"authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
"authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"clientId": "A String", # The client's id.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token url endpoint to send the token request to.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"password": "A String", # The user's password.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"username": "A String", # The user's username.
},
"oidcToken": { # OIDC Token # Google OIDC ID Token
"audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
"serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
"token": "A String", # ID token obtained for the service account
"tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
},
"serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
"scope": "A String", # A space-delimited list of requested scope permissions.
"serviceAccount": "A String", # Name of the service account that has the permission to make the request.
},
"usernameAndPassword": { # Username and password pair. # Username and password credential
"password": "A String", # Password to be used
"username": "A String", # Username to be used
},
},
"description": "A String", # A description of the auth config.
"displayName": "A String", # Required. The name of the auth config.
"encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
"expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
"A String",
],
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
"overrideValidTime": "A String", # 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.
"reason": "A String", # The reason / details of the current status.
"state": "A String", # The status of the auth config.
"updateTime": "A String", # Output only. The timestamp when the auth config is modified.
"validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
"visibility": "A String", # The visibility of the auth config.
},
],
"nextPageToken": "A String", # The token used to retrieve the next page of results.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None)
Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
Args:
name: string, Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}. (required)
body: object, The request body.
The object takes the form of:
{ # The AuthConfig resource use to hold channels and connection config data.
"certificateId": "A String", # Certificate id for client certificate
"createTime": "A String", # Output only. The timestamp when the auth config is created.
"creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"credentialType": "A String", # Credential type of the encrypted credential.
"decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
"authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
"token": "A String", # The token for the auth type.
"type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
},
"credentialType": "A String", # Credential type associated with auth config.
"jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
"jwt": "A String", # The token calculated by the header, payload and signature.
"jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
"jwtPayload": "A String", # 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": "A String", # User's pre-shared secret to sign the token.
},
"oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # 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
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"applyReauthPolicy": True or False, # 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.
"authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
"authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
"authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"clientId": "A String", # The client's id.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token url endpoint to send the token request to.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"password": "A String", # The user's password.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"username": "A String", # The user's username.
},
"oidcToken": { # OIDC Token # Google OIDC ID Token
"audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
"serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
"token": "A String", # ID token obtained for the service account
"tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
},
"serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
"scope": "A String", # A space-delimited list of requested scope permissions.
"serviceAccount": "A String", # Name of the service account that has the permission to make the request.
},
"usernameAndPassword": { # Username and password pair. # Username and password credential
"password": "A String", # Password to be used
"username": "A String", # Username to be used
},
},
"description": "A String", # A description of the auth config.
"displayName": "A String", # Required. The name of the auth config.
"encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
"expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
"A String",
],
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
"overrideValidTime": "A String", # 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.
"reason": "A String", # The reason / details of the current status.
"state": "A String", # The status of the auth config.
"updateTime": "A String", # Output only. The timestamp when the auth config is modified.
"validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
"visibility": "A String", # The visibility of the auth config.
}
clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
updateMask: string, Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The AuthConfig resource use to hold channels and connection config data.
"certificateId": "A String", # Certificate id for client certificate
"createTime": "A String", # Output only. The timestamp when the auth config is created.
"creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"credentialType": "A String", # Credential type of the encrypted credential.
"decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
"authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
"token": "A String", # The token for the auth type.
"type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
},
"credentialType": "A String", # Credential type associated with auth config.
"jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
"jwt": "A String", # The token calculated by the header, payload and signature.
"jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
"jwtPayload": "A String", # 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": "A String", # User's pre-shared secret to sign the token.
},
"oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # 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
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"applyReauthPolicy": True or False, # 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.
"authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
"authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
"authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"clientId": "A String", # The client's id.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token url endpoint to send the token request to.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
},
"oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
"accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
"accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
"accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
"refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
"refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
"tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
},
"clientId": "A String", # The client's ID.
"clientSecret": "A String", # The client's secret.
"password": "A String", # The user's password.
"requestType": "A String", # Represent how to pass parameters to fetch access token
"scope": "A String", # A space-delimited list of requested scope permissions.
"tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
"tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
"entries": [ # A list of parameter map entries.
{ # Entry is a pair of key and value.
"key": { # Field represents either the key or value in an entry. # Key of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
"value": { # Field represents either the key or value in an entry. # Value of the map entry.
"literalValue": { # The type of the parameter. # Passing a literal value.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"referenceKey": "A String", # Referencing one of the Integration variables.
},
},
],
"keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
"valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
},
"username": "A String", # The user's username.
},
"oidcToken": { # OIDC Token # Google OIDC ID Token
"audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
"serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
"token": "A String", # ID token obtained for the service account
"tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
},
"serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
"scope": "A String", # A space-delimited list of requested scope permissions.
"serviceAccount": "A String", # Name of the service account that has the permission to make the request.
},
"usernameAndPassword": { # Username and password pair. # Username and password credential
"password": "A String", # Password to be used
"username": "A String", # Username to be used
},
},
"description": "A String", # A description of the auth config.
"displayName": "A String", # Required. The name of the auth config.
"encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
"expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
"A String",
],
"lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
"overrideValidTime": "A String", # 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.
"reason": "A String", # The reason / details of the current status.
"state": "A String", # The status of the auth config.
"updateTime": "A String", # Output only. The timestamp when the auth config is modified.
"validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
"visibility": "A String", # The visibility of the auth config.
}