Adds or updates an auth scheme for the system.
UpsertAuthSchemeConfig adds or updates an auth scheme for the system. If the auth scheme ID provided doesn’t match any of the record, it will be created. If the auth scheme ID provided matches an existing record, it will be updated. The ID in the path needs to match the ID in the body.
Authorizations
Path Parameters
Body
An AuthSchemeConfig describes how credentials should be used to authenticate with a System, an example being where
an API key should be sent and what the header/query parameter/cookie name is. For OAuth2, this config object also
contains data such as the token URL, client ID and secret, and scopes to request.
This type contains a string called type which denotes which field in this object should be populated.
For example if the type is api-key, then the apiKey field will be populated with an
AuthSchemeConfigAPIKey object.
AuthSchemeConfigOAuth2 defines how a Connector uses an OAuth2 credential to authenticate
with the system. This is to be used for all OAuth 2.0 flows which require a client ID and
client secret as part of the Connector's configuration. Connectors which use the
client_credentials grant type, where the user provides the Client ID and Client Secret at
the point where they connect, should use the AuthSchemeConfigOAuth2ClientCredentials type
instead.
AuthSchemeConfigHMAC defines how a Connector uses an HMAC credential to authenticate with the system.
This may be used on outbound requests to sign the request body, however it is more commonly used on inbound requests (i.e. from Webhook Triggers) to verify the sender of the request is allowed to invoke the Trigger.
Response
Created
An AuthSchemeConfig describes how credentials should be used to authenticate with a System, an example being where
an API key should be sent and what the header/query parameter/cookie name is. For OAuth2, this config object also
contains data such as the token URL, client ID and secret, and scopes to request.
This type contains a string called type which denotes which field in this object should be populated.
For example if the type is api-key, then the apiKey field will be populated with an
AuthSchemeConfigAPIKey object.
AuthSchemeConfigOAuth2 defines how a Connector uses an OAuth2 credential to authenticate
with the system. This is to be used for all OAuth 2.0 flows which require a client ID and
client secret as part of the Connector's configuration. Connectors which use the
client_credentials grant type, where the user provides the Client ID and Client Secret at
the point where they connect, should use the AuthSchemeConfigOAuth2ClientCredentials type
instead.
AuthSchemeConfigHMAC defines how a Connector uses an HMAC credential to authenticate with the system.
This may be used on outbound requests to sign the request body, however it is more commonly used on inbound requests (i.e. from Webhook Triggers) to verify the sender of the request is allowed to invoke the Trigger.