ListCredentialProviders - Identity as a Service - Alibaba Cloud Documentation Center

Menampilkan daftar penyedia kredensial.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

eiam:ListCredentialProviders

list

*CredentialProvider.

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx
NextToken	string	No	Token paginasi.	NTxxxxxexample
MaxResults	integer	No	Jumlah entri per halaman dalam kueri berhalaman.	20
CredentialProviderIds	array	No	Daftar ID penyedia kredensial.
	string	No	ID penyedia kredensial.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
CredentialProviderTypes	array	No	Daftar tipe penyedia kredensial.
	string	No	Tipe penyedia kredensial. Nilai valid: oauth: Penyedia kredensial OAuth jwt: Penyedia kredensial JWT	oauth
Statuses	array	No	Daftar status penyedia kredensial.
	string	No	Status penyedia kredensial. Nilai valid: enabled: Diaktifkan. disabled: Dinonaktifkan.	enabled
Filter	array<object>	No	Daftar kondisi filter.
	object	No	Kondisi filter.
Name	string	No	Nama kondisi filter. Nilai valid: CredentialProviderName: Nama penyedia kredensial. CredentialProviderIdentifier: Pengenal penyedia kredensial.	CredentialProviderName
Value	array	No	Daftar nilai kondisi filter.
	string	No	Nilai kondisi filter.	test_example_name

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	Jumlah total entri dalam daftar.	100
NextToken	string	Token paginasi yang dikembalikan oleh panggilan ini.	NTxxxexample
MaxResults	integer	Jumlah entri per halaman dalam kueri berhalaman.	20
CredentialProviders	array<object>	Daftar penyedia kredensial.
	array<object>	Penyedia kredensial.
InstanceId	string	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialProviderId	string	ID penyedia kredensial.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
CredentialProviderIdentifier	string	Pengenal bisnis penyedia kredensial.	test_example_identifier
CredentialProviderName	string	Nama penyedia kredensial.	test_example_name
CreateTime	integer	Waktu ketika penyedia kredensial dibuat. Nilainya adalah stempel waktu UNIX dalam milidetik.	1649830225000
UpdateTime	integer	Waktu ketika penyedia kredensial terakhir kali diperbarui. Nilainya adalah stempel waktu UNIX dalam milidetik.	1649830225000
Description	string	Deskripsi penyedia kredensial.	Ini adalah contoh deskripsi
CredentialProviderType	string	Tipe penyedia kredensial. Nilai valid: oauth: Penyedia kredensial OAuth jwt: Penyedia kredensial JWT	oauth
CredentialProviderCreationType	string	Tipe pembuatan penyedia kredensial. Nilai valid: system_init: Dibuat oleh sistem. user_custom: Dibuat oleh pengguna.	user_custom
Status	string	Status penyedia kredensial. Nilai valid: enabled: Diaktifkan. disabled: Dinonaktifkan.	enabled
CredentialProviderConfig	object	Konfigurasi penyedia kredensial.
ProviderCredentialIds	array	Daftar ID kredensial yang sesuai dengan konfigurasi sensitif penyedia kredensial. Catatan Sistem menyimpan konfigurasi sensitif penyedia kredensial secara aman sebagai kredensial.
	string	ID kredensial yang sesuai dengan konfigurasi sensitif.	cred_mkv7xxxxd7i4u7zqtzev2mxxxx
OAuthProviderConfig	object	Konfigurasi penyedia kredensial tipe OAuth.
ClientId	string	ID klien dalam protokol OAuth.	client_id_example_xxx
TokenEndpoint	string	Titik akhir token protokol OAuth.	https://example.com/token
Scope	string	Cakupan dalam protokol OAuth, yang menentukan cakupan izin. Catatan Cakupan yang dikonfigurasi pada penyedia kredensial berfungsi sebagai nilai default. Jika parameter scope tidak ditentukan saat memanggil DeveloperAPI untuk mendapatkan token akses OAuth, cakupan yang dikonfigurasi pada penyedia kredensial digunakan untuk penerbitan token. Penting Beberapa nilai cakupan dipisahkan oleh spasi.	example:test_01 example:test_02
AuthorizationFlow	string	Tipe alur otorisasi OAuth. Nilai valid: m2m: Mesin-ke-mesin. user_federation: Federasi pengguna.	m2m
AuthorizationEndpoint	string	Titik akhir otorisasi protokol OAuth.	https://example.com/authorize
ProviderVendor	string	Tipe vendor penyedia OAuth. Nilai valid: custom: Kustom. dingtalk: DingTalk. feishu: Lark. github: GitHub. microsoft: Microsoft. google: Google.	custom
DiscoveryUrl	string	URL dokumen penemuan OAuth.	https://example.com/.well-known/openid-configuration
SystemRedirectUri	string	URI pengalihan yang dihasilkan sistem.	https://example.com/callback
PkceEnabled	boolean	Apakah PKCE diaktifkan.	true
PkceChallengeMethod	string	Algoritma yang digunakan untuk menghitung tantangan kode dalam PKCE. Nilai valid: S256 plain	S256
Issuer	string	Titik akhir penerbit protokol OAuth.	https://example.com/issuer
JwtProviderConfig	object	Konfigurasi penyedia kredensial tipe JWT.
Issuer	string	Penerbit JWT.	https://test.issuer.com
JwksEndpoint	string	URL titik akhir JWKS.	https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks
Expiration	integer	Periode validitas JWT, dalam detik.	900
ExpirationCleanupEnabled	boolean	Apakah pembersihan kedaluwarsa JWT diaktifkan.	true
DerivedShortTokenEnabled	boolean	Apakah fitur token pendek turunan JWT diaktifkan.	false
AllowedTokenIssuers	array	Daftar penerbit JWT yang diizinkan.
	string	Penerbit JWT yang diizinkan.	https://test.issuer.com

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample.",
  "MaxResults": 20,
  "CredentialProviders": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx.",
      "CredentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx.",
      "CredentialProviderIdentifier": "test_example_identifier.",
      "CredentialProviderName": "test_example_name.",
      "CreateTime": 1649830225000,
      "UpdateTime": 1649830225000,
      "Description": "Ini adalah contoh deskripsi.",
      "CredentialProviderType": "oauth.",
      "CredentialProviderCreationType": "user_custom.",
      "Status": "enabled.",
      "CredentialProviderConfig": {
        "ProviderCredentialIds": [
          "cred_mkv7xxxxd7i4u7zqtzev2mxxxx."
        ],
        "OAuthProviderConfig": {
          "ClientId": "client_id_example_xxx",
          "TokenEndpoint": "https://example.com/token.",
          "Scope": "example:test_01 example:test_02",
          "AuthorizationFlow": "m2m\n",
          "AuthorizationEndpoint": "https://example.com/authorize\n",
          "ProviderVendor": "custom\n",
          "DiscoveryUrl": "https://example.com/.well-known/openid-configuration\n",
          "SystemRedirectUri": "https://example.com/callback\n",
          "PkceEnabled": true,
          "PkceChallengeMethod": "S256\n",
          "Issuer": "https://example.com/issuer\n"
        },
        "JwtProviderConfig": {
          "Issuer": "https://test.issuer.com.",
          "JwksEndpoint": "https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks.",
          "Expiration": 900,
          "ExpirationCleanupEnabled": true,
          "DerivedShortTokenEnabled": true,
          "AllowedTokenIssuers": [
            "https://test.issuer.com."
          ]
        }
      }
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.