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

Identity as a Service:SetApplicationSsoConfig

最終更新日:Sep 21, 2026

EIAM アプリケーションのシングルサインオン (SSO) 構成プロパティを設定します。

操作説明

EIAM のアプリケーション管理では、複数のシングルサインオン (SSO) プロトコル (SAML 2.0 および OIDC) を使用するアプリケーションの追加がサポートされています。ただし、各アプリケーションでサポートされるシングルサインオン (SSO) プロトコルは 1 つのみであり、作成時に指定され、後から変更できません。現在のアプリケーションでサポートされているシングルサインオン (SSO) プロトコルの種類に基づいて、対応するシングルサインオン (SSO) 構成プロパティパラメーターを指定します。

今すぐお試しください

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

create

*アプリケーション。

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

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

InstanceId

string

必須

インスタンスの ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

ApplicationId

string

必須

アプリケーションの ID。

app_mkv7rgt4d7i4u7zqtzev2mxxxx

SamlSsoConfig

object

任意

SAML ベースのアプリケーションの SSO 構成パラメーター。

AssertionSigned

boolean

任意

アサーションに署名する必要があるかどうかを指定します。ResponseSigned と AssertionSigned の両方を false に設定することはできません。

  • true: アサーションに署名します。

  • false: アサーションに署名しません。

true

AttributeStatements

array<object>

任意

SAML アサーションに含まれる追加のユーザー属性構成。

object

任意

AttributeName

string

任意

SAML アサーションの属性の名前。

https://www.aliyun.com/SAML-Role/Attributes/RoleSessionName

AttributeValueExpression

string

任意

SAML アサーションの属性の値式。

user.username

DefaultRelayState

string

任意

デフォルトの RelayState 値。EIAM によってシングルサインオン (SSO) ログインリクエストが開始されると、EIAM から提供される SAML Response の RelayState としてこの値が指定されます。

https://home.console.alibabacloud.com

IdPEntityId

string

任意

SAML プロトコルにおける IdP の ID を表すエンティティ ID。URL フォーマットと URN フォーマットがサポートされています。 [parameters.2.schema.properties.NameIdFormat.enumValueTitles.urn:oasis:names:tc:SAML:1 DOT 1:nameid-format:unspecified]未指定。これがデフォルト値です。 [parameters.2.schema.properties.NameIdFormat.enumValueTitles.urn:oasis:names:tc:SAML:2 DOT 0:nameid-format:persistent]永続的。 [parameters.2.schema.properties.NameIdFormat.enumValueTitles.urn:oasis:names:tc:SAML:2 DOT 0:nameid-format:transient]一時的。

https://example.com/

NameIdFormat

string

任意

SAML プロトコル標準で定義されている NameID フォーマット。有効な値:

  • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified: 未指定。アプリケーションが NameID の解析方法を決定します。

  • urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress: メールアドレスフォーマット。

  • urn:oasis:names:tc:SAML:2.0:nameid-format:persistent: 永続的な NameID。

  • urn:oasis:names:tc:SAML:2.0:nameid-format:transient: 一時的な NameID。

列挙値:

  • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified :

    未指定。これがデフォルト値です。

  • urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress :

    メールアドレスフォーマット。

  • urn:oasis:names:tc:SAML:2.0:nameid-format:persistent :

    永続的。

  • urn:oasis:names:tc:SAML:2.0:nameid-format:transient :

    一時的。

urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

NameIdValueExpression

string

任意

SAML プロトコルで実際の NameID 値を生成するために使用される式。

user.email

OptionalRelayStates

array<object>

任意

オプションの RelayState 構成。

object

任意

オプションの RelayState 構成。

DisplayName

string

任意

RelayState の表示名。

Ram

RelayState

string

任意

RelayState 値。

https://ram.console.alibabacloud.com/

RequireAuthnRequestSigned

boolean

任意

SSO AuthnRequest の署名検証が有効かどうかを指定します。デフォルト値: false。true に設定した場合、spSigningCertificates を構成する必要があります (配列は空にできません)。

false

ResponseSigned

boolean

任意

応答に署名する必要があるかどうかを指定します。ResponseSigned と AssertionSigned の両方を false に設定することはできません。

  • true: 応答に署名します。

  • false: 応答に署名しません。

true

SignatureAlgorithm

string

任意

SAML アサーションの署名アルゴリズム。

列挙値:

  • RSA-SHA256 :

    RSA-SHA256 アルゴリズム。

RSA-SHA256

SpEntityId

string

任意

アプリケーション (SP) の SAML EntityId。

urn:alibaba:cloudcomputing

SpSigningCertificates

array

任意

PEM フォーマットの SP 署名検証証明書の配列。証明書の最大値は 2 つであり、シングルサインオン (SSO) と SLO で共有されます。各証明書は、書き込み時にフォーマットと有効性が検証されます。3 つ以上の証明書を含むリクエストは拒否されます。

-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----

string

任意

PEM フォーマットの SP 署名検証証明書。

-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----

SpSloResponseUrl

string

任意

LogoutResponse を受信する SP 側の URL。このパラメーターはオプションです。

https://example.com/api/slo/response

SpSsoAcsUrl

string

任意

アプリケーション (SP) の SAML アサーション消費者サービス URL。

https://signin.alibabacloud.com/saml-role/sso

OidcSsoConfig

object

任意

OIDC ベースのアプリケーションの SSO 構成パラメーター。

AccessTokenEffectiveTime

integer

任意

発行されたアクセストークンの有効期間。単位: 秒。デフォルト値: 1200 (20 分)。

1200

AllowedPublicClient

boolean

任意

アプリケーションがパブリッククライアントとして IDaaS EIAM 権限付与サーバーにリクエストすることを許可するかどうかを指定します。このパラメーターは、認証コードモードおよびデバイスモードでのみ有効です。デフォルト値: false。

true

CodeEffectiveTime

integer

任意

発行されたコードの有効期間。単位: 秒。デフォルト値: 60 (1 分)。

60

CustomClaims

array<object>

任意

返される ID トークンに含まれるカスタムユーザー情報。

object

任意

ClaimName

string

任意

返されるクレームの名前。

"Role"

ClaimValueExpression

string

任意

返されるクレームの値式。

user.dict.アプリケーションRole

GrantScopes

array

任意

OIDC 標準パラメーターの範囲。userinfo エンドポイントまたは id_トークン から返されるユーザー属性の範囲を指定します。

プロファイル、email

string

任意

OIDC 標準パラメーターの範囲。userinfo エンドポイントまたは id_トークン から返されるユーザー属性の範囲を指定します。有効な値:

  • openid: OIDC 標準パラメーター。一意のユーザー ID。

  • プロファイル: 詳細なユーザー情報。

  • email: ユーザーのメール情報。

  • phone: ユーザーの電話情報。

openid

GrantTypes

array

任意

サポートされる OIDC グラントタイプのリスト。

権限付与_コード

string

任意

サポートされている OIDC 権限付与タイプ。有効な値:

  • authorization_code: 認証コードモード。

  • implicit: 暗黙モード。

  • refresh_token: リフレッシュトークンモード。

  • urn:ietf:params:oauth:grant-type:device_code: デバイスモード。

  • password: パスワードモード。

権限付与_コード

IdTokenEffectiveTime

integer

任意

発行された ID トークンの有効期間。単位: 秒。デフォルト値: 300 (5 分)。

300

PasswordAuthenticationSourceId

string

任意

パスワードモードで使用される認証ソースの ID。このパラメーターは、OIDC アプリケーションに指定された GrantTypes にパスワードモードが含まれている場合にのみ有効です。

ia_password

PasswordTotpMfaRequired

boolean

任意

パスワードモードで TOTP ベースの二次認証が必須かどうかを指定します。このパラメーターは、OIDC アプリケーションに指定された GrantTypes にパスワードモードが含まれている場合にのみ有効です。

true

PkceChallengeMethods

array

任意

PKCE で Code Challenge を計算するために使用されるアルゴリズム。

S256

string

任意

PKCE で Code Challenge を計算するために使用されるアルゴリズム。有効な値:

  • plain: プレーンテキスト。

  • S256: SHA-256 アルゴリズム。

S256

PkceRequired

boolean

任意

アプリケーションのシングルサインオン (SSO) において、Proof Key for Code Exchange (PKCE) (RFC 7636) が必須かどうかを指定します。

true

PostLogoutRedirectUris

array

任意

アプリケーションでサポートされるログアウトコールバック URI のリスト。

string

任意

アプリケーションのホワイトリストに登録されたログアウトコールバック URI。アプリケーションがログアウトリクエストを開始する際に 投稿_logout_redirect_uri パラメーターを指定できます。

https://example.com/oidc/logout/コールバック

RedirectUris

array

任意

アプリケーションでサポートされるリダイレクト URI のリスト。

string

任意

アプリケーションでサポートされるリダイレクト URI。

https://example.com/oidc/login/コールバック

RefreshTokenEffective

integer

任意

発行されたトークンの更新の有効期間。単位: 秒。デフォルト値: 86400 (1 日)。

86400

ResponseTypes

array

任意

OidcSsoConfig.GrantTypes にインプリシットグラントタイプが含まれている場合にアプリケーションがサポートする応答タイプ。

トークン id_トークン

string

任意

OIDC 標準の ResponseType パラメーター。このパラメーターは、GrantTypes にインプリシットグラントタイプが含まれている場合にのみ効果があります。有効な値:

  • token: アクセストークンのみを返します。

  • id_token: ID トークンのみを返します。

  • token id_token: アクセストークンと ID トークンの両方を返します。

トークン id_トークン

SubjectIdExpression

string

任意

ID トークンで返される sub クレーム値のカスタム式。

user.userid

InitLoginType

string

任意

初期のシングルサインオン (SSO) ログインメソッド。有効な値:

  • only_app_init_sso: アプリケーション開始 SSO のみがサポートされます。これは OIDC プロトコルアプリケーションのデフォルト値です。SAML アプリケーションでこのメソッドを使用する場合、InitLoginUrl を指定する必要があります。

  • idaas_or_app_init_sso: IDaaS ポータル開始 SSO とアプリケーション開始 SSO の両方がサポートされます。これは SAML プロトコルアプリケーションのデフォルト値です。OIDC プロトコルアプリケーションでこのメソッドを使用する場合、InitLoginUrl を指定する必要があります。

only_app_init_sso

InitLoginUrl

string

任意

初期のシングルサインオン (SSO) ログインのトリガー URL。 このパラメーターは、OIDC プロトコルアプリケーションで InitLoginType を idaas_or_app_init_sso にセットする場合に必須です。 このパラメーターは、SAML プロトコルアプリケーションで InitLoginType を only_app_init_sso にセットする場合に必須です。

http://127.0.0.1:8000/start_login?enterprise_コード=ABCDEF

ClientToken

string

任意

リクエストのべき等性を確保するために使用されるクライアントトークン。クライアント側で一意の値を生成します。値のフォーマットには ASCII 文字のみを使用でき、長さは 64 文字以下にしてください。詳細については、「べき等性を確保する方法」を参照してください。

クライアント-examplexxx

レスポンスフィールド

フィールド

型

説明

例

object

RequestId

string

リクエスト ID。

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

例

成功レスポンス

JSONJSON

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

エラーコード

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

変更履歴

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