Controller: Account Management: CheckAccountStatus
CheckAccountStatus
Get the status of an account using the Email address.
Authentication Methods
No authentication required
| Input Parameter | Type | Description |
|---|---|---|
| Email* | String | Account email |
| Output Parameter | Type | Description |
|---|---|---|
| AccountStatus | AccountStatus | Status of the account |
| New : User is not found in system and can be created | ||
| Existing : User is found in system | ||
| Invited : User is found in system, this user was invited | ||
| Pending : User is found in system, but hasn't confirmed his account yet | ||
| ConfirmationExpired : User is found in system but didn't confirm the account in time. You can resend the invite or confirm the account using ConfirmAccount() API call. | ||
| AuthMethod | AuthMethod | Authentication method for the user |
| Password : Use password authentiation | ||
| SAML : Use saml authentication | ||
| TwoFactorAuth : Require password and TwoFactor code |
*=required
CURL EXAMPLE
curl -v 'https://secure.nomadesk.com/ctrller/api.php?Task=CheckAccountStatus&Email=emailaddress@nomadesk.com'
RESPONSE
<Response>
<Status>1</Status>
<Message></Message>
<AccountStatus>Existing</AccountStatus>
<AuthMethod>Password</AuthMethod>
</Response>