ObtainCredential - Identity as a Service - Alibaba Cloud Documentation Center

Mengambil teks biasa (plaintext) dari sebuah secret.

Deskripsi operasi

API ini menggunakan access token dari IDaaS untuk autentikasi dan otorisasi.

Access token tersebut harus memiliki izin untuk memperoleh static credential pada aplikasi privileged access management (PAM) bawaan di IDaaS.

Catatan

Scope yang diperlukan adalah urn:cloud:idaas:pam|credential:obtain.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

GET /v2/{instanceId}/credentials/_/actions/obtain HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID dari instance IDaaS.	idaas_ue2jvisn35ea5lmthk267xxxxx

Parameter permintaan

Parameter	Type	Required	Description	Example
Authorization	string	Yes	Informasi autentikasi. Formatnya adalah `Bearer ${access_token}`. Catatan Gunakan access token yang diterbitkan oleh IDaaS.	Bearer xxxxxx
credentialIdentifier	string	Yes	Identifier untuk credential yang akan diperoleh.	credential_identifier_test

Elemen respons

Element	Type	Description	Example
	object	Detail dari credential.
instanceId	string	ID instance EIAM.	idaas_ue2jvisn35ea5lmthk267xxxxx
credentialId	string	ID credential.	cred_mkv7rgt4d7i4u7zqtzev2mxxxx
status	string	Status dari credential. Nilai yang valid: `enabled`: Credential dapat digunakan. `disabled`: Credential tidak dapat digunakan.	enabled
credentialIdentifier	string	Identifier credential.	credential_identifier_test
credentialName	string	Nama credential.	credential_name
credentialSubjectType	string	Tipe subject dari credential. Nilai yang valid: `authentication_token_provider`: Penyedia authentication token.	authentication_token_provider
credentialSubjectId	string	ID dari subject credential.	apt_werthgfdsasffxxxxx
credentialScenarioLabel	string	Skenario penggunaan untuk credential. Nilai yang valid: `llm`: Untuk digunakan dengan large language model. `saas`: Untuk digunakan dengan aplikasi SaaS pihak ketiga.	llm
credentialType	string	Tipe credential. Nilai yang valid: `api_key`: Credential berupa API key. `oauth_client`: Credential merepresentasikan OAuth client.	api_key
credentialCreationType	string	Menunjukkan bagaimana credential dibuat. Nilai yang valid: `system_init`: Diinisialisasi oleh sistem. `user_custom`: Dibuat oleh pengguna.	user_custom
description	string	Deskripsi credential.	credential_description
createTime	integer	Waktu pembuatan credential, dalam format Unix timestamp dalam milidetik.	1649830225000
updateTime	integer	Waktu pembaruan terakhir credential, dalam format Unix timestamp dalam milidetik.	1649830227000
credentialContent	object	Konten detail dari credential. Struktur object ini bergantung pada nilai `credentialType`.
oauthClientContent	object	Berisi detail untuk credential OAuth client. Hanya dikembalikan ketika `credentialType` adalah `oauth_client`.
clientId	string	The client ID.	dmvncmxersdxxxxxx
clientSecret	string	The client secret.	nsklnertyt5ddwizncxxxx
apiKeyContent	object	Berisi detail untuk credential API key. Hanya dikembalikan ketika `credentialType` adalah `api_key`.
apiKey	string	The API key.	sk-nsklncmwizncxxxx
credentialSharingScope	string	Cakupan berbagi (sharing scope) dari credential, seperti apakah eksklusif untuk akun tertentu.	user_exclusive
exclusiveUserId	string	ID akun yang secara eksklusif memiliki credential ini. Field ini hanya ada ketika `credentialSharingScope` adalah `user_exclusive`.	user_xxx
credentialExternalId	string

Contoh

Respons sukses

JSONformat

{
  "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
  "credentialId": "cred_mkv7rgt4d7i4u7zqtzev2mxxxx",
  "status": "enabled",
  "credentialIdentifier": "credential_identifier_test",
  "credentialName": "credential_name",
  "credentialSubjectType": "authentication_token_provider",
  "credentialSubjectId": "apt_werthgfdsasffxxxxx",
  "credentialScenarioLabel": "llm",
  "credentialType": "api_key",
  "credentialCreationType": "user_custom",
  "description": "credential_description",
  "createTime": 1649830225000,
  "updateTime": 1649830227000,
  "credentialContent": {
    "oauthClientContent": {
      "clientId": "dmvncmxersdxxxxxx",
      "clientSecret": "nsklnertyt5ddwizncxxxx"
    },
    "apiKeyContent": {
      "apiKey": "sk-nsklncmwizncxxxx\n"
    }
  },
  "credentialSharingScope": "user_exclusive",
  "exclusiveUserId": "user_xxx",
  "credentialExternalId": ""
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.