[{"label":"Latest (v1.0)","version":"latest"}]
csp

Update Principal MFA

Description

Update 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

Request

URL

URL


patch
https://{api_host}/csp/gateway/iam/vmwid/api/principal/mfa
Copy

Request Body

Request Body

UpdateMfaRequest of mimetype application/json Required

Principal MFA update details

{
	"password": "string",
	"turnedOn": false
}
string
password Required

boolean
turnedOn Required
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns UpdateMfaResponse of type application/json
{
	"turnedOn": false
}
boolean
turnedOn Optional
Errors

Errors

400

Password was not provided


401

Unauthenticated User


403

Wrong password provided


404

No user with given token exists | MFA details for principal user were not found


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

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

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
Feedback

Was this page helpful?