All Products
Search

This Product

    CloudSSO:ListUserProvisionings

    Document Center

    CloudSSO:ListUserProvisionings

    Last Updated:Mar 30, 2026

    Queries Resource Access Management (RAM) user provisionings.

    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:ListUserProvisionings

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DirectoryId

    string

    Yes

    The ID of the resource directory.

    d-003qew84****
    PrincipalId

    string

    No

    The identity ID of the RAM user provisioning. Valid values:

    • If Group is returned for the PrincipalType parameter, the value of this parameter is the ID of a CloudSSO user group (g-********).

    • If User is returned for the PrincipalType parameter, the value of this parameter is the ID of a CloudSSO user (u-********).

    u-88d73u*****
    PrincipalType

    string

    No

    The identity type of the RAM user provisioning. Valid values:

    • User: The identity of the RAM user provisioning is a CloudSSO user.

    • Group: The identity of the RAM user provisioning is a CloudSSO user group.

    RD-Account
    TargetId

    string

    No

    The ID of the object for which you create the RAM user provisioning. The value is fixed as the ID of the member in the resource directory.

    1743382******
    TargetType

    string

    No

    The object for which you create the RAM user provisioning. The value is fixed as RD-Account.

    User
    MaxResults

    integer

    No

    The maximum number of entries per page.

    Valid values: 1 to 100.

    Default value: 10.

    100
    NextToken

    string

    No

    The token that is used to initiate the next request. If this is your first time to call this operation, you do not need to specify the NextToken parameter.

    When you call this operation for the first time, if the total number of entries to return is larger than the value of MaxResults, the entries are truncated. The system returns entries based on the value of MaxResults, and does not return the excess entries. In this case, the value of the response parameter IsTruncated is true, and NextToken is returned. In the next call, you can use the value of NextToken and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of IsTruncated becomes false. This way, all entries are returned.

    27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned results.

    NextToken

    string

    The token that is used to initiate the next request.

    Note

    This parameter is returned only when the IsTruncated parameter is set to true.

    27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****
    RequestId

    string

    The request ID.

    F76AF4FC-****-****-B7CB-74F3********
    MaxResults

    integer

    The maximum number of entries per page.

    Valid values: 1 to 100.

    Default value: 10.

    100
    TotalCounts

    integer

    The total number of entries returned.

    110
    UserProvisionings

    array<object>

    The RAM user provisionings.

    object

    Status

    string

    The status of the RAM user provisioning. Valid values:

    • Enabled

    • Disabled

    Enabled
    Description

    string

    The description.

    this is a user provisioning.
    UserProvisioningId

    string

    The ID of the RAM user provisioning.

    up-002axzhapcbz6e63****
    PrincipalId

    string

    The identity ID of the RAM user provisioning. Valid values:

    • If Group is returned for the PrincipalType parameter, the value of this parameter is the ID of a CloudSSO user group (g-********).

    • If User is returned for the PrincipalType parameter, the value of this parameter is the ID of a CloudSSO user (u-********).

    g-02ha881d*****
    TargetPath

    string

    The path of the resource directory in which you create the RAM user provisioning for the object.

    rd-******/root/test**
    UpdateTime

    string

    The modification time.

    2022-11-28T03:55:42Z
    DuplicationStrategy

    string

    The conflict handling policy. The policy is used when a RAM user has the same username as the CloudSSO user who is synchronized to RAM. Valid values:

    • KeepBoth: When a CloudSSO user is synchronized to RAM, if a RAM user who has the same username as the CloudSSO user exists, the system creates a RAM user whose username is the username of the CloudSSO user plus the suffix _sso.

    • TakeOver: When a CloudSSO user is synchronized to RAM, if a RAM user who has the same username as the CloudSSO user exists, the system replaces the RAM user with the CloudSSO user.

    KeepBoth
    DeletionStrategy

    string

    The deletion policy. The policy is used to manage synchronized users when you delete the RAM user provisioning. Valid values:

    • Delete: When you delete the RAM user provisioning, the system deletes the synchronized users.

    • Keep: When you delete the RAM user provisioning, the system retains the synchronized users.

    Delete
    PrincipalName

    string

    The identity name of the RAM user provisioning. Valid values:

    • If Group is returned for the PrincipalType parameter, the value of this parameter is the name of a CloudSSO user group.

    • If User is returned for the PrincipalType parameter, the value of this parameter is the name of a CloudSSO user.

    testGroupName
    TargetName

    string

    The object for which you create the RAM user provisioning. The value is fixed as RD-Account.

    testRdMember
    TargetId

    string

    The ID of the object for which you create the RAM user provisioning. The value is fixed as the ID of the member in the resource directory.

    1743382******
    CreateTime

    string

    The creation time.

    2022-11-28T03:55:42Z
    DirectoryId

    string

    The ID of the resource directory.

    d-003qew84****
    OwnerPk

    string

    The ID of the Alibaba Cloud account to which the resource directory belongs.

    1639738******
    TargetType

    string

    The object for which you create the RAM user provisioning. The value is fixed as RD-Account.

    RD-Account
    PrincipalType

    string

    The identity type of the RAM user provisioning. Valid values:

    • User: The identity of the RAM user provisioning is a CloudSSO user.

    • Group: The identity of the RAM user provisioning is a CloudSSO user group.

    Group
    IsTruncated

    boolean

    Indicates whether the queried entries are truncated. Valid values:

    • true

    • false

    true

    Examples

    Success response

    JSON format

    {
  "NextToken": "27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****",
  "RequestId": "F76AF4FC-****-****-B7CB-74F3********",
  "MaxResults": 100,
  "TotalCounts": 110,
  "UserProvisionings": [
    {
      "Status": "Enabled",
      "Description": "this is a user provisioning.",
      "UserProvisioningId": "up-002axzhapcbz6e63****",
      "PrincipalId": "g-02ha881d*****",
      "TargetPath": "rd-******/root/test**",
      "UpdateTime": "2022-11-28T03:55:42Z",
      "DuplicationStrategy": "KeepBoth",
      "DeletionStrategy": "Delete",
      "PrincipalName": "testGroupName",
      "TargetName": "testRdMember",
      "TargetId": "1743382******",
      "CreateTime": "2022-11-28T03:55:42Z",
      "DirectoryId": "d-003qew84****",
      "OwnerPk": "1639738******",
      "TargetType": "RD-Account",
      "PrincipalType": "Group"
    }
  ],
  "IsTruncated": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.