Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 4.53 KB

File metadata and controls

22 lines (14 loc) · 4.53 KB

UpdateWebhookOAuthRequest

A partial update. Every field is optional and an omitted field is left as it is, so { \"clientSecret\": \"new-secret\" } rotates the secret and changes nothing else. A rotation applies to every webhook referencing these credentials. The three custom maps merge: a key with a value is upserted, a key with null is deleted, a key you leave out is untouched. Because null inside a map means delete, none of the three is nullable as a whole — customJwtClaims: null and friends are rejected with a 400. Clear a map by naming each key with a null value. mtlsClientSignedCert is a scalar, so null there does remove it.

Properties

Name Type Description Notes
name String A label for this credential set. Omit to leave it unchanged. [optional]
clientId String OAuth client ID. Omit to leave it unchanged. [optional]
clientSecret String A new OAuth client secret. Limited to 480 bytes when UTF-8 encoded, so a secret using non-ASCII characters fits fewer than 480 of them. Write-only — never returned in any response. Send this on its own to rotate the secret without changing anything else. Omit to leave it unchanged. [optional]
url String Token endpoint URL. HTTPS on port 443 only, and the host must resolve publicly. Omit to leave it unchanged. [optional]
authMethod String `client_secret_basic`, `client_secret_post` or `client_secret_jwt`. Omit to leave it unchanged — it does not revert to the default. [optional]
customJwtClaims Map<String, Object> A delta applied to the JWT assertion claims. A claim with a value is added or replaced, a claim with `null` is deleted, and a claim you leave out is untouched. So `{ &quot;aud&quot;: &quot;https://auth.example.com\", &quot;resource&quot;: null }` sets `aud`, drops `resource`, and changes nothing else. Send `customJwtClaims: null` to clear every claim in one call. That does not collide with a `null` value on a name: one names the claim to delete, the other names the whole field. Same rules as on create: any JSON type except `null`, `iss`/`sub`/`jti`/`iat`/`exp` reserved, names case-sensitive, resulting set under 16 KB, values write-only. [optional]
customBodyParams Map<String, String> A delta applied to the token request body parameters. A parameter with a value is added or replaced, a parameter with `null` is deleted, and one you leave out is untouched. So `{ &quot;scope&quot;: &quot;payments.read&quot;, &quot;audience&quot;: null }` sets `scope`, drops `audience`, and changes nothing else. Send `customBodyParams: null` to clear every parameter in one call. That does not collide with a `null` value on a name: one names the parameter to delete, the other names the whole field. Same rules as on create: string values only, `grant_type`/`client_id`/`client_secret`/ `client_assertion`/`client_assertion_type` reserved, names case-sensitive, resulting set under 16 KB, values write-only. [optional]
customHeaders Map<String, String> A delta applied to the token request headers — not the webhook delivery headers. A header with a value is added or replaced, a header with `null` is deleted, and one you leave out is untouched. So `{ &quot;X-Api-Key&quot;: &quot;new-key&quot;, &quot;X-Tenant&quot;: null }` rotates `X-Api-Key`, drops `X-Tenant`, and changes nothing else. Send `customHeaders: null` to clear every header in one call. That does not collide with a `null` value on a name: one names the header to delete, the other names the whole field. Names are case-insensitive, so a `null` under one casing deletes a header stored under another, and names are stored and returned lowercased. Same rules as on create: string values only, `Content-Type`/`Authorization`/ `Content-Length`/`Host` reserved, resulting set under 16 KB, values write-only. [optional]
mtlsClientSignedCert String PEM-encoded client certificate for mTLS. Must be a valid X.509 certificate inside its validity window. Omit to leave it unchanged, or send `null` to remove it. [optional]