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

Validates the Forgot Token Verification Code and enables Forgot Token mode for the user.

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/forgottoken/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. You can see the resourceId on the RESTful API Client resource page.

Request body

loginstring required

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

passwordstring required

The password of the user to be validated. It must be filled in clear text.

verificationCodestring required

The Verification Code is the six digit value generated in the AuthPoint management UI and provided to the user by the operator. The user must provide this value.

activationCodestring required

The Activation Code value generated by the client application. This value can be any six digit string that consists of only numbers. This value must be visible to the end user so they can provide it to the AuthPoint operator.

intervalnumber required

The interval, in hours, that Forgot Token is active for the user. This value is defined by an operator in the AuthPoint management UI and provided to the user.

Response

Forgot token activated

authenticationResult'AUTHORIZED'

The activation result

Changes

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