ListCredentialProviders - Identity as a Service - Alibaba Cloud Documentation Center

Mendaftar 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

*PenyediaKredensial.

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 maksimum per halaman untuk kueri berpaginasi.	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 maksimum per halaman untuk kueri berpaginasi.	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 penyedia kredensial.	test_example_identifier
CredentialProviderName	string	Nama penyedia kredensial.	test_example_name
CreateTime	integer	Pengatur waktu pembuatan penyedia kredensial. Nilai ini adalah Stempel waktu UNIX dalam milidetik.	1649830225000
UpdateTime	integer	Pengatur waktu pembaruan penyedia kredensial. Nilai ini adalah Stempel waktu UNIX dalam milidetik.	1649830225000
Description	string	Deskripsi.	This is an example description
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	List of credential IDs for the sensitive configuration of the credential provider. Catatan The system securely stores sensitive credential provider configuration as credentials.
	string	Credential ID for the sensitive configuration.	cred_mkv7xxxxd7i4u7zqtzev2mxxxx
OAuthProviderConfig	object	Configuration for OAuth credential providers.
ClientId	string	The client_id in the OAuth protocol, also known as the client ID.	client_id_example_xxx
TokenEndpoint	string	The Token endpoint of the OAuth protocol.	https://example.com/token
Scope	string	The scope in the OAuth protocol, which defines permission scope. Catatan The Scope configuration for the OAuth credential provider acts as a fallback. If you do not specify the scope parameter when calling the DeveloperAPI to get an OAuth Access Token, the credential provider's Scope configuration is used for issuance. Penting Multiple Scope values are separated by spaces.	example:test_01 example:test_02
JwtProviderConfig	object	Configuration for JWT credential providers.
Issuer	string	JWT issuer.	https://test.issuer.com
JwksEndpoint	string	JWKs endpoint address.	https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks
Expiration	integer	Validity period of the JWT, in seconds.	900
ExpirationCleanupEnabled	boolean	Enable JWT expiration cleanup.	true
DerivedShortTokenEnabled	boolean	Enable JWT derived short token capability.	false
AllowedTokenIssuers	array	List of allowed JWT issuers.
	string	Allowed JWT issuer.	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": "This is an example description",
      "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"
        },
        "JwtProviderConfig": {
          "Issuer": "https://test.issuer.com",
          "JwksEndpoint": "https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks",
          "Expiration": 900,
          "ExpirationCleanupEnabled": true,
          "DerivedShortTokenEnabled": false,
          "AllowedTokenIssuers": [
            "https://test.issuer.com"
          ]
        }
      }
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.