ObtainCredential - Identity as a Service - Alibaba Cloud Documentation Center

Mengambil informasi kredensial dan teks biasa kredensial tersebut.

Deskripsi operasi

API ini menggunakan Access Token yang dikeluarkan oleh IDaaS untuk otentikasi identitas dan otorisasi.

Pastikan Access Token yang Anda berikan memiliki izin "Obtain Static Credential" untuk aplikasi PAM bawaan IDaaS (Privileged Access Management).

Catatan

Cakupan yang sesuai 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 instans EIAM.	idaas_ue2jvisn35ea5lmthk267xxxxx

Parameter permintaan

Parameter	Type	Required	Description	Example
Authorization	string	Yes	Informasi otentikasi. Format: Bearer ${access_token}. Catatan Masukkan Access Token yang dikeluarkan oleh IDaaS.	Bearer xxxxxx
credentialIdentifier	string	Yes	Identifikasi kredensial.	credential_identifier_test

Elemen respons

Element	Type	Description	Example
	object
instanceId	string	ID instans EIAM.	idaas_ue2jvisn35ea5lmthk267xxxxx
credentialId	string	ID kredensial.	cred_mkv7rgt4d7i4u7zqtzev2mxxxx
status	string	Status kredensial. Nilai yang valid: enabled: Diaktifkan. disabled: Dinonaktifkan.	enabled
credentialIdentifier	string	Identifikasi kredensial.	credential_identifier_test
credentialName	string	Nama kredensial.	credential_name
credentialSubjectType	string	Jenis subjek tempat kredensial tersebut terdaftar. Nilai yang valid: authentication_token_provider: Penyedia token otentikasi.	authentication_token_provider
credentialSubjectId	string	ID subjek tempat kredensial tersebut terdaftar.	apt_werthgfdsasffxxxxx
credentialScenarioLabel	string	Label skenario kredensial. Nilai yang valid: llm: Model bahasa besar. saas: Layanan SaaS pihak ketiga.	llm
credentialType	string	Jenis kredensial. Nilai yang valid: api_key: Kredensial otentikasi Kunci API. oauth_client: Kredensial otentikasi client OAuth.	api_key
credentialCreationType	string	Jenis pembuatan kredensial. Nilai yang valid: system_init: Dibuat oleh sistem. user_custom: Dibuat oleh pengguna.	user_custom
description	string	Deskripsi kredensial.	credential_description
createTime	integer	Waktu pembuatan, dalam format Stempel waktu UNIX. Satuan: milidetik.	1649830225000
updateTime	integer	Waktu pembaruan, dalam format Stempel waktu UNIX. Satuan: milidetik.	1649830227000
credentialContent	object	Konten kredensial.
oauthClientContent	object	Konten kredensial untuk jenis kredensial otentikasi client OAuth.
clientId	string	`client_id` untuk OAuth 2.0.	dmvncmxersdxxxxxx
clientSecret	string	`client_secret` untuk OAuth 2.0.	nsklnertyt5ddwizncxxxx
apiKeyContent	object	Konten kredensial untuk jenis kredensial Kunci API.
apiKey	string	Nilai Kunci API.	sk-nsklncmwizncxxxx
credentialSharingScope	string	Cakupan berbagi kredensial.	user_exclusive
exclusiveUserId	string	ID akun eksklusif kredensial.	user_xxx
credentialExternalId	string	Identifikasi unik eksternal kredensial.	23528e9957304f57b98112c72788b5xxxxx

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": "23528e9957304f57b98112c72788b5xxxxx"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.