Validate password only and return MFA requirements

ApiScope: manage.user.read
API Scope Level: ServiceSubscriberScope

Path Parameters

UserName string required

Header Parameters

clientIp string

application/json

Request Body required

password string
token string
emailToken string
userMFARememberMeToken string
sessionToken string
mfaRememberDevice boolean

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
userMFARememberMeToken string
sessionToken string
mfaRequired boolean
mfaType string
mfaBypassed boolean
mfaBypassReason string
user object
firstName string
lastName string
userName string
email string
phone string
textNumber string
nickName string
uuid string
passwordExpires string
forcePasswordChange boolean
latestInviteStatus string
latestInviteDate string
latestInviteUUID string
isValid boolean
lastLoginTimestamp string
phoneCountryCode string
textCountryCode string
userRolloutStage string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "userMFARememberMeToken": "string",
  "sessionToken": "string",
  "mfaRequired": true,
  "mfaType": "string",
  "mfaBypassed": true,
  "mfaBypassReason": "string",
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "textNumber": "string",
    "nickName": "string",
    "uuid": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "latestInviteUUID": "string",
    "isValid": true,
    "lastLoginTimestamp": "string",
    "phoneCountryCode": "string",
    "textCountryCode": "string",
    "userRolloutStage": "string"
  }
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Loading...