[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get Principal MFA Status
DescriptionGet principal MFA status.
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
Operation doesn't accept any path, query or header parameters.
URL
https://{api_host}/csp/gateway/iam/vmwid/api/principal/mfa/status
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
UserMfaStatusDto
of type application/json
{
"activated": false,
"deviceName": "string",
"turnedOn": false,
"username": "string"
}
boolean
activated
Optional
If the user’s MFA is activated
string
deviceName
Optional
The user’s device name
boolean
turnedOn
Optional
If the user’s MFA is turned on
string
username
Optional
The username of the user
Errors
CspErrorResponse
401
Unauthenticated User
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
The requested resource could not be found
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 https://{api_host}/csp/gateway/iam/vmwid/api/principal/mfa/status
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
