すべてのプロダクト
Search

このプロダクト

    CloudSSO:ListUserProvisionings

    ドキュメントセンター

    CloudSSO:ListUserProvisionings

    最終更新日:Dec 20, 2025

    Resource Access Management (RAM) のユーザープロビジョニングをクエリします。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cloudsso:ListUserProvisionings

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DirectoryId

    string

    必須

    リソースディレクトリの ID。

    d-003qew84****
    PrincipalId

    string

    任意

    RAM ユーザープロビジョニングの ID。 有効な値：

    • PrincipalType パラメーターに Group が返される場合、このパラメーターの値は CloudSSO ユーザーグループの ID (g-********) です。

    • PrincipalType パラメーターに User が返される場合、このパラメーターの値は CloudSSO ユーザーの ID (u-********) です。

    u-88d73u*****
    PrincipalType

    string

    任意

    RAM ユーザープロビジョニングの ID タイプ。 有効な値：

    • User：RAM ユーザープロビジョニングの ID は CloudSSO ユーザーです。

    • Group：RAM ユーザープロビジョニングの ID は CloudSSO ユーザーグループです。

    RD-Account
    TargetId

    string

    任意

    RAM ユーザープロビジョニングを作成するオブジェクトの ID。 値は、リソースディレクトリ内のメンバーの ID に固定されます。

    1743382******
    TargetType

    string

    任意

    RAM ユーザープロビジョニングを作成するオブジェクト。 値は RD-Account に固定されます。

    User
    MaxResults

    integer

    任意

    1 ページあたりの最大エントリ数。

    有効な値：1～100。

    デフォルト値：10。

    100
    NextToken

    string

    任意

    次のリクエストを開始するために使用されるトークン。 この操作を初めて呼び出す場合、NextToken パラメーターを指定する必要はありません。

    この操作を初めて呼び出す際に、返されるエントリの総数が MaxResults の値より大きい場合、エントリは切り捨てられます。 システムは MaxResults の値に基づいてエントリを返し、超過したエントリは返しません。 この場合、レスポンスパラメーター IsTruncated の値は true になり、NextToken が返されます。 次の呼び出しでは、NextToken の値を使用し、他のリクエストパラメーターの設定を維持して、超過したエントリをクエリできます。 IsTruncated の値が false になるまで呼び出しを繰り返すことができます。 これにより、すべてのエントリが返されます。

    27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返された結果。

    NextToken

    string

    次のリクエストを開始するためのトークン。

    説明

    このパラメーターは、IsTruncated パラメーターが true に設定されている場合にのみ返されます。

    27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****
    RequestId

    string

    リクエスト ID。

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

    integer

    1 ページあたりの最大エントリ数。

    有効な値：1～100。

    デフォルト値：10。

    100
    TotalCounts

    integer

    返されたエントリの総数。

    110
    UserProvisionings

    array<object>

    RAM ユーザープロビジョニング。

    object

    Status

    string

    RAM ユーザープロビジョニングのステータス。 有効な値：

    • Enabled

    • Disabled

    Enabled
    Description

    string

    説明。

    this is a user provisioning.
    UserProvisioningId

    string

    RAM ユーザープロビジョニングの ID。

    up-002axzhapcbz6e63****
    PrincipalId

    string

    RAM ユーザープロビジョニングの ID。 有効な値：

    • PrincipalType パラメーターに Group が返される場合、このパラメーターの値は CloudSSO ユーザーグループの ID (g-********) です。

    • PrincipalType パラメーターに User が返される場合、このパラメーターの値は CloudSSO ユーザーの ID (u-********) です。

    g-02ha881d*****
    TargetPath

    string

    オブジェクトの RAM ユーザープロビジョニングを作成するリソースディレクトリのパス。

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

    string

    変更時間。

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

    string

    競合処理ポリシー。 このポリシーは、RAM ユーザーが RAM に同期される CloudSSO ユーザーと同じユーザー名を持つ場合に使用されます。 有効な値：

    • KeepBoth：CloudSSO ユーザーが RAM に同期される際、同じユーザー名の RAM ユーザーが存在する場合、システムは CloudSSO ユーザーのユーザー名にサフィックス _sso を付けたユーザー名の RAM ユーザーを作成します。

    • TakeOver：CloudSSO ユーザーが RAM に同期される際、同じユーザー名の RAM ユーザーが存在する場合、システムはその RAM ユーザーを CloudSSO ユーザーで置き換えます。

    KeepBoth
    DeletionStrategy

    string

    削除ポリシー。 このポリシーは、RAM ユーザープロビジョニングを削除する際に、同期されたユーザーを管理するために使用されます。 有効な値：

    • Delete：RAM ユーザープロビジョニングを削除する際、システムは同期されたユーザーを削除します。

    • Keep：RAM ユーザープロビジョニングを削除する際、システムは同期されたユーザーを保持します。

    Delete
    PrincipalName

    string

    RAM ユーザープロビジョニングの ID 名。 有効な値：

    • PrincipalType パラメーターに Group が返される場合、このパラメーターの値は CloudSSO ユーザーグループの名前です。

    • PrincipalType パラメーターに User が返される場合、このパラメーターの値は CloudSSO ユーザーの名前です。

    testGroupName
    TargetName

    string

    RAM ユーザープロビジョニングを作成するオブジェクト。 値は RD-Account に固定されます。

    testRdMember
    TargetId

    string

    RAM ユーザープロビジョニングを作成するオブジェクトの ID。 値は、リソースディレクトリ内のメンバーの ID に固定されます。

    1743382******
    CreateTime

    string

    作成時間。

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

    string

    リソースディレクトリの ID。

    d-003qew84****
    OwnerPk

    string

    リソースディレクトリが属する Alibaba Cloud アカウントの ID。

    1639738******
    TargetType

    string

    RAM ユーザープロビジョニングを作成するオブジェクト。 値は RD-Account に固定されます。

    RD-Account
    PrincipalType

    string

    RAM ユーザープロビジョニングの ID タイプ。 有効な値：

    • User：RAM ユーザープロビジョニングの ID は CloudSSO ユーザーです。

    • Group：RAM ユーザープロビジョニングの ID は CloudSSO ユーザーグループです。

    Group
    IsTruncated

    boolean

    クエリされたエントリが切り捨てられたかどうかを示します。 有効な値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。