すべてのプロダクト
Search
ドキュメントセンター

Identity as a Service:GetIdentityProviderUdPullConfiguration

最終更新日:Sep 10, 2026

ID プロバイダー (IdP) のインバウンド同期構成を取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eiam:GetIdentityProviderUdPullConfiguration

get

*IdentityProvider。

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

InstanceId

string

必須

インスタンスの ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

IdentityProviderId

string

必須

ID プロバイダーの ID。

idp_my664lwkhpicbyzirog3xxxxx

レスポンスフィールド

フィールド

型

説明

例

object

RequestId

string

リクエストの ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

UdPullConfiguration

object

インバウンド同期構成。

InstanceId

string

インスタンスの ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

IdentityProviderId

string

ID プロバイダーの ID。

idp_my664lwkhpicbyzirog3xxxxx

IncrementalCallbackStatus

string

増分コールバックステータス。IdP からの増分コールバックデータをプロセスするかどうかを指定します。有効な値:

  • disabled: 無効。

  • enabled: 有効。

enabled

PeriodicSyncStatus

string

定期検証ステータス。IDaaS と ID プロバイダー間のデータの差分を定期的に検証するかどうかを指定します。有効な値:

  • disabled: 無効。

  • enabled: 有効。

enabled

GroupSyncStatus

string

グループ同期ステータス。有効な値:

  • disabled: 無効。

  • enabled: 有効。

enabled

UdSyncScopeConfig

object

同期範囲構成。

SourceScopes

array

ソース範囲ノードのリスト。

string

ソース範囲ノード。

960

TargetScope

string

ターゲット範囲ノード。

ou_asjdfhaskfhw213mnsj33sXXX

PullProtectedRule

object

インバウンド同期保護ルール構成。

UserDeletedThreshold

integer

削除されたアカウント数のしきい値。削除されたユーザー数がこの値を超えると、同期タスクは終了します。

30

OrganizationalUnitDeletedThreshold

integer

削除された組織単位数のしきい値。削除された組織単位数がこの値を超えると、同期タスクは終了します。

10

GroupDeletedThreshold

integer

削除されたグループの数のしきい値。削除されたグループの数がこの値を超えると、同期タスクが終了されます。

10

LdapUdPullConfig

object

LDAP 同期構成。

UserObjectClass

string

ユーザーの objectClass。

ou,top

OrganizationUnitObjectClass

string

組織単位の objectClass。

ou,top

UserObjectClassCustomFilter

string

ユーザーのカスタムフィルター。

(|(cn=test)(mail=test@test.com))

GroupObjectClass

string

グループの objectClass。

メンバー

GroupMemberAttributeName

string

グループメンバーの属性名。

グループ

GroupObjectClassCustomFilter

string

グループのカスタムフィルター。

(|(cn=test)(グループ=test@test.com))

PeriodicSyncConfig

object

定期同期構成。

PeriodicSyncType

string

定期同期タイプ。

列挙値:

  • cron :

    cron 式。

  • time :

    時間。

cron

PeriodicSyncCron

string

cron 式。

0 45 1 * * ?

PeriodicSyncTimes

integer

実行時間。たとえば、[3, 5] は、タスクが 3:00 から 4:00 の間に 1 回、5:00 から 6:00 の間に 1 回実行されることを示します。

[3,5]

例

成功レスポンス

JSONJSON

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "UdPullConfiguration": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "IdentityProviderId": "idp_my664lwkhpicbyzirog3xxxxx\n",
    "IncrementalCallbackStatus": "enabled",
    "PeriodicSyncStatus": "enabled",
    "GroupSyncStatus": "enabled",
    "UdSyncScopeConfig": {
      "SourceScopes": [
        "960"
      ],
      "TargetScope": "ou_asjdfhaskfhw213mnsj33sXXX"
    },
    "PullProtectedRule": {
      "UserDeletedThreshold": 30,
      "OrganizationalUnitDeletedThreshold": 10,
      "GroupDeletedThreshold": 10
    },
    "LdapUdPullConfig": {
      "UserObjectClass": "ou,top",
      "OrganizationUnitObjectClass": "ou,top",
      "UserObjectClassCustomFilter": "(|(cn=test)(mail=test@test.com))",
      "GroupObjectClass": "member",
      "GroupMemberAttributeName": "group",
      "GroupObjectClassCustomFilter": "(|(cn=test)(group=test@test.com))"
    },
    "PeriodicSyncConfig": {
      "PeriodicSyncType": "cron",
      "PeriodicSyncCron": "0 45 1 * * ?",
      "PeriodicSyncTimes": 0
    }
  }
}

エラーコード

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

変更履歴

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