ListOIDCProviders - - Alibaba Cloud ドキュメントセンター

OIDC ID プロバイダー (IdP) を照会します。

操作説明

このトピックでは、Alibaba Cloud アカウント内のすべての OpenID Connect (OIDC) ID プロバイダー (IdP) を照会する方法の例を示します。応答では、Alibaba Cloud アカウントに TestOIDCProvider という名前の OIDC IdP が 1 つだけ存在することが示されます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ram:ListOIDCProviders

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Marker	string	任意	マーカー。前の応答の一部が切り捨てられた場合、このパラメーターを使用して切り捨てられた部分を取得できます。	EXAMPLE
MaxItems	integer	任意	1 ページあたりのエントリ数。応答が `MaxItems` の値に達したために切り捨てられた場合、`IsTruncated` の値は `true` になります。有効値：1～100。デフォルト値：100。	100

共通リクエストパラメーターの詳細については、「API リファレンス」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	D2148337-B86A-57F0-8B31-EB7BE0125226
OIDCProviders	object
OIDCProvider	array<object>	OIDC IdP に関する情報。
	object
UpdateDate	string	OIDC IdP が変更された時刻。時刻は UTC で表示されます。	2021-11-12T08:38:29Z
Description	string	OIDC IdP の説明。	This is a new OIDC Provider.
OIDCProviderName	string	OIDC IdP の名前。	TestOIDCProvider
CreateDate	string	OIDC IdP が作成された時刻。時刻は UTC で表示されます。	2021-11-11T06:56:03Z
Arn	string	OIDC IdP の Alibaba Cloud リソースネーム (ARN)。	acs:ram::177242285274****:oidc-provider/TestOIDCProvider
IssuerUrl	string	発行者の URL。	https://dev-xxxxxx.okta.com
Fingerprints	string	HTTPS 証明書の指紋。複数の指紋が返された場合、指紋はコンマ (,) で区切られます。	902ef2deeb3c5b13ea4c3d5193629309e231****
ClientIds	string	クライアントの ID。複数のクライアント ID を指定する場合は、クライアント ID をコンマ (,) で区切ります。	498469743454717****
GmtCreate	string	OIDC IdP が作成されたときのタイムスタンプ。	1636613763000
GmtModified	string	OIDC IdP が変更されたときのタイムスタンプ。	1636706309000
IssuanceLimitTime	integer	外部 IdP が ID トークンを発行できる最も早い時刻。ID トークンの iat フィールドの値が現在の時刻より後である場合、リクエストは拒否されます。単位：時間。有効値：1～168。	12
IsTruncated	boolean	応答が切り捨てられているかどうかを示します。有効値： true false	false
Marker	string	マーカー。このパラメーターは、`IsTruncated` の値が `true` の場合にのみ返されます。このパラメーターが返された場合、再度この操作を呼び出す際にこのパラメーターを設定することで、切り捨てられた部分を取得できます。``	EXAMPLE

例

成功レスポンス

JSONJSON

{
  "RequestId": "D2148337-B86A-57F0-8B31-EB7BE0125226",
  "OIDCProviders": {
    "OIDCProvider": [
      {
        "UpdateDate": "2021-11-12T08:38:29Z",
        "Description": "This is a new OIDC Provider.",
        "OIDCProviderName": "TestOIDCProvider",
        "CreateDate": "2021-11-11T06:56:03Z",
        "Arn": "acs:ram::177242285274****:oidc-provider/TestOIDCProvider",
        "IssuerUrl": "https://dev-xxxxxx.okta.com",
        "Fingerprints": "902ef2deeb3c5b13ea4c3d5193629309e231****",
        "ClientIds": "498469743454717****",
        "GmtCreate": "1636613763000",
        "GmtModified": "1636706309000",
        "IssuanceLimitTime": 12
      }
    ]
  },
  "IsTruncated": false,
  "Marker": "EXAMPLE"
}

エラーコード

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

変更履歴

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