5.4 KiB
5.4 KiB
name, description
| name | description |
|---|---|
| authenticators-routes | Handle 18 OpenAPI operation(s) under /api/v1/authenticators for the authenticators route group. |
authenticators API Routes
Handle 18 OpenAPI operation(s) under /api/v1/authenticators for the authenticators 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
list_authenticators
- Operation ID:
list_authenticators - Route:
GET /api/v1/authenticators - Mode: READ
- Summary: List all authenticators
create_authenticator
- Operation ID:
create_authenticator - Route:
POST /api/v1/authenticators - Mode: WRITE
- Summary: Create an authenticator
- Parameters:
activateinquery
- Body: JSON request body accepted.
get_authenticator
- Operation ID:
get_authenticator - Route:
GET /api/v1/authenticators/{authenticatorId} - Mode: READ
- Summary: Retrieve an authenticator
- Parameters:
authenticatorIdinpathrequired
replace_authenticator
- Operation ID:
replace_authenticator - Route:
PUT /api/v1/authenticators/{authenticatorId} - Mode: WRITE
- Summary: Replace an authenticator
- Parameters:
authenticatorIdinpathrequired
- Body: JSON request body accepted.
list_all_custom_aagui_ds
- Operation ID:
list_all_custom_aagui_ds - Route:
GET /api/v1/authenticators/{authenticatorId}/aaguids - Mode: READ
- Summary: List all custom AAGUIDs
- Parameters:
authenticatorIdinpathrequired
create_custom_aaguid
- Operation ID:
create_custom_aaguid - Route:
POST /api/v1/authenticators/{authenticatorId}/aaguids - Mode: WRITE
- Summary: Create a custom AAGUID
- Parameters:
authenticatorIdinpathrequired
- Body: JSON request body accepted.
get_custom_aaguid
- Operation ID:
get_custom_aaguid - Route:
GET /api/v1/authenticators/{authenticatorId}/aaguids/{aaguid} - Mode: READ
- Summary: Retrieve a custom AAGUID
- Parameters:
authenticatorIdinpathrequiredaaguidinpathrequired
replace_custom_aaguid
- Operation ID:
replace_custom_aaguid - Route:
PUT /api/v1/authenticators/{authenticatorId}/aaguids/{aaguid} - Mode: WRITE
- Summary: Replace a custom AAGUID
- Parameters:
authenticatorIdinpathrequiredaaguidinpathrequired
- Body: JSON request body accepted.
update_custom_aaguid
- Operation ID:
update_custom_aaguid - Route:
PATCH /api/v1/authenticators/{authenticatorId}/aaguids/{aaguid} - Mode: WRITE
- Summary: Update a custom AAGUID
- Parameters:
authenticatorIdinpathrequiredaaguidinpathrequired
- Body: JSON request body accepted.
delete_custom_aaguid
- Operation ID:
delete_custom_aaguid - Route:
DELETE /api/v1/authenticators/{authenticatorId}/aaguids/{aaguid} - Mode: WRITE
- Summary: Delete a custom AAGUID
- Parameters:
authenticatorIdinpathrequiredaaguidinpathrequired
activate_authenticator
- Operation ID:
activate_authenticator - Route:
POST /api/v1/authenticators/{authenticatorId}/lifecycle/activate - Mode: WRITE
- Summary: Activate an authenticator
- Parameters:
authenticatorIdinpathrequired
deactivate_authenticator
- Operation ID:
deactivate_authenticator - Route:
POST /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate - Mode: WRITE
- Summary: Deactivate an authenticator
- Parameters:
authenticatorIdinpathrequired
list_authenticator_methods
- Operation ID:
list_authenticator_methods - Route:
GET /api/v1/authenticators/{authenticatorId}/methods - Mode: READ
- Summary: List all methods of an authenticator
- Parameters:
authenticatorIdinpathrequired
get_authenticator_method
- Operation ID:
get_authenticator_method - Route:
GET /api/v1/authenticators/{authenticatorId}/methods/{methodType} - Mode: READ
- Summary: Retrieve an authenticator method
- Parameters:
authenticatorIdinpathrequiredmethodTypeinpathrequired
replace_authenticator_method
- Operation ID:
replace_authenticator_method - Route:
PUT /api/v1/authenticators/{authenticatorId}/methods/{methodType} - Mode: WRITE
- Summary: Replace an authenticator method
- Parameters:
authenticatorIdinpathrequiredmethodTypeinpathrequired
- Body: JSON request body accepted.
activate_authenticator_method
- Operation ID:
activate_authenticator_method - Route:
POST /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/activate - Mode: WRITE
- Summary: Activate an authenticator method
- Parameters:
authenticatorIdinpathrequiredmethodTypeinpathrequired
deactivate_authenticator_method
- Operation ID:
deactivate_authenticator_method - Route:
POST /api/v1/authenticators/{authenticatorId}/methods/{methodType}/lifecycle/deactivate - Mode: WRITE
- Summary: Deactivate an authenticator method
- Parameters:
authenticatorIdinpathrequiredmethodTypeinpathrequired
verify_rp_id_domain
- Operation ID:
verify_rp_id_domain - Route:
POST /api/v1/authenticators/{authenticatorId}/methods/{webAuthnMethodType}/verify-rp-id-domain - Mode: WRITE
- Summary: Verify a Relying Party ID domain
- Parameters:
authenticatorIdinpathrequiredwebAuthnMethodTypeinpathrequired