Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 2.39 KB

File metadata and controls

20 lines (14 loc) · 2.39 KB

CreateWebhookOauthRequest

Properties

Name Type Description Notes
name string A label for this credential set, shown when listing them. [default to undefined]
clientId string OAuth client ID used to authenticate with the token endpoint. [default to undefined]
clientSecret string OAuth client secret. Write-only — never returned. Limited to 480 bytes UTF-8 encoded. With `client_secret_jwt` it signs the assertion rather than being sent. [default to undefined]
url string Token endpoint URL. HTTPS on port 443 only, and the host must resolve publicly — localhost and private, link-local or loopback addresses are rejected. [default to undefined]
authMethod string How the client credentials reach the token endpoint. `client_secret_basic` uses an HTTP Basic header, `client_secret_post` uses form fields in the body, and `client_secret_jwt` sends a JWT assertion signed with the secret, so the secret itself is never transmitted. Defaults to `client_secret_basic`. [optional] [default to 'client_secret_basic']
customJwtClaims WebhookOauthCustomJwtClaims [optional] [default to undefined]
customBodyParams WebhookOauthCustomBodyParams [optional] [default to undefined]
customHeaders WebhookOauthCustomHeaders [optional] [default to undefined]
webhookMtlsId string The id of the mTLS configuration presented to the token endpoint, from `/v1/webhooks_settings/mtls`. It can be the same configuration a webhook uses, so one certificate, signed from `GET /v1/webhooks_settings/mtls_csr`, serves both the token endpoint and the receiver. Omit, or send `null`, for a token request without mTLS. Requires the mTLS feature to be enabled for the workspace (`403` otherwise), a configuration of this workspace (`404` otherwise), and one linked to a private key (`400` otherwise). [optional] [default to undefined]

[Back to top] [Back to API list] [Back to Model list] [Back to README]