Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Listing Auxiliary Authentication Target Objects
Updated on 2026-02-10 GMT+08:00

Listing Auxiliary Authentication Target Objects

Function

Lists auxiliary authentication target objects.

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, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/assist-auth-config/apply-objects

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

object_type

No

String

Type of bound objects.

  • USER: user

  • USER_GROUP: user group

  • ALL: all users

object_name

No

String

Object name.

offset

No

Integer

Start position for pagination query. The value starts from 0.

limit

No

Integer

Number of returned login records for pagination query. The value ranges from 0 to 1,000. The default value is 100.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

objects

Array of ApplyObjects objects

Target object.

total_count

Integer

Total number of users and user groups that meet the conditions.

Table 4 ApplyObjects

Parameter

Type

Description

object_type

String

Type of bound objects.

  • USER: user

  • USER_GROUP: user group

  • ALL: all users

object_id

String

User ID or user group ID.

object_name

String

Username or user group name.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/assist-auth-config/apply-objects

Example Responses

Status code: 200

Response to the request for listing auxiliary authentication target objects.

{
  "objects" : [ {
    "object_type" : "USER",
    "object_id" : "object_id",
    "object_name" : "xxxxxx"
  } ],
  "total_count" : 1
}

Status Codes

Status Code

Description

200

Response to the request for listing auxiliary authentication target objects.

400

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

401

Authentication failed.

403

No operation permissions.

404

No resources found.

500

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

Error Codes

See Error Codes.