IdP 設定向け GetIdentityProvider API リファレンス - EIAM - Alibaba Cloud - Identity as a Service

ID プロバイダーエンティティを取得します。

今すぐお試しください

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

get

*IdentityProvider。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
IdentityProviderId	string	必須	ID プロバイダーエンティティの ID。	idp_my664lwkhpicbyzirog3xxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
IdentityProviderDetail	object	ID プロバイダーエンティティの情報フォーマット。
AdvancedStatus	string	詳細設定機能。有効な値: disabled: 無効。 enabled: 有効。	disabled
AuthnSourceSupplier	string	認証ソースプロダクト (Okta、Google、Azure AD など)。有効な値: urn:alibaba:idaas:idp:alibaba:dingtalk: DingTalk。 urn:alibaba:idaas:idp:unknown:ldap: LDAP。 urn:alibaba:idaas:idp:alibaba:idaas: Alibaba Cloud IDaaS。 urn:alibaba:idaas:idp:tencent:wecom: WeCom。 urn:alibaba:idaas:idp:bytedance:lark: Lark。 urn:alibaba:idaas:idp:microsoft:ad: Active Directory。 urn:alibaba:idaas:idp:microsoft:aad: Azure Active Directory。 urn:alibaba:idaas:idp:alibaba:sase: Alibaba Cloud SASE。	urn:alibaba:idaas:idp:bytedance:lark
AuthnSourceType	string	認証タイプ (OIDC または SAML)。有効な値: urn:alibaba:idaas:authntype:oidc: OIDC。 urn:alibaba:idaas:authntype:saml2: SAML。	urn:alibaba:idaas:authntype:oidc
AuthnStatus	string	対応する IdP が認証をサポートするかどうかを示します。有効な値: disabled: 無効。 enabled: 有効。	disabled
CreateTime	integer	作成時間 (UNIX タイムスタンプフォーマット)。単位: ミリ秒。	1726021079000
Description	string	ID プロバイダーエンティティの説明。	for poc test
DingtalkAppConfig	object	DingTalk の基本構成。
AppKey	string	DingTalk ファーストパーティアプリケーションの AppKey。	41reopmwoy9s
AppSecret	string	DingTalk ファーストパーティアプリケーションの AppSecret。	REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx
CorpId	string	DingTalk ファーストパーティアプリケーションの CorpId。	3756043633237690761
DingtalkLoginVersion	string	DingTalk QR コードログインのバージョン。列挙値: old_version : DingTalk レガシー QR コードログイン。 new_version : DingTalk 新 QR コードログイン。	old_version
DingtalkVersion	string	DingTalk のバージョン。有効な値: public_dingtalk: 標準 DingTalk。 private_dingtalk: 専用 DingTalk。	public_dingtalk
EncryptKey	string	DingTalk アプリケーションの EncryptKey。	29003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d
VerificationToken	string	DingTalk アプリケーションの VerificationToken。	5ba9c127a7abe029003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d
DingtalkProvisioningConfig	object	DingTalk のプロビジョニング構成。この値は DingTalk タイプの場合にのみ返されます。
AuthedDepartmentIds	array<object>	許可された DingTalk 部門。
	object
DeptId	string	DingTalk 部門の ID。	123xxx444
DeptName	string	DingTalk 部門名。	test_department
AuthedUsers	array<object>	許可された DingTalk アカウントのリスト。
	object
Name	string	DingTalk のユーザー名。	zhangsan
UserId	string	DingTalk ユーザーの ID。	130308333929200479
CorpId	string	DingTalk 企業の CorpId。	ding_xxxxx
CorpName	string	DingTalk 企業名。	test_enterprise
EndpointMetadata	object	エンドポイントのメタデータ。
SamlAcsEndpoint	string	SAML アサーションコンシューマーサービス (ACS) エンドポイント。	https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/acs
SamlEntityId	string	SAML エンティティ ID。	https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta
SamlMetaEndpoint	string	SAML メタデータエンドポイント。	https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta
IdentityProviderExternalId	string	ID プロバイダーエンティティの外部 ID。	idp_xxxx
IdentityProviderId	string	ID プロバイダーエンティティの ID。	idp_mwpcwnhrimlr2horx7xgg7pp7y
IdentityProviderName	string	ID プロバイダーエンティティの名前。	test
IdentityProviderType	string	ID プロバイダーエンティティの同期タイプ。有効な値: urn:alibaba:idaas:idp:alibaba:dingtalk:pull: インバウンド DingTalk。 urn:alibaba:idaas:idp:alibaba:dingtalk:push: アウトバウンド DingTalk。 urn:alibaba:idaas:idp:tencent:wecom:pull: インバウンド WeCom。 urn:alibaba:idaas:idp:bytedance:lark:pull: インバウンド Lark。 urn:alibaba:idaas:idp:microsoft:ad:pull: インバウンド AD。 urn:alibaba:idaas:idp:unknown:ldap:pull: インバウンド LDAP。 urn:alibaba:idaas:idp:standard:oidc: 標準 OIDC。 urn:alibaba:idaas:idp:alibaba:sase: SASE カスタム OIDC。	urn:alibaba:idaas:idp:alibaba:dingtalk:push
InstanceId	string	インスタンスの ID。	idaas_x2df3bak3uwnapqm6xxxx
LarkConfig	object	Lark の構成。
AppId	string	Lark カスタムアプリケーションの CorpId。	cli_a7a99f53a317100c
AppSecret	string	Lark カスタムアプリケーションの AppSecret。	REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx
EncryptKey	string	Lark カスタムアプリケーションの EncryptKey。	VkdWw91mdkrjVFr3ObNwefap21dfbZbK
EnterpriseNumber	string	Lark の企業番号。	FX1231xxxx
VerificationToken	string	Lark カスタムアプリケーションの VerificationToken。	VkdWw91mdkrjVFr3ObNwefap21dfbZbK
LastStatusCheckJobResult	string	最終ステータスチェックの結果。	success
LdapConfig	object	AD/LDAP ID プロバイダーの情報。
AdministratorPassword	string	AD/LDAP 管理者パスワード。	123456
AdministratorUsername	string	AD/LDAP 管理者ユーザー名。	example.com
CertificateFingerprintStatus	string	証明書指紋の検証が有効かどうかを示します。有効な値: disabled: 無効。 enabled: 有効。	enabled
CertificateFingerprints	array	証明書指紋のリスト。
	string	公開鍵の SHA-256 フォーマットの証明書指紋。	asdsadaasd
LdapProtocol	string	AD/LDAP の通信プロトコル。	ldap
LdapServerHost	string	AD/LDAP サーバーアドレス。	127.xx.xx.100
LdapServerPort	integer	AD/LDAP サーバーアドレス。	389
StartTlsStatus	string	StartTLS が有効かどうかを示します。有効な値: disabled: 無効。 enabled: 有効。	enabled
LockReason	string	ロック理由。	financial
LogoUrl	string	ID プロバイダーのカスタムロゴ URL。	https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg
NetworkAccessEndpointId	string	ネットワークアクセスエンドポイントの ID。	nae_mx4vsadfe6govkqkwckxxxx
OidcConfig	object	OIDC IdP の構成。
AuthnParam	object	OIDC クライアント認証の構成。
AuthnMethod	string	OIDC の認証方式。	client_secret_post
ClientId	string	OIDC クライアントの ID。	mkv7rgt4d7i4u7zqtzev2mxxxx
ClientSecret	string	OIDC クライアントシークレット。	CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx
EndpointConfig	object	OIDC エンドポイントの構成。
AuthorizationEndpoint	string	OIDC 権限付与エンドポイント。	https://example.com/oauth/authorize
Issuer	string	OIDC 発行者の情報。	https://example.com/oauth
JwksUri	string	OIDC JWKS URI。	https://example.com/oauth/jwks
TokenEndpoint	string	OIDC トークンエンドポイント。	https://example.com/oauth/token
UserinfoEndpoint	string	OIDC ユーザー情報エンドポイント。	https://example.com/oauth/userinfo
GrantScopes	array	OIDC 権限付与範囲のリスト。	openid
	string	OIDC 権限付与範囲。	ou_asdaq1addsxzdq1xxxx
GrantType	string	OIDC 権限付与タイプ。	authorization_code
PkceChallengeMethod	string	PKCE チャレンジメソッド。有効な値: S256: SHA-256。 plain: プレーンテキスト。	S256
PkceRequired	boolean	AuthorizationCode 権限付与モードで PKCE が使用されるかどうかを示します。	true
SamlConfig	object	SAML IdP の構成。
BindingMethod	string	バインディングタイプ。列挙値: HTTP-POST : HTTP POST フォームバインディング。 HTTP-REDIRECT : HTTP リダイレクトバインディング。	HTTP-REDIRECT
Certificates	array<object>	IdP 署名証明書のリスト。
	array<object>	証明書情報。
CertificateMetadata	object	証明書メタデータ。
NotAfter	integer	証明書の有効期限が切れる日付。	1704067200000
NotBefore	integer	証明書の有効期限が始まる日付。	1672531200000
Content	string	証明書コンテンツ。	-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----
IdPEntityId	string	IdP のエンティティ ID。	http://dc.test.com/adfs/services/trust
IdPSsoUrl	string	IdP の SSO URL。	https://dc.test.com/adfs/ls/
MaxClockSkew	integer	時計スキューの最大値。	180
RequireRequestSigned	boolean	リクエストに署名が必須かどうかを示します。	true
WantAssertionsSigned	boolean	外部 ID プロバイダーによるアサーションへの署名が必須かどうかを示します。	true
WantResponseSigned	boolean	外部 ID プロバイダーによるレスポンスへの署名が必須かどうかを示します。	true
UdPullConfig	object	インバウンド同期の構成。
GroupSyncStatus	string	グループ同期が有効かどうかを示します。有効な値: disabled enabled	disabled
IncrementalCallbackStatus	string	増分コールバックステータス。ID プロバイダーからの増分コールバックデータを処理するかどうかを示します。有効な値: disabled enabled	disabled
UdSyncScopeConfig	object	同期範囲の構成。
SourceScopes	array	同期のソースノードのリスト。
	string	同期のソースノード。	ou_123xxxx
TargetScope	string	同期のターゲットノード。	ou_123xxxx
UdPullStatus	string	インバウンド同期の特徴がサポートされているかどうかを示します。有効な値: disabled enabled	disabled
UdPushConfig	object	アウトバウンド同期の構成。
IncrementalCallbackStatus	string	このフィールドは使用されていません。無視してください。	disabled
UdSyncScopeConfigs	array<object>	同期範囲構成のリスト。
	object	同期範囲構成のリスト。
SourceScopes	array	同期のソースノードのリスト。
	string	同期のソースノード。組織 ID を設定します。	ou_123xxxx
TargetScope	string	同期のターゲットノード。	ou_123xxxx
UdPushStatus	string	アウトバウンド同期機能が有効かどうかを示します。有効な値: disabled enabled	disabled
UpdateTime	integer	更新時間。UNIX タイムスタンプフォーマットです。単位: ミリ秒。	1726021079000
WeComConfig	object	WeCom の構成。
AgentId	string	WeCom 自社開発アプリケーションの ID。	1242350
AuthorizeCallbackDomain	string	権限付与コールバックドメイン。	https://example.com/xxxx
ContactSecret	string	WeCom の連絡先シークレット。	mPLLiWv-_9witxxxEJCpk1xkF5hOgBzpRt4kBkxxxx
CorpId	string	WeCom 自社開発アプリケーションの CorpId。	3562012953454577801
CorpSecret	string	WeCom 自社開発アプリケーションの CorpSecret。	weaseiszjskejskaj12sjeszojxxxx
TrustableDomain	string	信頼済みドメイン。	https://example.com
RequestId	string	リクエスト ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A

例

成功レスポンス

JSONJSON

{
  "IdentityProviderDetail": {
    "AdvancedStatus": "disabled",
    "AuthnSourceSupplier": "urn:alibaba:idaas:idp:bytedance:lark",
    "AuthnSourceType": "urn:alibaba:idaas:authntype:oidc",
    "AuthnStatus": "disabled",
    "CreateTime": 1726021079000,
    "Description": "POC テスト用",
    "DingtalkAppConfig": {
      "AppKey": "41reopmwoy9s",
      "AppSecret": "REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx",
      "CorpId": "3756043633237690761",
      "DingtalkLoginVersion": "old_version",
      "DingtalkVersion": "public_dingtalk",
      "EncryptKey": "29003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d",
      "VerificationToken": "5ba9c127a7abe029003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d"
    },
    "DingtalkProvisioningConfig": {
      "AuthedDepartmentIds": [
        {
          "DeptId": "123xxx444",
          "DeptName": "テスト部門"
        }
      ],
      "AuthedUsers": [
        {
          "Name": "zhangsan",
          "UserId": "130308333929200479"
        }
      ],
      "CorpId": "ding_xxxxx",
      "CorpName": "テスト企業"
    },
    "EndpointMetadata": {
      "SamlAcsEndpoint": "https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/acs",
      "SamlEntityId": "https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta",
      "SamlMetaEndpoint": "https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta"
    },
    "IdentityProviderExternalId": "idp_xxxx",
    "IdentityProviderId": "idp_mwpcwnhrimlr2horx7xgg7pp7y",
    "IdentityProviderName": "テスト",
    "IdentityProviderType": "urn:alibaba:idaas:idp:alibaba:dingtalk:push",
    "InstanceId": "idaas_x2df3bak3uwnapqm6xxxx",
    "LarkConfig": {
      "AppId": "cli_a7a99f53a317100c",
      "AppSecret": "***",
      "EncryptKey": "VkdWw91mdkrjVFr3ObNwefap21dfbZbK",
      "EnterpriseNumber": "FX1231xxxx",
      "VerificationToken": "VkdWw91mdkrjVFr3ObNwefap21dfbZbK"
    },
    "LastStatusCheckJobResult": "success",
    "LdapConfig": {
      "AdministratorPassword": "XXXX",
      "AdministratorUsername": "example.com",
      "CertificateFingerprintStatus": "enabled",
      "CertificateFingerprints": [
        "asdsadaasd"
      ],
      "LdapProtocol": "ldap",
      "LdapServerHost": "127.xx.xx.100",
      "LdapServerPort": 389,
      "StartTlsStatus": "enabled"
    },
    "LockReason": "financial",
    "LogoUrl": "https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg",
    "NetworkAccessEndpointId": "nae_mx4vsadfe6govkqkwckxxxx",
    "OidcConfig": {
      "AuthnParam": {
        "AuthnMethod": "client_secret_post",
        "ClientId": "mkv7rgt4d7i4u7zqtzev2mxxxx",
        "ClientSecret": "CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx"
      },
      "EndpointConfig": {
        "AuthorizationEndpoint": "https://example.com/oauth/authorize",
        "Issuer": "https://example.com/oauth",
        "JwksUri": "https://example.com/oauth/jwks",
        "TokenEndpoint": "https://example.com/oauth/token",
        "UserinfoEndpoint": "https://example.com/oauth/userinfo"
      },
      "GrantScopes": [
        "ou_asdaq1addsxzdq1xxxx"
      ],
      "GrantType": "authorization_code",
      "PkceChallengeMethod": "S256",
      "PkceRequired": true
    },
    "SamlConfig": {
      "BindingMethod": "HTTP-REDIRECT",
      "Certificates": [
        {
          "CertificateMetadata": {
            "NotAfter": 1704067200000,
            "NotBefore": 1672531200000
          },
          "Content": "-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----"
        }
      ],
      "IdPEntityId": "http://dc.test.com/adfs/services/trust",
      "IdPSsoUrl": "https://dc.test.com/adfs/ls/",
      "MaxClockSkew": 180,
      "RequireRequestSigned": true,
      "WantAssertionsSigned": true,
      "WantResponseSigned": true
    },
    "UdPullConfig": {
      "GroupSyncStatus": "disabled",
      "IncrementalCallbackStatus": "disabled",
      "UdSyncScopeConfig": {
        "SourceScopes": [
          "ou_123xxxx"
        ],
        "TargetScope": "ou_123xxxx"
      }
    },
    "UdPullStatus": "disabled",
    "UdPushConfig": {
      "IncrementalCallbackStatus": "disabled",
      "UdSyncScopeConfigs": [
        {
          "SourceScopes": [
            "ou_123xxxx"
          ],
          "TargetScope": "ou_123xxxx"
        }
      ]
    },
    "UdPushStatus": "disabled",
    "UpdateTime": 1726021079000,
    "WeComConfig": {
      "AgentId": "1242350",
      "AuthorizeCallbackDomain": "https://example.com/xxxx",
      "ContactSecret": "mPLLiWv-_9witxxxEJCpk1xkF5hOgBzpRt4kBkxxxx",
      "CorpId": "3562012953454577801",
      "CorpSecret": "weaseiszjskejskaj12sjeszojxxxx",
      "TrustableDomain": "https://example.com"
    }
  },
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

エラーコード

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

変更履歴

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