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

Identity as a Service:GetApplicationProvisioningConfig

最終更新日:Aug 26, 2025

Entity Identity and Access Management (EIAM) アプリケーションのアカウント同期構成を取得します。

今すぐお試しください

この 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:GetApplicationProvisioningConfig

get

*Application

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

必須

インスタンス ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

ApplicationId

string

必須

アプリケーション ID。

app_mkv7rgt4d7i4u7zqtzev2mxxxx

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

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

ApplicationProvisioningConfig

object

アプリケーションのアカウント同期構成。

InstanceId

string

インスタンス ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

ApplicationId

string

アプリケーション ID。

app_mkv7rgt4d7i4u7zqtzev2mxxxx

ProvisionProtocolType

string

アプリケーション同期のプロトコルタイプ。有効な値:

  • idaas_callback: IDaaS のカスタムイベントコールバックプロトコル。

  • scim2: System for Cross-domain Identity Management (SCIM) プロトコル。

idaas_callback

ProvisionJwksEndpoint

string

アプリケーション同期コールバックメッセージの署名検証用の公開鍵エンドポイント。

https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk267xxxxx/app_mkv7rgt4d7i4u7zqtzev2mxxxx/provisioning/jwks

CallbackProvisioningConfig

object

IDaaS のカスタムイベントコールバックプロトコルの構成パラメーター。

CallbackUrl

string

アプリケーションが IDaaS イベントコールバックを受信する宛先アドレス。

https://example.sp.com/event/callback

EncryptKey

string

IDaaS イベントコールバックの暗号化と復号化に使用する対称鍵。この鍵は AES-256 アルゴリズムを使用し、16 進数形式です。

1adfdfdfd******111

EncryptRequired

boolean

IDaaS イベントコールバックメッセージを暗号化するかどうかを示します。有効な値:

  • true: メッセージは暗号化されます。

  • false: メッセージは暗号化されず、プレーンテキストで送信されます。

true

ListenEventScopes

array

IDaaS イベントコールバックリスナーのメッセージタイプのリスト。

string

IDaaS イベントコールバックリスナーのメッセージタイプ。有効な値のリストについては、アドレス帳イベント を参照してください。有効な値の詳細については、「アドレス帳イベント」をご参照ください。

urn:alibaba:idaas:app:event:ud:user:create

ProvisionPassword

boolean

IDaaS ユーザーイベントコールバックでパスワードを同期するかどうかを示します。有効な値:

  • true: パスワードは同期されます。

  • false: パスワードは同期されません。

true

ScimProvisioningConfig

object

IDaaS SCIM プロトコル同期の構成パラメーター。

ScimBaseUrl

string

アプリケーションが IDaaS SCIM プロトコル同期を受信するベース URL。

https://example.com/scim

AuthnConfiguration

object

SCIM プロトコル同期の構成パラメーター。

AuthnMode

string

SCIM プロトコルインターフェースの認証モード。有効な値:

  • oauth2: OAuth2 モード。

oauth2

GrantType

string

SCIM プロトコルの認証モード。有効な値:

  • client_credentials: クライアントクレデンシャルモード。

  • bearer_token: ベアラートークンモード。

bearer_token

AuthnParam

object

認証の構成パラメーター。使用方法:

  • GrantType が client_credentials に設定されている場合は、ClientId、ClientSecret、および AuthnMethod を指定する必要があります。

  • GrantType が bearer_token に設定されている場合は、AccessToken を指定する必要があります。

AccessToken

string

アクセストークン。このパラメーターは、GrantType が bearer_token に設定されている場合に必須です。

k52x2ru63rlkflina5utgkxxxx

TokenEndpoint

string

トークンエンドポイント。

https://www.example.com/oauth/token

ClientId

string

アプリケーションのクライアント ID。

mkv7rgt4d7i4u7zqtzev2mxxxx

ClientSecret

string

アプリケーションのクライアントシークレット。

CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx

AuthnMethod

string

SCIM プロトコルの認証モード。有効な値:

  • client_secret_basic: キーはリクエストヘッダーで渡されます。

  • client_secret_post: キーはリクエスト本文で渡されます。

client_secret_basic

ProvisioningActions

array

SCIM プロトコルのターゲットリソースに対する操作。有効な値:

  • urn:alibaba:idaas:app:scim:User:CREATE: アカウントを作成します。

  • urn:alibaba:idaas:app:scim:User:UPDATE: アカウントを更新します。

  • urn:alibaba:idaas:app:scim:User:DELETE: アカウントを削除します。

string

SCIM プロトコルのターゲットリソースに対する操作。

urn:alibaba:idaas:app:scim:User:CREATE

FullPushScopes

array

SCIM プロトコルのフルプッシュの範囲。有効な値:

  • urn:alibaba:idaas:app:scim:User:PUSH: ユーザーのフル同期を実行します。

string

SCIM プロトコルのフルプッシュの範囲。

urn:alibaba:idaas:app:scim:User:PUSH

Status

string

IDaaS アカウント同期機能のステータス。有効な値:

  • enabled: 機能は有効です。

  • disabled: 機能は無効です。

enabled

ConfigOperateMode

string

アカウント同期ページのレンダリングモード。有効な値:

  • standard: 標準モード。

  • template: テンプレートモード。

standard

NetworkAccessEndpointId

string

ネットワークエンドポイント ID。

nae_examplexxxx

成功レスポンス

JSONJSON

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "ApplicationProvisioningConfig": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "ApplicationId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "ProvisionProtocolType": "idaas_callback",
    "ProvisionJwksEndpoint": "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk267xxxxx/app_mkv7rgt4d7i4u7zqtzev2mxxxx/provisioning/jwks",
    "CallbackProvisioningConfig": {
      "CallbackUrl": "https://example.sp.com/event/callback",
      "EncryptKey": "1adfdfdfd******111",
      "EncryptRequired": true,
      "ListenEventScopes": [
        "urn:alibaba:idaas:app:event:ud:user:create"
      ]
    },
    "ProvisionPassword": true,
    "ScimProvisioningConfig": {
      "ScimBaseUrl": "https://example.com/scim",
      "AuthnConfiguration": {
        "AuthnMode": "oauth2",
        "GrantType": "bearer_token",
        "AuthnParam": {
          "AccessToken": "k52x2ru63rlkflina5utgkxxxx",
          "TokenEndpoint": "https://www.example.com/oauth/token",
          "ClientId": "mkv7rgt4d7i4u7zqtzev2mxxxx",
          "ClientSecret": "CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx\n",
          "AuthnMethod": "client_secret_basic"
        }
      },
      "ProvisioningActions": [
        "urn:alibaba:idaas:app:scim:User:CREATE"
      ],
      "FullPushScopes": [
        "urn:alibaba:idaas:app:scim:User:PUSH"
      ]
    },
    "Status": "enabled",
    "ConfigOperateMode": "standard",
    "NetworkAccessEndpointId": "nae_examplexxxx"
  }
}

エラーコード

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

変更履歴

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