Product documentation
WebhookClaimSchema
Webhook claim-schema registration for token enrichment.
WebhookClaimSchema
Webhook claim-schema registration for token enrichment.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/webhook-claim-schemas | Webhook Claim Schema List | tenant:webhook-schemas.read |
GET | /api/v1/webhook-claim-schemas/{claimName} | Webhook Claim Schema Get | tenant:webhook-schemas.read |
PUT | /api/v1/webhook-claim-schemas/{claimName} | Webhook Claim Schema Put | tenant:webhook-schemas.write |
DELETE | /api/v1/webhook-claim-schemas/{claimName} | Webhook Claim Schema Delete | tenant:webhook-schemas.write |
Operation details
GET /api/v1/webhook-claim-schemas
Webhook Claim Schema List
- Operation ID:
webhookClaimSchemaList - Required scopes:
tenant:webhook-schemas.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | no | integer | |
cursor | query | no | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | ListEnvelopeWebhookClaimSchemaResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/webhook-claim-schemas/{claimName}
Webhook Claim Schema Get
- Operation ID:
webhookClaimSchemaGet - Required scopes:
tenant:webhook-schemas.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
claimName | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
PUT /api/v1/webhook-claim-schemas/{claimName}
Webhook Claim Schema Put
- Operation ID:
webhookClaimSchemaPut - Required scopes:
tenant:webhook-schemas.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
claimName | path | yes | string |
Request body (required): application/json → WebhookClaimSchemaUpsertRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/webhook-claim-schemas/{claimName}
Webhook Claim Schema Delete
- Operation ID:
webhookClaimSchemaDelete - Required scopes:
tenant:webhook-schemas.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
claimName | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |