Skip to main content

REST API (OAuth 2.0)

Connect to a REST API using an OAuth 2.0 client credential

To use this connection type within the API, use a ConnectionTypeCode of REST-OAUTH2.

Variable Reference​

The following variables are supported:

  • RestServiceBaseUrl - (Required) The Base URL of the REST Service.

  • RestServiceTokenEndpointSecretName - (Required) The name of the Key Vault Secret containing the Token Endpoint for OAuth2 Authentication against the REST Service.

  • RestServiceClientIdSecretName - (Required) The name of the Key Vault Secret containing the Client Id for OAuth2 Authentication against the REST Service.

  • RestServiceClientSecretSecretName - (Required) The name of the Key Vault Secret containing the Client Secret for OAuth2 Authentication against the REST Service.

  • RestServiceResource - (Optional) The resource to use when retrieving the token for OAUth2 client_credentials flow

  • RestServiceScope - (Optional) The scope to use when retrieving the token for OAUth2 client_credentials flow

  • IntegrationRuntime - (Required) Integration Runtime to use for Copy Activity.