Authentication tools
Arguments, results, errors, and access, confirmation, and retry policy for each Authentication tool in FloPay MCP, from the reviewed API contract.
Authentication tools
Generated from the FloPay MCP contract version 1, revision cc71a476426ea531d369de5441cde85ab81ab52c9764406e5f09501857d7ed32.
ApiToken_create
Create a client-scoped API token
| Policy | Value |
|---|---|
| Operation | POST /v1/api-tokens |
| Class | mutating |
| Risk | critical |
| Confirmation | required |
| Retry | same-idempotency-key |
| Rate-limit tier | restricted |
| Roles | owner, admin, member |
| Scopes | mcp:write |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
description | body | string | No | Maximum length: 255. |
name | body | string | Yes | Minimum length: 1. Maximum length: 100. |
Result
Returns 201 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | Yes | |
description | string or null | Yes | Maximum length: 255. |
id | string (uuid) | Yes | |
lastUsedAt | string (date-time) or null | Yes | Most recently recorded successful authentication time; null means no successful use has been recorded. |
name | string | Yes | Maximum length: 100. |
token | string | Yes | The usable secret. It is returned only by this create operation. |
Errors
| Status | Description |
|---|---|
401 | A valid OAuth client_user access token is required. |
409 | The active-token limit has been reached. |
ApiToken_get
Read one of the caller’s API tokens for the selected client
| Policy | Value |
|---|---|
| Operation | GET /v1/api-tokens/{id} |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | The API token id. |
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | Yes | |
description | string or null | Yes | Maximum length: 255. |
id | string (uuid) | Yes | |
lastUsedAt | string (date-time) or null | Yes | Most recently recorded successful authentication time; null means no successful use has been recorded. |
name | string | Yes | Maximum length: 100. |
Errors
| Status | Description |
|---|---|
401 | A valid OAuth client_user access token is required. |
ApiToken_list
List the caller’s active API tokens for the selected client
| Policy | Value |
|---|---|
| Operation | GET /v1/api-tokens |
| Class | read-only |
| Risk | low |
| Confirmation | not-required |
| Retry | safe |
| Rate-limit tier | read |
| Roles | owner, admin, member |
| Scopes | mcp:read |
Arguments
This tool takes no arguments.
Result
Returns 200 with a JSON body.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | |
data[].createdAt | string (date-time) | Yes | |
data[].description | string or null | Yes | Maximum length: 255. |
data[].id | string (uuid) | Yes | |
data[].lastUsedAt | string (date-time) or null | Yes | Most recently recorded successful authentication time; null means no successful use has been recorded. |
data[].name | string | Yes | Maximum length: 100. |
Errors
| Status | Description |
|---|---|
401 | A valid OAuth client_user access token is required. |
ApiToken_revoke
Revoke one of the caller’s API tokens for the selected client
| Policy | Value |
|---|---|
| Operation | DELETE /v1/api-tokens/{id} |
| Class | mutating |
| Risk | high |
| Confirmation | required |
| Retry | same-idempotency-key |
| Rate-limit tier | restricted |
| Roles | owner, admin, member |
| Scopes | mcp:write |
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | The API token id. |
Result
Returns 204 with no body. The API token was revoked.
Errors
| Status | Description |
|---|---|
401 | A valid OAuth client_user access token is required. |
Tool reference
Every tool FloPay MCP serves, generated from the reviewed API contract, with its operation, class, risk, and required scopes, grouped by product area.
Disputes tools
Arguments, results, errors, and access, confirmation, and retry policy for each Disputes tool in FloPay MCP, from the reviewed API contract.