Loading...

REST API - Send an Email with a Pin for Two-Factor Authentication: GET

Sends an email with the pin for two-factor authentication to the email address for the username in the request.

Request

Syntax

GET <webservice>/Security/TwoFactorAuth/Pin?username={username} HTTP/1.1
Host: <host name>
Accept: application/xml

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Parameter

Description

username

The username of the account to which the email with the pin is sent.

Request Headers

Header

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Response

There is no data in the response. The request triggers an email to be sent to the user email address with the pin.

<Api_GenericResp/>

Examples

Example Request

GET <webservice>/Security/TwoFactorAuth/Pin?username=admin
Host: client.mydomain.com
Accept: application/xml

Example Responses

<Api_GenericResp/>

Last modified: 1/4/2019 4:50:52 AM