全部产品
Search

搜索本产品

    云SSO：ListUserProvisionings - 查询RAM用户同步列表

    文档中心

    云SSO：ListUserProvisionings - 查询RAM用户同步列表

    更新时间：Dec 13, 2024

    调用ListUserProvisionings查询RAM用户同步列表。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    cloudsso:ListUserProvisioningslist
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    DirectoryIdstring是

    目录 ID。

    		d-003qew84****
    PrincipalIdstring否

    RAM 用户同步的身份 ID。取值：

    • 当PrincipalType取值为Group时，该值为云 SSO 用户组 ID（g-********）。
    • 当PrincipalType取值为User时，该值为云 SSO 用户 ID（u-********）。
    		u-88d73u*****
    PrincipalTypestring否

    RAM 用户同步的身份类型。取值：

    • User：表示该 RAM 用户同步的身份是云 SSO 用户。
    • Group：表示该 RAM 用户同步的身份是云 SSO 用户组。
    		RD-Account
    TargetIdstring否

    RAM 用户同步的目标 ID。目前取值为 RD 账号 ID。

    		1743382******
    TargetTypestring否

    RAM 用户同步的目标类型。目前取值为RD-Account。

    		User
    MaxResultsinteger否

    每页的最大数据条数。

    取值范围：1~100。

    默认值：10。

    		100
    NextTokenstring否

    查询返回结果下一页的令牌。首次调用 API 不需要NextToken。

    当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。

    		27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****

    返回参数

    名称类型描述示例值
    object

    返回参数。

    NextTokenstring

    查询返回结果下一页的令牌。

    说明 只有IsTruncated为true时，才显示该参数。
    		27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****
    RequestIdstring

    请求 ID。

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

    每页的最大数据条数。

    取值范围：1~100。

    默认值：10。

    		100
    TotalCountsinteger

    符合请求参数条件的数据总条数。

    		110
    UserProvisioningsarray<object>

    RAM 用户同步列表。

    UserProvisioningobject

    RAM 用户同步列表。

    Statusstring

    RAM 用户同步的状态。取值：

    • Enabled：RAM 用户同步已启用。
    • Disabled：RAM 用户同步未启用。
    		Enabled
    Descriptionstring

    描述。

    		this is a user provisioning.
    UserProvisioningIdstring

    RAM 用户同步的 ID。

    		up-002axzhapcbz6e63****
    PrincipalIdstring

    RAM 用户同步的身份 ID。取值：

    • 当PrincipalType取值为Group时，该值为云 SSO 用户组 ID（g-********）。
    • 当PrincipalType取值为User时，该值为云 SSO 用户 ID（u-********）。
    		g-02ha881d*****
    TargetPathstring

    RAM 用户同步的目标的 RD 路径。

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

    修改时间。

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

    冲突策略。当云 SSO 用户同步到 RAM 时，如果 RAM 中存在同名用户时的处理策略。取值：

    • KeepBoth：两者都保留。当云 SSO 用户被同步到 RAM 时，如果 RAM 已经存在同名用户，则对云 SSO 用户的用户名添加后缀_sso后尝试创建该用户名的 RAM 用户。
    • TakeOver：替换。当云 SSO 用户被同步到 RAM 时，如果 RAM 已经存在同名用户，则直接将已经存在的 RAM 用户替换为云 SSO 同步用户。
    		KeepBoth
    DeletionStrategystring

    删除策略。删除 RAM 用户同步时，对已同步的 RAM 用户的处理策略。取值：

    • Delete：删除。删除 RAM 用户同步时，会删除从云 SSO 已经同步到 RAM 中的 RAM 用户。
    • Keep：保留。删除 RAM 用户同步时，会保留从云 SSO 已经同步到 RAM 中的 RAM 用户。
    		Delete
    PrincipalNamestring

    RAM 用户同步的身份名称。取值：

    • 当PrincipalType取值为Group时，该值为云 SSO 用户组名称。
    • 当PrincipalType取值为User时，该值为云 SSO 用户名称。
    		testGroupName
    TargetNamestring

    RAM 用户同步的目标类型。目前取值为RD-Account。

    		testRdMember
    TargetIdstring

    RAM 用户同步的目标 ID。目前取值为 RD 账号 ID。

    		1743382******
    CreateTimestring

    创建时间。

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

    目录 ID。

    		d-003qew84****
    OwnerPkstring

    目录所属的主账号 ID。

    		1639738******
    TargetTypestring

    RAM 用户同步的目标类型。目前取值为RD-Account。

    		RD-Account
    PrincipalTypestring

    RAM 用户同步的身份类型。取值：

    • User：表示该 RAM 用户同步的身份是云 SSO 用户。
    • Group：表示该 RAM 用户同步的身份是云 SSO 用户组。
    		Group
    IsTruncatedboolean

    返回结果是否被截断。取值：

    • true：已截断。
    • false：未截断。
    		true

    示例

    正常返回示例

    JSON格式

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

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史