Help Center/ IAM Identity Center/ API Reference/ API/ Identity Source Quota Management/ Querying Identity Source Quotas
Updated on 2025-08-21 GMT+08:00
View PDF
Share

Querying Identity Source Quotas

Function

This API is used to query identity source quotas. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/identity-stores/{identity_store_id}/identity-store-summary

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of an identity source.

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

users

Long

Number of created users.

users_quota

Long

User quota.

groups

Long

Number of created user groups.

groups_quota

Long

User group quota.

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.

Example Request

Querying identity source quotas

GET https://{hostname}/v1/identity-stores/{identity_store_id}/identity-store-summary

Example Response

Status code: 200

Successful

{
  "users" : 1,
  "users_quota" : 50000,
  "groups" : 0,
  "groups_quota" : 10000
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

Error Codes

For details, see Error Codes.