Get Two-Factor Auth Setup
Gets the barcode and secret required for setting up two-factor authentication for the Account.
SecuritybearerAuth and hubAuth
Responses
200
Returns necessary information for configuring two-factor auth for the Account.
default
General error response from the platform
get/v1/account/2fa/setup
Response samples
- 200
- default
application/json
{- "data": {
- "qr": "string",
- "secret": "string"
}
}Disable Two-Factor Auth
Disables two-factor auth for the account.
SecuritybearerAuth and hubAuth
Request
Responses
200
Returns the Account.
default
General error response from the platform
post/v1/account/2fa/disable
Request samples
- Payload
application/json
{- "token": "string"
}Response samples
- 200
- default
application/json
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string",
- "verified": true,
- "added": "2021-01-30T08:30:00Z"
}, - "two_factor_auth": {
- "verified": true
}, - "allow_support_login": true,
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}
}Recover Two-Factor Auth
Returns a new two-factor auth setup to reset the Account's two-factor auth.
SecuritybearerAuth and hubAuth
Request
Responses
200
Returns details for setting up two-factor auth.
default
General error response from the platform
post/v1/account/2fa/recover
Request samples
- Payload
application/json
{- "email": "string",
- "password": "string",
- "recovery_codes": [
- "string"
], - "token": "string"
}Response samples
- 200
- default
application/json
{- "data": {
- "qr": "string",
- "secret": "string"
}
}