All Products
Search

This Product

    CloudSSO:GetDirectoryStatistics

    Document Center

    CloudSSO:GetDirectoryStatistics

    Last Updated:Aug 28, 2026

    Queries the usage and quota statistics of a CloudSSO directory.

    Operation description

    Returns the usage and quota statistics of a specified CloudSSO directory, including user count, group count, access configuration count, access assignment count, SCIM credential count, in-progress task count, SSO logon status, and SCIM synchronization status.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cloudsso:GetDirectoryStatistics

    get

    *Directory

    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DirectoryId

    string

    Yes

    The ID of the directory.

    d-00fc2p61****

    For more information about common request parameters, see Common parameters.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    7B7228B0-A435-5D27-A6B2-ED3571F0654B
    DirectoryStatistics

    object

    The statistics of the directory.

    UserCount

    integer

    The number of users.

    16
    GroupCount

    integer

    The number of user groups.

    4
    UserQuota

    integer

    The quota for users.

    1000
    GroupQuota

    integer

    The quota for user groups.

    500
    AccessConfigurationQuota

    integer

    The quota for access configurations.

    1000
    AccessAssignmentCount

    integer

    The number of assigned access permissions.

    5
    SCIMServerCredentialCount

    integer

    The number of SCIM credentials.

    2
    DirectoryId

    string

    The ID of the directory.

    d-00fc2p61****
    SSOEnabled

    boolean

    Indicates whether SSO is enabled. Valid values:

    • true

    • false

    false
    Region

    string

    The region ID of the directory.

    cn-shanghai
    AccessConfigurationCount

    integer

    The number of access configurations.

    6
    DirectoryName

    string

    The name of the directory.

    new-example
    InProgressTaskCount

    integer

    The number of in-progress asynchronous tasks.

    0
    SCIMSyncEnabled

    boolean

    Indicates whether SCIM synchronization is enabled. Valid values:

    • true

    • false

    true
    SystemPolicyPerAccessConfigurationQuota

    integer

    The maximum number of system policies that can be attached to each access configuration.

    20
    InlinePolicyPerAccessConfigurationQuota

    integer

    The maximum number of inline policies that can be attached to each access configuration.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "7B7228B0-A435-5D27-A6B2-ED3571F0654B",
  "DirectoryStatistics": {
    "UserCount": 16,
    "GroupCount": 4,
    "UserQuota": 1000,
    "GroupQuota": 500,
    "AccessConfigurationQuota": 1000,
    "AccessAssignmentCount": 5,
    "SCIMServerCredentialCount": 2,
    "DirectoryId": "d-00fc2p61****",
    "SSOEnabled": false,
    "Region": "cn-shanghai",
    "AccessConfigurationCount": 6,
    "DirectoryName": "new-example",
    "InProgressTaskCount": 0,
    "SCIMSyncEnabled": true,
    "SystemPolicyPerAccessConfigurationQuota": 20,
    "InlinePolicyPerAccessConfigurationQuota": 1
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.