Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 5.58 KB

UpdateWebhookOauthRequest.md

File metadata and controls

38 lines (29 loc) · 5.58 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, and the whole field set to null clears the map. There is no ambiguity between the two uses of null — one names an entry, the other names the field. webhookMtlsId is a scalar, so null there removes it.

Properties

Name Type Description Notes
name str A label for this credential set. Omit to leave it unchanged. [optional]
client_id str OAuth client ID. Omit to leave it unchanged. [optional]
client_secret str 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 str Token endpoint URL. HTTPS on port 443 only, and the host must resolve publicly. Omit to leave it unchanged. [optional]
auth_method str `client_secret_basic`, `client_secret_post` or `client_secret_jwt`. Omit to leave it unchanged — it does not revert to the default. [optional]
custom_jwt_claims Dict[str, 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 `{ "aud": "https://auth.example.com\", "resource": 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]
custom_body_params Dict[str, Optional[str]] 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 `{ "scope": "payments.read", "audience": 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]
custom_headers Dict[str, Optional[str]] 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 `{ "X-Api-Key": "new-key", "X-Tenant": 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`, `Content-Length` and `Host` reserved, `Authorization` only with `client_secret_post` or `client_secret_jwt`, resulting set under 16 KB, values write-only. [optional]
webhook_mtls_id str The id of the mTLS configuration presented to the token endpoint, from `/v1/webhooks_settings/mtls`. Omit to leave it unchanged, or send `null` to stop using mTLS for the token request. 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]

Example

from fireblocks.models.update_webhook_oauth_request import UpdateWebhookOauthRequest

# TODO update the JSON string below
json = "{}"
# create an instance of UpdateWebhookOauthRequest from a JSON string
update_webhook_oauth_request_instance = UpdateWebhookOauthRequest.from_json(json)
# print the JSON string representation of the object
print(UpdateWebhookOauthRequest.to_json())

# convert the object into a dict
update_webhook_oauth_request_dict = update_webhook_oauth_request_instance.to_dict()
# create an instance of UpdateWebhookOauthRequest from a dict
update_webhook_oauth_request_from_dict = UpdateWebhookOauthRequest.from_dict(update_webhook_oauth_request_dict)

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