EnterpriseAuthentication

Create an MFA key

Generate and store a MFA key for the requesting user. After this call, the MFA key has the status `activation pending` and must be activated through a separate call (`/api/v1/user/mfa/{id}`). You must provide following fields with this request: * `type` (Object required) - `id` (Number) * `password` (String required) - User password The **MFA key** object returned by the server contains the following properties: * `id` (Integer) - The unique ID of this MFA key * `status` (Object) ID (Integer) - Id of status of this MFA key - `description` (String) - description of the status * `type` (Object) ID (Integer) - Id of type of this MFA key - `description` (String) - description of the type * `secret_key` (String) - Secret key (encoded in Base32) for this MFA key, will be displayed only on creation * `otpauth` (String) - Secret key as a URI encoded for QR codes, will be displayed only on creation * `creation_date` (Timestamp) - Timestamp when this MFA key was created - type: ISO 8601 timestamp format * `activation_date` (Timestamp) - Timestamp when this MFA key was activated - type: ISO 8601 timestamp format

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Request

This endpoint expects an object.
typeobjectRequired
passwordstringRequired

Response

Success
iddouble or null
statusobject or null
typeobject or null
secret_keystring or null
otpauthstring or null
creation_datestring or null

Errors