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

Returns whether the user can authenticate and which authentication methods they can use (Push, QR code, and OTP).

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/authenticationpolicy/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.

originIpAddressstring

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

Response

Successful request of the authentication policies

usernamestring

The user name of the user to validate.

emailstring

The email address of the user to validate.

hasPolicyboolean

Indicates if the user belongs to a group that has an access policy for this RESTful API Client resource.

isAllowedToAuthenticateboolean

Indicates if the user can authenticate.

isInSafeLocationboolean

Indicates if the user is in a safe location based on the originIpAddress sent in the request body and the safe locations configured for the user's AuthPoint group.

isInForgotTokenboolean

Indicates if the user has the Forgot Token feature activated.

isBlockedboolean

Indicates if the user is blocked. Blocked users cannot authenticate.

isOverallocatedboolean

Indicates if the user is overallocated. Overallocated users cannot authenticate.

isInQuarantineboolean

Indicates if the user is quarantined. Quarantined users cannot authenticate.

Changes

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