FidoTokensApi
| Method | HTTP request | Description |
|---|---|---|
| completeCreateFIDOTokenUsingPOST | POST /api/web/v1/fidotokens/complete/{id} | Complete FIDO token registration |
| deleteFIDOTokenUsingDELETE | DELETE /api/web/v1/fidotokens/{fidoid} | Delete a FIDO token |
| getFIDOTokenUsingGET | GET /api/web/v1/fidotokens/{fidoid} | Get a FIDO token |
| startCreateFIDOTokenUsingGET | GET /api/web/v1/fidotokens/challenge/{id} | Start FIDO token registration |
| updateFIDOTokenUsingPUT | PUT /api/web/v1/fidotokens/{fidoid} | Update a FIDO token |
completeCreateFIDOTokenUsingPOST
FIDOToken completeCreateFIDOTokenUsingPOST(id, fiDORegisterResponse)
Complete FIDO token registration
Complete FIDO token registration for the specified user. Caller requires the FIDOTOKENS:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the user for which the fido token is to be created. | |
| fiDORegisterResponse | FIDORegisterResponse |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
deleteFIDOTokenUsingDELETE
deleteFIDOTokenUsingDELETE(fidoid)
Delete a FIDO token
Delete the specified FIDO token. Caller requires the FIDOTOKENS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| fidoid | String | The UUID of the FIDO token to be deleted. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getFIDOTokenUsingGET
FIDOToken getFIDOTokenUsingGET(fidoid)
Get a FIDO token
Get the specified FIDO token. Caller requires the FIDOTOKENS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| fidoid | String | The UUID of the FIDO token to be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
startCreateFIDOTokenUsingGET
FIDORegisterChallenge startCreateFIDOTokenUsingGET(id)
Start FIDO token registration
Start FIDO token registration for the specified user. Caller requires the FIDOTOKENS:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the user for which the fido token is to be created. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateFIDOTokenUsingPUT
updateFIDOTokenUsingPUT(fidoid, fiDOTokenParms)
Update a FIDO token
Update the specified FIDO token. Caller requires the FIDOTOKENS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| fidoid | String | The UUID of the FIDO token to be changed. | |
| fiDOTokenParms | FIDOTokenParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |