All Products
Search

This Product

    CloudSSO:ListUserProvisionings

    Document Center

    CloudSSO:ListUserProvisionings

    Last Updated:Mar 29, 2024

    Queries Resource Access Management (RAM) user provisionings.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DirectoryIdstringYes

    The ID of the resource directory.

    		d-003qew84****
    PrincipalIdstringNo

    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*****
    PrincipalTypestringNo

    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
    TargetIdstringNo

    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******
    TargetTypestringNo

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

    		User
    MaxResultsintegerNo

    The maximum number of entries per page.

    Valid values: 1 to 100.

    Default value: 10.

    		100
    NextTokenstringNo

    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 parameters

    ParameterTypeDescriptionExample
    object

    The returned results.

    NextTokenstring

    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****
    RequestIdstring

    The request ID.

    		F76AF4FC-****-****-B7CB-74F3********
    MaxResultsinteger

    The maximum number of entries per page.

    Valid values: 1 to 100.

    Default value: 10.

    		100
    TotalCountsinteger

    The total number of entries returned.

    		110
    UserProvisioningsobject []

    The RAM user provisionings.

    Statusstring

    The status of the RAM user provisioning. Valid values:

    • Enabled
    • Disabled
    		Enabled
    Descriptionstring

    The description.

    		this is a user provisioning.
    UserProvisioningIdstring

    The ID of the RAM user provisioning.

    		up-002axzhapcbz6e63****
    PrincipalIdstring

    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*****
    TargetPathstring

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

    		rd-******/root/test**
    UpdateTimestring

    The modification time.

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

    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
    DeletionStrategystring

    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
    PrincipalNamestring

    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
    TargetNamestring

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

    		testRdMember
    TargetIdstring

    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******
    CreateTimestring

    The creation time.

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

    The ID of the resource directory.

    		d-003qew84****
    OwnerPkstring

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

    		1639738******
    TargetTypestring

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

    		RD-Account
    PrincipalTypestring

    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
    IsTruncatedboolean

    Indicates whether the queried entries are truncated. Valid values:

    • true
    • false
    		true

    Examples

    Sample success responses

    JSONformat

    {
  "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

    For a list of error codes, visit the Service error codes.