全部產品
Search
文件中心

CloudSSO:CreateUserProvisioning - 建立RAM使用者同步

更新時間:Apr 21, 2026

調用CreateUserProvisioning建立RAM使用者同步。

介面說明

您可以建立 RAM 使用者同步,在目標 RD 帳號中同步建立一個與雲 SSO 使用者同名的 RAM 使用者,然後通過該 RAM 使用者訪問該 RD 帳號中的資源。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cloudsso:CreateUserProvisioning

create

*UserProvisioning

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user-provisioning/*

*Account

acs:resourcemanager::{#accountId}:account/{#AccountId}

Group

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

User

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

請求參數

名稱

類型

必填

描述

樣本值

DirectoryId

string

目錄 ID。

d-003qew84****

DuplicationStrategy

string

衝突策略。當雲 SSO 使用者同步到 RAM 時,如果 RAM 中存在同名使用者時的處理策略。取值:

  • KeepBoth:兩者都保留。當雲 SSO 使用者被同步到 RAM 時,如果 RAM 已經存在同名使用者,則對雲 SSO 使用者的使用者名稱添加尾碼_sso後嘗試建立該使用者名稱的 RAM 使用者。

  • TakeOver:替換。當雲 SSO 使用者被同步到 RAM 時,如果 RAM 已經存在同名使用者,則直接將已經存在的 RAM 使用者替換為雲 SSO 同步處理的使用者。

KeepBoth

DeletionStrategy

string

刪除策略。刪除 RAM 使用者同步時,對已同步的 RAM 使用者的處理策略。取值:

  • Delete:刪除。刪除 RAM 使用者同步時,會刪除從雲 SSO 已經同步到 RAM 中的 RAM 使用者。

  • Keep:保留。刪除 RAM 使用者同步時,會保留從雲 SSO 已經同步到 RAM 中的 RAM 使用者。

Delete

Description

string

描述。

This is a user provisioning.

PrincipalId

string

RAM 使用者同步的身份 ID。取值:

  • PrincipalType取值為Group時,該值為雲 SSO 使用者組 ID(g-********)。

  • PrincipalType取值為User時,該值為雲 SSO 使用者識別碼(u-********)。

g-02ha881d*****

PrincipalType

string

RAM 使用者同步的身份類型。取值:

  • User:表示該 RAM 使用者同步的身份是雲 SSO 使用者。

  • Group:表示該 RAM 使用者同步的身份是雲 SSO 使用者組。

Group

TargetId

string

RAM 使用者同步的目標 ID。目前取值為 RD 帳號 ID。

1743382******

TargetType

string

RAM 使用者同步的目標類型。目前取值為RD-Account

RD-Account

返回參數

名稱

類型

描述

樣本值

object

返回參數。

UserProvisioning

object

RAM 使用者同步資訊。

Status

string

RAM 使用者同步的狀態。取值:

  • Enabled:RAM 使用者同步已啟用。

  • Disabled:RAM 使用者同步未啟用。

Enabled

Description

string

描述。

This is a user provisioning.

UserProvisioningId

string

RAM 使用者同步的 ID。

up-002axzhapcbz6e63****

PrincipalId

string

RAM 使用者同步的身份 ID。取值:

  • PrincipalType取值為Group時,該值為雲 SSO 使用者組 ID(g-********)。

  • PrincipalType取值為User時,該值為雲 SSO 使用者識別碼(u-********)。

g-02ha881d*****

TargetPath

string

RAM 使用者同步的目標 RD 帳號路徑。

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

UpdateTime

string

更新時間(UTC 時間)。

2022-11-28T03:55:42Z

DuplicationStrategy

string

衝突策略。當雲 SSO 使用者同步到 RAM 時,如果 RAM 中存在同名使用者時的處理策略。取值:

  • KeepBoth:兩者都保留。當雲 SSO 使用者被同步到 RAM 時,如果 RAM 已經存在同名使用者,則對雲 SSO 使用者的使用者名稱添加尾碼_sso後嘗試建立該使用者名稱的 RAM 使用者。

  • TakeOver:替換。當雲 SSO 使用者被同步到 RAM 時,如果 RAM 已經存在同名使用者,則直接將已經存在的 RAM 使用者替換為雲 SSO 同步處理的使用者。

KeepBoth

DeletionStrategy

string

刪除策略。刪除 RAM 使用者同步時,對已同步的 RAM 使用者的處理策略。取值:

  • Delete:刪除。刪除 RAM 使用者同步時,會刪除從雲 SSO 已經同步到 RAM 中的 RAM 使用者。

  • Keep:保留。刪除 RAM 使用者同步時,會保留從雲 SSO 已經同步到 RAM 中的 RAM 使用者。

Delete

PrincipalName

string

RAM 使用者同步的身份名稱。取值:

  • PrincipalType取值為Group時,該值為雲 SSO 使用者組名稱。

  • PrincipalType取值為User時,該值為雲 SSO 使用者名稱稱。

testGroupName

TargetName

string

RAM 使用者同步的目標名稱。目前取值為 RD 帳號名稱。

testTargetName

TargetId

string

RAM 使用者同步的目標 ID。目前取值為 RD 帳號 ID。

1743382******

CreateTime

string

建立時間(UTC 時間)。

2022-11-28T03:55:42Z

DirectoryId

string

目錄 ID。

d-003qew84****

OwnerPk

string

目錄所屬的主帳號 ID。

1639738******

TargetType

string

RAM 使用者同步的目標類型。目前取值為RD-Account

RD-Account

PrincipalType

string

RAM 使用者同步的身份類型。取值:

  • User:表示該 RAM 使用者同步的身份是雲 SSO 使用者。

  • Group:表示該 RAM 使用者同步的身份是雲 SSO 使用者組。

Group

RequestId

string

請求 ID。

F6F90F3D-4502-5877-B80B-97476F6AE2CC

樣本

正常返回樣本

JSON格式

{
  "UserProvisioning": {
    "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": "testTargetName",
    "TargetId": "1743382******",
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-003qew84****",
    "OwnerPk": "1639738******",
    "TargetType": "RD-Account",
    "PrincipalType": "Group"
  },
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情