POST /v1/accounts/{accountId}/resources/{resourceId}/qrcode

Validates the Verification Code provided by a user for the generated QR code.

Request

Base URL
https://api.usa.cloud.watchguard.com/rest/authpoint/authentication
Auth
API key in header WatchGuard-API-Key and HTTP bearer
TypeScript
https://skmtc.dev/watchguard/apis/authpoint-authentication-api/docs/v1/accounts/:accountId/resources/:resourceId/qrcode/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

Identifies your WatchGuard Cloud account. Example: WGC-1-123abc456 or ACC-1234567.

resourceIdnumber required

Identifies the API resource making the request.

Request body

loginstring required

Identifies the user to validate. This must be the email address or the user name of the user to validate.

qrCodeResponsestring required

The Verification Code that the user receives when they scan the QR code. When you generate a QR code and render it to show in the UI on the authentication page, a six digit Verification Code is generated.

transactionIdstring required

Identifies the QR code to validate.

originIpAddressstring

The end user IP address. The IP address must be in IPv4 format.

Response

Successful authentication response

authenticationResult'AUTHORIZED'

The authentication result

Changes

No recorded changes to this operation across all 1 revision of this API.