101 lines
3.1 KiB
Markdown
101 lines
3.1 KiB
Markdown
---
|
|
name: current-user-routes
|
|
description: Handle 10 OpenAPI operation(s) under /v2.1/current_user for the current user route group.
|
|
---
|
|
|
|
# current user API Routes
|
|
|
|
Handle 10 OpenAPI operation(s) under /v2.1/current_user for the current user 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
|
|
|
|
### notary_get_notary
|
|
|
|
- Operation ID: `notary_get_notary`
|
|
- Route: `GET /v2.1/current_user/notary`
|
|
- Mode: READ
|
|
- Summary: Gets settings for a notary user.
|
|
- Parameters:
|
|
- `include_jurisdictions` in `query`
|
|
|
|
### notary_put_notary
|
|
|
|
- Operation ID: `notary_put_notary`
|
|
- Route: `PUT /v2.1/current_user/notary`
|
|
- Mode: WRITE
|
|
- Summary: Updates notary information for the current user.
|
|
- Body: JSON request body accepted.
|
|
|
|
### notary_post_notary
|
|
|
|
- Operation ID: `notary_post_notary`
|
|
- Route: `POST /v2.1/current_user/notary`
|
|
- Mode: WRITE
|
|
- Summary: Registers the current user as a notary.
|
|
- Body: JSON request body accepted.
|
|
|
|
### notary_journals_get_notary_journals
|
|
|
|
- Operation ID: `notary_journals_get_notary_journals`
|
|
- Route: `GET /v2.1/current_user/notary/journals`
|
|
- Mode: READ
|
|
- Summary: Gets notary jurisdictions for a user.
|
|
- Parameters:
|
|
- `count` in `query`
|
|
- `search_text` in `query`
|
|
- `start_position` in `query`
|
|
|
|
### notary_jurisdictions_get_notary_jurisdictions
|
|
|
|
- Operation ID: `notary_jurisdictions_get_notary_jurisdictions`
|
|
- Route: `GET /v2.1/current_user/notary/jurisdictions`
|
|
- Mode: READ
|
|
- Summary: Returns a list of jurisdictions that the notary is registered in.
|
|
|
|
### notary_jurisdictions_post_notary_jurisdictions
|
|
|
|
- Operation ID: `notary_jurisdictions_post_notary_jurisdictions`
|
|
- Route: `POST /v2.1/current_user/notary/jurisdictions`
|
|
- Mode: WRITE
|
|
- Summary: Creates a jurisdiction object.
|
|
- Body: JSON request body accepted.
|
|
|
|
### notary_jurisdictions_get_notary_jurisdiction
|
|
|
|
- Operation ID: `notary_jurisdictions_get_notary_jurisdiction`
|
|
- Route: `GET /v2.1/current_user/notary/jurisdictions/{jurisdictionId}`
|
|
- Mode: READ
|
|
- Summary: Gets a jurisdiction object for the current user. The user must be a notary.
|
|
- Parameters:
|
|
- `jurisdictionId` in `path` required
|
|
|
|
### notary_jurisdictions_put_notary_jurisdiction
|
|
|
|
- Operation ID: `notary_jurisdictions_put_notary_jurisdiction`
|
|
- Route: `PUT /v2.1/current_user/notary/jurisdictions/{jurisdictionId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates the jurisdiction information about a notary.
|
|
- Parameters:
|
|
- `jurisdictionId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### notary_jurisdictions_delete_notary_jurisdiction
|
|
|
|
- Operation ID: `notary_jurisdictions_delete_notary_jurisdiction`
|
|
- Route: `DELETE /v2.1/current_user/notary/jurisdictions/{jurisdictionId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the specified jurisdiction.
|
|
- Parameters:
|
|
- `jurisdictionId` in `path` required
|
|
|
|
### password_rules_get_password_rules
|
|
|
|
- Operation ID: `password_rules_get_password_rules`
|
|
- Route: `GET /v2.1/current_user/password_rules`
|
|
- Mode: READ
|
|
- Summary: Gets membership account password rules.
|