Updated on 2025-02-25 GMT+08:00

Exporting User Tags

Function

This API is used to export user tags to an Excel file for batch editing.

URI

GET /v1/{project_id}/tags/download

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation

Project ID. For how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Value range

N/A

Default value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Explanation

User type.

Constraints

N/A

Value range

  • user: user.
  • userGroup: user group.

Default value

N/A

Request Parameters

Table 3 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation

User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token.

Constraints

N/A

Value range

N/A

Default value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

-

File

Explanation

The tags of the users or user groups under the tenant have been successfully exported to an Excel file.

Constraints

N/A

Value range

N/A

Default value

N/A

Example Request

Export user tags to an Excel file.

https://{endpoint}/v1/{project_id}/tags/download?type=user

Example Response

None

Status Codes

Status Code

Description

200

The tags of the users or user groups under the tenant have been successfully exported to an Excel file.

Error Codes

See Error Codes.