Log In¶
Log in to EnOS.
Request Format¶
POST https://{apigw-address}/enos-iam-service/v2.0/login
Request Parameters (Body)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
authType | Mandatory | Integer | The authentication type.
|
linkName | Optional (Mandatory if using LDAP authType ) |
String | The LDAP domain name. |
principal | Mandatory | String | The account name. |
credentials | Mandatory | String | The password. |
keyId | Optional | String | The encryption key ID. |
captcha | Optional | String | The captcha, which is a reserved field. |
clientIp | Optional | String | The IP address of the client. |
expireInterval | Optional | Integer | The session expiring time, in seconds. The range of values is [900, 864000], with values <900 being defaulted to 900 and values >864000 being defaulted to 864000. |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
captcha | String | The captcha for verification. |
session | List<JSONObject> | The session information. For more information, see Session Struct >> |
Session Struct ¶
Name | Data Type | Description |
---|---|---|
id | String | The session ID. |
expires | Integer | The session expiring time. |
user | List<JSONObject> | The detailed user information. For more information, see User Struct >> |
residentOrganization | List<JSONObject> | The organization to which the user belongs when the user account is created. |
workingOrganization | List<JSONObject> | The current organizatoin. |
refreshTime | Long | The session refresh time. |
createTime | Long | The session create time. |
status | Int | The session status. 0: initialized (limited access to interface only), 1: normal. |
ssoLogin | Boolean | Whether there is an SSO login session. |
User Struct ¶
Name | Data Type | Description |
---|---|---|
id | String | The user ID. |
organizationId | String | The organization to which the user belongs. |
authType | Integer | The authentication type.
|
name | String | The user name. |
domain | String | The domain. |
phoneArea | String | The phone area. |
phone | String | The user phone number. |
phoneVerifiedAt | String | The time when the user phone number is verified. |
String | The user email address. | |
emailVerifiedAt | String | The time when the user email is verified. |
description | String | The user description. |
extra | Map | Other user information. |
resourceId | String | The resource ID. |
type | Enum | The user type.
|
state | Enum | The user account status.
|
mfaType | Enum | The multi-factor authentication type.
|
passwordState | Enum | The user password status.
|
passwordExpireTime | Long | The password expiring time. |
passwordStrength | Enum | The password strength.
|
organization | Organization Struct | The organization’s information. For more information, see Organization Struct >> |
createdAt | String | The creation time. |
phoneVerified | Boolean | Is the phone number verified. |
emailVerified | Boolean | Is the email number verified. |
Error Code¶
Code | Description |
---|---|
30400 | The user accout or password is not correct, or the LDAP domain is missing, or the LDAP attribute mapping is not correct, or connection failed. |
30404 | The LDAP connection does not exist. |
30410 | The password has expired. |
30429 | The login failure times of the IP or account has reached the limit. Please try again later. |
30511 | The user account is disabled, or the LDAP login is disabled. |
Sample¶
Request Sample¶
url: https://{apigw-address}/enos-iam-service/v2.0/login
method: POST
requestBody:
{
"authType":0,
"linkName":"",
"credentials":"xxx",
"principal":"xxxx",
"keyId":"yyy",
"captcha":"xxxx",
"clientIp":"1.1.1.1",
"expireInterval":3600
}
Return Sample¶
{
"fail": false,
"session": {
"workingOrganization": {
"domain": "db_portal_test01",
"name": "portal_test01",
"id": "o15578227985571"
},
"expires": 7200,
"createTime": 1562849746,
"residentOrganization": {
"domain": null,
"name": "portal_test01",
"id": "o15578227985571"
},
"refreshTime": 1562850052,
"id": "IAM_S_HbH8y6sP77T5uUDgqLfzGCZkrz9x5Pyr3VMVARBBQRK8YDbAnsU9YWdUQAMkBu7g4fQKUXmPjakeSmqpFVWsANXKdrBJKUxrLxZC9MvCVHqTc5HyqTcnANz3M8HMhnTb",
"user": {
"createdByUserId": "u15440200922941",
"resourceId": "r15578227990212",
"phoneVerified": false,
"description": "",
"type": 2,
"organizationId": "o15578227985571",
"createdAt": null,
"emailVerified": true,
"phoneVerifiedAt": null,
"phone": "",
"createTime": "2019-05-14 08:33:19.0",
"emailVerifiedAt": null,
"mfaType": null,
"extra": null,
"organization": null,
"name": "portal_test01",
"phoneArea": "",
"id": "u15578227990211",
"state": 0,
"authType": 0,
"email": "congcong1.chen@envision-digital.com"
}
},
"captcha":"",
"success": true,
"requestId": null,
"failed": false,
"message": "",
"status": 0,
"successful": true
}