Updated on 2026-04-03 GMT+08:00

Adding a Login Whitelist

Function

This API is used to add a login whitelist.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/event/white-list/login

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

private_ip

Yes

String

Definition

Server private IP address.

Range

The value can contain 1 to 128 characters.

login_ip

Yes

String

Definition

Login source IP address.

Range

The value can contain 1 to 256 characters.

login_user_name

Yes

String

Definition

Login username.

Range

The value can contain 1 to 256 characters.

remarks

No

String

Remarks

handle_event

No

Boolean

Whether to process related alarm events at the same time.

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Add a login whitelist. The private IP address of the server is 1.1.1.1, the login source IP address is 1.1.1.1, and the login username is user.

{
  "private_ip" : "1.1.1.1",
  "login_ip" : "1.1.1.1",
  "login_user_name" : "user"
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.