Authorizations
Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.
Path Parameters
Body
Type is a unique identifier of the AuthScheme, this is a kebab-case formatted string, see enum values for possible options.
none
, api-key
, basic-auth
, oauth2
, hmac
, jwt-bearer
, certificate
, oauth1
, secret
AuthSchemeConfigNone is a placeholder object with the schemeType set to none
. There is no other configuration
required.
AuthSchemeConfigAPIKey defines how a Connector uses an API key credential to authenticate with the system.
AuthSchemeConfigBasicAuth is a placeholder object with the schemeType set to basic-auth
. There is no other
configuration required.
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.
AuthSchemeConfigCertificate is a placeholder object with the schemeType set to certificate
.
There is no other config required
Response
Created
Type is a unique identifier of the AuthScheme, this is a kebab-case formatted string, see enum values for possible options.
none
, api-key
, basic-auth
, oauth2
, hmac
, jwt-bearer
, certificate
, oauth1
, secret
AuthSchemeConfigNone is a placeholder object with the schemeType set to none
. There is no other configuration
required.
AuthSchemeConfigAPIKey defines how a Connector uses an API key credential to authenticate with the system.
AuthSchemeConfigBasicAuth is a placeholder object with the schemeType set to basic-auth
. There is no other
configuration required.
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.
AuthSchemeConfigCertificate is a placeholder object with the schemeType set to certificate
.
There is no other config required