[{"label":"Latest (v1.0)","version":"latest"}]
csp
Update Principal MFA
DescriptionUpdate user MFA for principal account (currently supported attributes are “turnedOn”.
Principal user is identified via a token. The token should be passed in a header called csp-auth-token.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| All Roles | ✔️ | ❌ |
Request
URLURL
https://{api_host}/csp/gateway/iam/vmwid/api/principal/mfa
Request Body
Request Body
{
"password": "string",
"turnedOn": false
}
string
password
Required
boolean
turnedOn
Required
Authentication
This operation uses the following authentication methods.
Errors
Errors
CspErrorResponse
400
Password was not provided
CspErrorResponse
401
Unauthenticated User
CspErrorResponse
403
Wrong password provided
CspErrorResponse
404
No user with given token exists | MFA details for principal user were not found
CspErrorResponse
409
The request could not be processed due to a conflict
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl -X PATCH -H "Content-Type: application/json" -d '{"password":"string","turnedOn":false}' https://{api_host}/csp/gateway/iam/vmwid/api/principal/mfa
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: any
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
