Cloud Administration Enable Emergency Tokencode API Version 1

This API enables an Emergency Tokencode for a single user. For more information about Emergency Tokencode, see Supported Authentication Methods - Emergency Tokencode.

For information about managing access to this API, see Accessing the Cloud Administration APIs.

Note:  If the Online Emergency Access Code (EAC) configuration is locked at the company level in the Company Settings, any values sent in the request are overridden by the company-level settings. For better visibility into the configurations used to generate the Online EAC, see Cloud Administration Enable Emergency Tokencode API Version 2. To configure EAC settings at the company level, see Configure Session and Authentication Method Settings

Authentication

Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration REST APIs.

Software Developer Kit

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to enable emergency tokencode for a user. The <userId> is a unique user identifier that is returned in the response to the Cloud Administration User Details API.

Request Parameters

This API requires the following parameter.

Example Request Body

The following example displays a request.

{

"expirationDays": "7"

}

Example Response Body

The following example displays a response body.

{

"emergencyTokencodeId": "f10d0514-7dd1-4a13-a30e-236d0e65b56a",

"emergencyTokencode": "<emergency tokencode>",

"expirationDate" : "2018-09-06T15:34:44.000Z"

"offlineExpirationDate" : "2018-30-06T12:00:00.000Z"

}

Response Property Descriptions

The following table describes the response properties and data types.

Response Codes

This API returns the following response codes.