Login

Function

URI

POST /koodrive/ose/v1/auth/login

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Traceid	No	String	Definition: Service trace ID, which contains 58 bits. Constraints: N/A Range: The value contains 58 bits. Default Value: N/A
x-hw-agentName	Yes	String	Definition: Agent name. Constraints: N/A Range: N/A Default Value: N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
account	Yes	String	Account name and mobile number.
authType	Yes	String	Verification type. 1: account and password. 2: verification code.
password	No	String	Password.
captchaToken	No	String	Token of the verification code.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Error Codes
msg	String	Error description.
data	data object	Login struct.

**Table 4** data
Parameter	Type	Description
userInfo	UserInfo object	User information.
sessionInfo	SessionInfo object	Authentication information.

**Table 5** UserInfo
Parameter	Type	Description
userId	String	User ID.
firstname	String	Name.
surname	String	Family name.
phone	String	Mobile number.
email	String	Email address.

**Table 6** SessionInfo
Parameter	Type	Description
accessToken	String	Access token.
expiresIn	Long	Validity period.
issuedAt	String	Generation time.
refreshToken	String	Refresh token.

Example Requests

POST /koodrive/ose/v1/auth/login

{
  "account": "0027188460911",
  "authType": "1",
  "password": "123qweASD143",
}

Example Responses

Status code: 200

{
  "data" : {
    "userInfo" : {
      "userId" : "1882575898755117312",
      "firstname" : "firstname",
      "surname" : "surname",
      "phone" : "0027188460911",
      "email" : ""
    },
    "sessionInfo" : {
      "accessToken" : "AT 3b911d723003f70a1265124148fdfe486c108b64bf8d0de3",
      "expiresIn" : 1800,
      "issuedAt" : "1772006999088",
      "refreshToken" : "0e0e72d3c7e9e4444df6bc3fb111eaee18eb7b2393a939cb"
    }
  },
  "code" : 0,
  "msg" : "Success"
}

Status Codes

Status Code	Description
200	Login response

Parent topic: Login and logout

Previous topic: Login and logout

Next topic: Logout

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot