68 lines
1.7 KiB
Markdown
68 lines
1.7 KiB
Markdown
---
|
|
name: fdx-routes
|
|
description: Handle 6 OpenAPI operation(s) under /fdx for the fdx route group.
|
|
---
|
|
|
|
# fdx API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /fdx for the fdx route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### fdx_notifications
|
|
|
|
- Operation ID: `fdx_notifications`
|
|
- Route: `POST /fdx/notifications`
|
|
- Mode: WRITE
|
|
- Summary: Webhook receiver for fdx notifications
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_recipients
|
|
|
|
- Operation ID: `get_recipients`
|
|
- Route: `GET /fdx/recipients`
|
|
- Mode: READ
|
|
- Summary: Get Recipients
|
|
|
|
### fdx_consents_revoke
|
|
|
|
- Operation ID: `fdx_consents_revoke`
|
|
- Route: `PUT /fdx/consents/{consentId}/revocation`
|
|
- Mode: WRITE
|
|
- Summary: Revoke FDX Consent Grant
|
|
- Parameters:
|
|
- `consentId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### fdx_consents_revocation_get
|
|
|
|
- Operation ID: `fdx_consents_revocation_get`
|
|
- Route: `GET /fdx/consents/{consentId}/revocation`
|
|
- Mode: READ
|
|
- Summary: Retrieve FDX Consent Grant revocation records
|
|
- Parameters:
|
|
- `consentId` in `path` required
|
|
|
|
### fdx_consents_get
|
|
|
|
- Operation ID: `fdx_consents_get`
|
|
- Route: `GET /fdx/consents/{consentId}`
|
|
- Mode: READ
|
|
- Summary: Get FDX Consent Grant
|
|
- Parameters:
|
|
- `consentId` in `path` required
|
|
|
|
### get_recipient
|
|
|
|
- Operation ID: `get_recipient`
|
|
- Route: `GET /fdx/recipient/{recipientId}`
|
|
- Mode: READ
|
|
- Summary: Get Recipient
|
|
- Parameters:
|
|
- `recipientId` in `path` required
|
|
- `OAUTH-STATE-ID` in `header`
|