Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 3.3 KB

WebhookOauthCredentials.md

File metadata and controls

40 lines (31 loc) · 3.3 KB

WebhookOauthCredentials

A stored OAuth 2.0 client credential set, referenced by webhooks through their webhookOauthId. Deliveries for a webhook that references one carry Authorization: Bearer {token}, using a token fetched from url and cached until it expires, so your authorization server sees far fewer token requests than deliveries. Secret material is never returned: clientSecret is absent from this schema entirely, and the customJwtClaims, customBodyParams and customHeaders fields are reduced to their names, without the configured values.

Properties

Name Type Description Notes
id str The id of the OAuth credentials. Pass this as a webhook's `webhookOauthId` to attach them.
name str The label given to this credential set.
client_id str OAuth client ID used to authenticate with the token endpoint.
url str Token endpoint URL.
auth_method str How the client credentials are presented to the token endpoint: `client_secret_basic`, `client_secret_post` or `client_secret_jwt`. Credentials created without this field report `client_secret_basic`, which is what they use. [default to 'client_secret_basic']
custom_jwt_claims List[str] Names of the additional claims placed in the JWT assertion. Claim values are write-only and are never returned. Absent when no custom claims are configured. [optional]
custom_body_params List[str] Names of the additional parameters added to the token request body. Parameter values are write-only and are never returned. Absent when no custom parameters are configured. [optional]
custom_headers List[str] Names of the additional HTTP headers added to the token request sent to the authorization server — not to the webhook delivery, which has its own separate `customHeaders`. Header values are write-only and are never returned. Absent when no custom headers are configured. [optional]
webhook_mtls_id str The id of the mTLS configuration presented to the token endpoint. Absent when the token request does not use mTLS. Read the certificate from `/v1/webhooks_settings/mtls/{id}`. [optional]
created_at int The date and time the OAuth credentials were created, in milliseconds.
updated_at int The date and time the OAuth credentials were last updated, in milliseconds.

Example

from fireblocks.models.webhook_oauth_credentials import WebhookOauthCredentials

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

# convert the object into a dict
webhook_oauth_credentials_dict = webhook_oauth_credentials_instance.to_dict()
# create an instance of WebhookOauthCredentials from a dict
webhook_oauth_credentials_from_dict = WebhookOauthCredentials.from_dict(webhook_oauth_credentials_dict)

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