Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Policy Management/ Querying Target Objects of a Policy Group
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Target Objects of a Policy Group

Function

Queries application objects of a specified policy group.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:policyGroups:listTargets

    List

    policyGroup *

    -

    -

    -

URI

GET /v1/{project_id}/policy-groups/{policy_group_id}/target

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

policy_group_id

Yes

String

Policy group ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

target_type

No

String

Application object type. Options:

USER: user

USERGROUP: user group

APP_GROUP: application group

OU: organization unit

ALl

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

targets

Array of Target objects

Application objects
Table 5 Target

Parameter

Type

Description

target_id

String

Object ID

target_name

String

Object name

target_type

String

Object type. Options:

USER: user

target_id: user ID

target_name: username

USERGROUP: user group

target_id: user group ID

target_name: user group name

APP_GROUP: application group

target_id: application group ID

target_name: application group name

OU: organization unit

target_id: OU ID

target_name: OU name

ALL

target_id: default-apply-all-targets

target_name: All-Targets

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

GET /v1/a4da8115c9d8464ead3a38309130523f/policy-groups/575772274859184144/target?target_type=USER

null

Example Responses

Status code: 200

Response to querying policy application objects.

{
  "targets" : [ {
    "target_id" : "S-1-5-21-1065092785-1316984780-3147557180-9999",
    "target_type" : "USER",
    "target_name" : "All-Targets-123"
  }, {
    "target_id" : "192.168.1.1",
    "target_type" : "CLIENTIP",
    "target_name" : "192.168.1.1"
  } ]
}

Status Codes

Status Code

Description

200

Response to querying policy application objects.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Policy Management