Client Authentication data models
getAuthenticationState — 200 response
Successfully retrieve info about the identity of the client.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
appId | string | No | read-only (server-generated) | ID of app used. This property is present if token is associated with a user authenticated via an app. |
deviceId | integer | No | read-only (server-generated) | This property is present if token is associated with a device. |
expirationTime | string | No | read-only (server-generated); format: date-time | This property is present if token has an expiration time. |
projectId | integer | No | read-only (server-generated) | This property is present if token is associated with a project. |
projectKeyName | string | No | read-only (server-generated) | This property is present if token is assocaited with a project API key. |
sudoer | string | No | read-only (server-generated) | This property is present if token is generated via sudo. |
type | unknown | Yes | read-only (server-generated); one of: user, device, project key, nobody | Type of client entity, or 'nobody' if client is not authenticated. |
userId | integer | No | read-only (server-generated) | This property is present if token is associated with a user. |
getAuthenticationState — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getAuthenticationState — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticationSudo — request
Request body for Authentication by sudo.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
token | string | Yes | Sudo authorization token. |
authenticationSudo — 200 response
Sudo access granted.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
auth2FToken | string | No | read-only (server-generated) | Token used for completing the two-factor authentication process. Token will expire within 3 minutes |
expirationTime | string | No | read-only (server-generated); format: date-time | This property is present if token has an expiration time. |
sudoer | string | No | read-only (server-generated) | This property is present if client is authenticated via sudo. |
token | string | No | read-only (server-generated) | Access token to be used in the HTTP Authorization header in future API requests. |
userId | integer | No | read-only (server-generated) | This property is present if token is associated with a user. |
authenticationSudo — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticationSudo — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticationSudo — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticationSudo — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticationSudo — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateSudoAuthentication — request
Request body for Initiate sudo authentication.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
sudoer | string | Yes | Identity of the administrator requesting sudo access. | |
targetAppId | string | Yes | ID of the app expected to be used to access the API. | |
targetUserId | integer | Yes | User ID of the sudo target. |
initiateSudoAuthentication — 200 response
Sudo authorization token issued and returned in the response body.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
token | string | No | read-only (server-generated) | The sudo authorization token itself. |
initiateSudoAuthentication — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateSudoAuthentication — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateSudoAuthentication — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateSudoAuthentication — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateSudoAuthentication — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticateUser — request
Request body for Authenticate a user.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
appId | string | No | ID of the app being used to access the API. Required except for BYOU projects. | |
code | string | No | Auth code sent to user via SMS. Required only for projects with phone number-based user accounts. | |
email | string | No | Email address of user to be authenticated. Required only for projects with email address-based user accounts. | |
externalKey | string | No | External key associated with the user to be authenticated. Used only for BYOU projects. | |
password | string | No | Password of user to be authenticated. Required only for projects with email address-based user accounts. | |
phoneNumber | string | No | Phone number of user to be authenticated. Required only for projects with phone number-based user accounts. | |
projectId | integer | Yes | ID of project to which the user belongs. | |
userId | integer | No | ID of user to be authenticated. Used only for BYOU projects. |
authenticateUser — 200 response
User is successfully authenticated, or if the user has activated two-factor authentication, user shall proceed to finish authentication by using the token included in the returned object.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
auth2FToken | string | No | read-only (server-generated) | Token used for completing the two-factor authentication process. Token will expire within 3 minutes |
expirationTime | string | No | read-only (server-generated); format: date-time | This property is present if token has an expiration time. |
sudoer | string | No | read-only (server-generated) | This property is present if client is authenticated via sudo. |
token | string | No | read-only (server-generated) | Access token to be used in the HTTP Authorization header in future API requests. |
userId | integer | No | read-only (server-generated) | This property is present if token is associated with a user. |
authenticateUser — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticateUser — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticateUser — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticateUser — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
authenticateUser — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
activateUserAccount — request
Request body for Activate user account.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
name | string | Yes | User's name to be associated with the account. | |
password | string | Yes | Password for logging into the account. | |
token | string | Yes | Activation token emailed to user. |
activateUserAccount — 200 response
User's account has be activated.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | No | ||
projectId | integer | No |
activateUserAccount — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
activateUserAccount — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
activateUserAccount — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
activateUserAccount — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
activateUserAccount — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeTwoFactorAuthentication — request
Request body for Complete two-factor authentication.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
auth2FToken | string | Yes | Token obtained from the previous step of authentication. | |
code | string | Yes | Time-based one-time passcode from an authenticator application. |
completeTwoFactorAuthentication — 200 response
User is successfully authenticated and an API token is issued.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
auth2FToken | string | No | read-only (server-generated) | Token used for completing the two-factor authentication process. Token will expire within 3 minutes |
expirationTime | string | No | read-only (server-generated); format: date-time | This property is present if token has an expiration time. |
sudoer | string | No | read-only (server-generated) | This property is present if client is authenticated via sudo. |
token | string | No | read-only (server-generated) | Access token to be used in the HTTP Authorization header in future API requests. |
userId | integer | No | read-only (server-generated) | This property is present if token is associated with a user. |
completeTwoFactorAuthentication — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeTwoFactorAuthentication — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeTwoFactorAuthentication — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeTwoFactorAuthentication — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeTwoFactorAuthentication — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
verifyUserEmailAddress — request
Request body for Verify user email address.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
token | string | Yes | Verification token emailed to user. |
verifyUserEmailAddress — 200 response
User's identity has been verified.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | No | ||
projectId | integer | No |
verifyUserEmailAddress — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
verifyUserEmailAddress — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
verifyUserEmailAddress — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
verifyUserEmailAddress — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
verifyUserEmailAddress — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserEmailVerification — request
Request body for Initiate user email verification.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | Yes | Email address of user. | |
projectId | integer | Yes | ID of project to which the user belongs. |
initiateUserEmailVerification — 200 response
An email has been sent to the specified email address.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | No |
initiateUserEmailVerification — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserEmailVerification — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserEmailVerification — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserEmailVerification — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserEmailVerification — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
verifyNewUserEmail — request
Request body for Verify new user email.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
token | string | Yes | Activation token emailed to user. |
verifyNewUserEmail — 200 response
Successfully verified user's new email and updated in the database.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | No | ||
projectId | integer | No |
verifyNewUserEmail — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
verifyNewUserEmail — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
verifyNewUserEmail — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeAuthenticationOpenIDConnect — request
Request body for Complete authentication by OpenID Connect.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
appId | string | Yes | ID of the app the user is using. | |
code | string | Yes | Authorization code embedded in the URL redirected from the Identity Provider after the user has consented to share information with MODE. | |
methodId | string | Yes | ID of the project's User Authentication Method that is being used. | |
projectId | integer | Yes | ID of project to which the user belongs. | |
redirectUrl | string | Yes | The same redirect URL that was used to obtain the authorization URL. It is needed by the Identity Provider to verify the authorization code. |
completeAuthenticationOpenIDConnect — 200 response
User has been successfully authenticated.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
auth2FToken | string | No | read-only (server-generated) | Token used for completing the two-factor authentication process. Token will expire within 3 minutes |
expirationTime | string | No | read-only (server-generated); format: date-time | This property is present if token has an expiration time. |
sudoer | string | No | read-only (server-generated) | This property is present if client is authenticated via sudo. |
token | string | No | read-only (server-generated) | Access token to be used in the HTTP Authorization header in future API requests. |
userId | integer | No | read-only (server-generated) | This property is present if token is associated with a user. |
completeAuthenticationOpenIDConnect — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeAuthenticationOpenIDConnect — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeAuthenticationOpenIDConnect — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeAuthenticationOpenIDConnect — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
completeAuthenticationOpenIDConnect — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateAuthenticationOpenIDConnect — 200 response
The authorization URL has been returned.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
authUrl | string | No |
initiateAuthenticationOpenIDConnect — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateAuthenticationOpenIDConnect — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateAuthenticationOpenIDConnect — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateAuthenticationOpenIDConnect — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateAuthenticationOpenIDConnect — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
resetUserPassword — request
Request body for Reset user password.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
newPassword | string | Yes | New password for user's account. | |
token | string | Yes | Password reset token emailed to user. |
resetUserPassword — 200 response
User's password has been updated.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | No | ||
projectId | integer | No |
resetUserPassword — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
resetUserPassword — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
resetUserPassword — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
resetUserPassword — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
resetUserPassword — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiatePasswordResetUser — request
Request body for Initiate password reset for user.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | Yes | Email address of user. | |
projectId | integer | Yes | ID of project to which the user belongs. |
initiatePasswordResetUser — 200 response
An email has been sent to the specified email address.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | No |
initiatePasswordResetUser — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiatePasswordResetUser — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiatePasswordResetUser — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiatePasswordResetUser — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiatePasswordResetUser — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserAuthSMS — request
Request body for Initiate user auth with SMS.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
phoneNumber | string | Yes | Phone number of user to be authenticated. It needs to be registered already on MODE cloud by Create User API call. | |
projectId | integer | Yes | ID of project to which the user belongs. |
initiateUserAuthSMS — 200 response
SMS message successfully sent.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
recipient | string | No | read-only (server-generated) | Phone number receiving the SMS message. |
initiateUserAuthSMS — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserAuthSMS — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserAuthSMS — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserAuthSMS — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
initiateUserAuthSMS — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |