Update an authentication provider for workflows
Updates an authentication provider that is used for Workflow tasks and supported integrations. Only supplied fields are changed. The auth_type field cannot be changed after creation.
Request
- Base URL: https://rest.test.zuora.com
- URL: https://rest.test.zuora.com/auth_providers/{provider_id}
- Auth: HTTP bearer
Path parameters
Identifier of the authentication provider to update.
Headers
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.
With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.
If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.
Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.
The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').
The minor API version.
For a list of available minor versions, see API upgrades.
Request body
Example request
{
"auth_provider": {
"name": "prod-s3-updated",
"description": "Updated production S3 credentials",
"credentials": {
"username": "api-user",
"password": "api-secret-password",
"access_key": "AKIAEXAMPLE",
"secret_key": "your-secret-key",
"region": "us-west-2",
"site": "https://example.com",
"client_id": "my-client-id",
"client_secret": "my-client-secret",
"grant_type": "Client Credentials",
"redirect_uri": "https://example.com/oauth/callback",
"auth_params": "{\"audience\":\"https://example.com\"}",
"auth_header_name": "X-Custom-Authorization",
"auth_header_value": "custom-value",
"consumer_key": "consumer-key",
"consumer_secret": "consumer-secret",
"signature_method": "HMAC-SHA1",
"token": "access-token",
"token_secret": "token-secret",
"ns_account": "1234567",
"algorithm": "sha256",
"key": "hmac-key",
"secret": "hmac-secret",
"data": "payload-to-sign",
"signed_header_key": "X-Signature",
"signed_header_value": "signed-value"
}
}
}Response
Authentication provider updated successfully.
Example response
{
"status": "updated"
}Changes
No operation changes recorded.