Help Center/ OneAccess/ API Reference/ OneAccess APIs/ User APIs/ Login and Logout/ Logging In Using a Username and Password
Updated on 2024-12-30 GMT+08:00
View PDF
Share

Logging In Using a Username and Password

Function

This API is used for login with a username and password. If the API is successfully called, the user's session_token is returned. If the password expiry check or MFA is enabled, state_token is returned. If the API fails to be called, an error message is returned.

URI

POST /api/v2/sdk/login

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Set this field to "application/json;charset=utf8".

X-operating-sys-version

Yes

String

Caller OS version, for example, Android 10.

X-device-fingerprint

Yes

String

Caller device fingerprint, for example, 156aysdna213sc50.

X-device-ip

No

String

Caller IP address, for example, 10.10.10.1

X-agent

Yes

String

User agent information, for example, Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36

X-L

No

String

Language type, for example, en.

X-client-id

Yes

String

Application ID, which is a ClientId allocated to an application after registration.

X-tenant-id

No

String

Tenant ID. This parameter is mandatory when calling an ISV application. Replace "{domain_name}" with the ISV common domain name "{common_domain}". In the request header, specify tenant_id of the corresponding tenant and replace X-client-id with client_id of the ISV application template.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

user_name

Yes

String

Username.

password

Yes

String

Password.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Login process status identifier.

session_token

String

User session_token, which can be used to call the SSO API to obtain sso_ticket. User information can be obtained using sso_ticket.

id_token

String

It is essentially a JWT token that contains user identity information. The token is valid for 2 hours by default and its validity period can be configured.

expire

Integer

session_token validity period. Unit: second. Within the validity period, sso_ticket can be obtained using session_token.

state_token

String

User token with a status.

data

String

Return description.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Log in with a username and password. The username is test01 and the password is 1******6.

POST https://{domain_name}/api/v2/sdk/login

X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

{
  "user_name": "test01",
  "password": "1******6"
}

Example Responses

Status code: 200

If the user is successfully matched, session_token is returned.

{
  "session_token" : "bts******2VO",
  "expire" : 604800,
  "status" : "SUCCESS"
}

Status Codes

Status Code

Description

200

If the user is successfully matched, session_token is returned.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent topic: Login and Logout