すべてのプロダクト
Search

このプロダクト

    CloudSSO:SetExternalSAMLIdentityProvider

    ドキュメントセンター

    CloudSSO:SetExternalSAMLIdentityProvider

    最終更新日:Dec 20, 2025

    Security Assertion Markup Language (SAML) ID プロバイダー (IdP) を構成します。

    操作説明

    SAML 2.0 ベースのシングルサインオン (SSO) ログインでは、CloudSSO はサービスプロバイダー (SP) であり、企業の ID 管理システムは ID プロバイダー (IdP) です。

    SAML IdP を構成するには、次のいずれかのメソッドを使用できます。必要なメタデータファイルまたはパラメーター値は、ご利用の IdP から取得できます。

    • メタデータファイルの使用：EncodedMetadataDocument パラメーターを指定して、メタデータファイルをアップロードできます。

    • IdP の手動構成：ご利用の IdP に対して、EntityId、LoginUrl、WantRequestSigned、X509Certificate などのパラメーターを手動で指定できます。

    SAML IdP を構成済みの場合、この操作を呼び出すと、既存の構成が置き換えられます。

    • IdP がメタデータファイルを使用して構成されている場合、既存のすべての構成が新しい構成に置き換えられます。

    • IdP が手動で構成されている場合、新しいパラメーター値と異なる元のパラメーター値が置き換えられます。

    説明

    シングルサインオン (SSO) ログインが有効になっている場合、新しい構成はすぐに有効になります。本番環境への影響にご注意ください。

    このトピックでは、ディレクトリ d-00fc2p61**** 内でメタデータファイルを使用して 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cloudsso:SetExternalSAMLIdentityProvider

    update

    *Directory

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DirectoryId

    string

    必須

    ディレクトリの ID。

    d-00fc2p61****
    EncodedMetadataDocument

    string

    任意

    IdP のメタデータファイル。このパラメーターの値は Base64 エンコードされています。

    このファイルは、SAML 2.0 をサポートする IdP によって提供されます。

    PD94bWwgdmVyc2lvbj0iMS4****
    SSOStatus

    string

    任意

    シングルサインオン (SSO) ログインのステータス。有効な値：

    • Enabled

    • Disabled (デフォルト)

    Disabled
    EntityId

    string

    任意

    IdP のエンティティ ID。

    http://www.okta.com/exk3qwgtjhetR2Od****
    LoginUrl

    string

    任意

    IdP のログイン URL。

    https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
    WantRequestSigned

    boolean

    任意

    CloudSSO が SAML リクエストに署名する必要があるかどうかを指定します。このリクエストは、ユーザーが CloudSSO ユーザーポータルにログインして SAML ベースの SSO を開始するときに送信されます。有効な値：

    • true

    • false (デフォルト)

    false
    X509Certificate

    string

    任意

    PEM フォーマットの X.509 証明書。このパラメーターを指定すると、既存のすべての証明書が置き換えられます。

    MIIC8DCCAdigAwIBAgIQP9eomUYGeoND****
    BindingType

    string

    任意

    SAML リクエストを送信するためのバインディング。有効な値：

    • Post：HTTP Post バインディング。

    • Redirect：HTTP Redirect バインディング。

    Redirect

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    63160579-2E1B-57B0-8273-B27427172385
    SAMLIdentityProviderConfiguration

    object

    IdP の構成。

    EntityId

    string

    IdP のエンティティ ID。

    http://www.okta.com/exk3qwgtjhetR2Od****
    SSOStatus

    string

    シングルサインオン (SSO) ログインのステータス。有効な値：

    • Enabled

    • Disabled

    Disabled
    DirectoryId

    string

    ディレクトリの ID。

    d-00fc2p61****
    EncodedMetadataDocument

    string

    IdP のメタデータファイル。このパラメーターの値は Base64 エンコードされています。

    PD94bWwgdmVyc2lvbj0iMS4****
    CreateTime

    string

    IdP が初めて構成された時間。

    2021-11-10T02:57:16Z
    WantRequestSigned

    boolean

    CloudSSO が SAML リクエストに署名する必要があるかどうかを示します。このリクエストは、ユーザーが CloudSSO ユーザーポータルにログインして SAML ベースの SSO を開始するときに送信されます。有効な値：

    • true

    • false (デフォルト)

    false
    UpdateTime

    string

    IdP 構成が最後に変更された時間。

    2021-11-10T02:57:16Z
    CertificateIds

    array

    SAML 署名証明書の ID。

    string

    SAML 署名証明書の ID。

    複数の ID はコンマ (,) で区切られます。

    [ "idp-c-00buzdx63z8ewtdf****", "idp-c-00gmuxnr2mrek3t2****" ]
    LoginUrl

    string

    IdP のログイン URL。

    https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
    BindingType

    string

    SAML リクエストを送信するためのバインディング。有効な値：

    • Post：HTTP Post バインディング。

    • Redirect：HTTP Redirect バインディング。

    Redirect

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "63160579-2E1B-57B0-8273-B27427172385",
  "SAMLIdentityProviderConfiguration": {
    "EntityId": "http://www.okta.com/exk3qwgtjhetR2Od****",
    "SSOStatus": "Disabled",
    "DirectoryId": "d-00fc2p61****",
    "EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4****",
    "CreateTime": "2021-11-10T02:57:16Z",
    "WantRequestSigned": false,
    "UpdateTime": "2021-11-10T02:57:16Z",
    "CertificateIds": [
      "[ \"idp-c-00buzdx63z8ewtdf****\", \"idp-c-00gmuxnr2mrek3t2****\" ]"
    ],
    "LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml",
    "BindingType": "Redirect"
  }
}

    エラーコード

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

    変更履歴

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