Updated on 2024-12-30 GMT+08:00

Logging Out

Function

This API is used to log out.

URI

GET /api/v2/sdk/logout

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

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-signature

Yes

String

In the encrypted data session_token=xxx&timestamp=xxx&nonce=xxx, session_token indicates the session token, timestamp indicates the current timestamp, nonce indicates the timestamp's hexadecimal value, and the encryption mode is RSA. The current timestamp can be obtained by calling the API for obtaining the server time, and the public key for encryption can be obtained by calling the API for obtaining the public key.

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.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

-

String

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Log out.

GET https://{domain_name}/api/v2/sdk/logout

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-signature:D0JeOUuVqU8Ixvl0xrmewQRk4AuGZrtk1RfBxueNKUrNPpgSbXrYnzw...
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

Example Responses

None

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.