Help Center/ IAM Identity Center/ API Reference/ API/ Application Management/ Querying Configurations of Application Assignment Attributes
Updated on 2025-08-21 GMT+08:00
View PDF
Share

Querying Configurations of Application Assignment Attributes

Function

This API is used to query configurations of application assignment attributes to assign application access permissions to users or user groups. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/instances/{instance_id}/applications/{application_instance_id}/assignments-configuration

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Globally unique ID of an IAM Identity Center instance.

application_instance_id

Yes

String

Application instance ID. Its prefix is app-ins-.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

Table 3 Parameters in the response body

Parameter

Type

Description

assignment_required

Boolean

Whether an application needs to be assigned.

Status code: 400

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Status code: 404

Table 6 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Example Request

Querying configurations of application allocation attributes

GET https://{hostname}/v1/instances/{instance_id}/applications/{application_instance_id}/assignments-configuration

Example Response

Status code: 200

Successful

{
  "assignment_required" : true
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

404

Not found.

Error Codes

For details, see Error Codes.

Parent topic: Application Management