Skip to main content

FIDOTokensApi

MethodHTTP requestDescription
CompleteCreateFIDOTokenUsingPOSTPOST /api/web/v1/fidotokens/complete/{id}Complete FIDO token registration
DeleteFIDOTokenUsingDELETEDELETE /api/web/v1/fidotokens/{fidoid}Delete a FIDO token
GetFIDOTokenUsingGETGET /api/web/v1/fidotokens/{fidoid}Get a FIDO token
StartCreateFIDOTokenUsingGETGET /api/web/v1/fidotokens/challenge/{id}Start FIDO token registration
UpdateFIDOTokenUsingPUTPUT /api/web/v1/fidotokens/{fidoid}Update a FIDO token

CompleteCreateFIDOTokenUsingPOST

FIDOToken CompleteCreateFIDOTokenUsingPOST (string id, FIDORegisterResponse fIDORegisterResponse)

Complete FIDO token registration

Complete FIDO token registration for the specified user. Caller requires the FIDOTOKENS:ADD permission.

Using the CompleteCreateFIDOTokenUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe UUID of the user for which the fido token is to be created.
fIDORegisterResponseFIDORegisterResponse

Return type

FIDOToken

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

DeleteFIDOTokenUsingDELETE

void DeleteFIDOTokenUsingDELETE (string fidoid)

Delete a FIDO token

Delete the specified FIDO token. Caller requires the FIDOTOKENS:REMOVE permission.

Example

Using the DeleteFIDOTokenUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
fidoidstringThe UUID of the FIDO token to be deleted.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

GetFIDOTokenUsingGET

FIDOToken GetFIDOTokenUsingGET (string fidoid)

Get a FIDO token

Get the specified FIDO token. Caller requires the FIDOTOKENS:VIEW permission.

Example

Using the GetFIDOTokenUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
fidoidstringThe UUID of the FIDO token to be retrieved.

Return type

FIDOToken

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

StartCreateFIDOTokenUsingGET

FIDORegisterChallenge StartCreateFIDOTokenUsingGET (string id)

Start FIDO token registration

Start FIDO token registration for the specified user. Caller requires the FIDOTOKENS:ADD permission.

Example

Using the StartCreateFIDOTokenUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe UUID of the user for which the fido token is to be created.

Return type

FIDORegisterChallenge

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

UpdateFIDOTokenUsingPUT

void UpdateFIDOTokenUsingPUT (string fidoid, FIDOTokenParms fIDOTokenParms)

Update a FIDO token

Update the specified FIDO token. Caller requires the FIDOTOKENS:EDIT permission.

Example

Using the UpdateFIDOTokenUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
fidoidstringThe UUID of the FIDO token to be changed.
fIDOTokenParmsFIDOTokenParms

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-