Gunakan SetUserSsoSettings untuk mengonfigurasi SSO berbasis pengguna - Resource Access Management - Alibaba Cloud - Resource Access Management

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

ram:SetUserSsoSettings

update

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
MetadataDocument	string	No	File metadata yang dienkode Base64. File ini disediakan oleh penyedia identitas (IdP) yang mendukung Security Assertion Markup Language (SAML) 2.0.	PD94bWwgdmVy****
SsoEnabled	boolean	No	Apakah akan mengaktifkan SSO untuk Pengguna RAM. Nilai valid: true false (default).	true
AuxiliaryDomain	string	No	Nama domain tambahan.	example.com
SsoLoginWithDomain	boolean	No	Apakah SAML SSO memerlukan nama domain di elemen `<saml:NameID>` pada tanggapan SAML. Jika ya, nama pengguna yang ditentukan oleh IdP untuk SSO harus memiliki nama domain sebagai sufiks. Jika nilai parameter adalah `true`, elemen `<saml:NameID>` harus dalam format `username@domain`. Anda dapat mengatur `domain` ke nama domain default atau alias domain yang dikonfigurasi. Jika nilai parameter adalah `false`, elemen `<saml:NameID>` harus dalam format `username` dan tidak boleh mengandung sufiks `domain`. Nilai default adalah `true`.	true
AuthnSignAlgo	string	No	Algoritma tanda tangan yang didukung. Nilai valid: rsa-sha256 rsa-sha1 (default).	rsa-sha1

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
UserSsoSettings	object	The configurations of user-based SSO.
AuxiliaryDomain	string	The auxiliary domain name.	example.com
MetadataDocument	string	The metadata file, which is Base64-encoded.	PD94bWwgdmVy****
SsoEnabled	boolean	Indicates whether user-based SSO is enabled.	true
SsoLoginWithDomain	boolean	Indicates whether the SAML SSO requires a domain name in the `<saml:NameID>` element of the SAML response. If yes, the username specified by the IdP for SSO must have a domain name as the suffix. If the value of the parameter is `true`, the `<saml:NameID>` element must be in the `username@domain` format. You can set `domain` to the default domain name or the configured domain alias. If the value of the parameter is `false`, the `<saml:NameID>` element must be in the `username` format and cannot contain the `domain` suffix. The default value is `true`.	true
AuthnSignAlgo	string	The supported signature algorithm. Valid values: rsa-sha256 rsa-sha1 (default)	rsa-sha1
RequestId	string	The request ID.	87F2E3F6-28A0-43F3-A77F-F7760E62F61E

Contoh

Respons sukses

JSONformat

{
  "UserSsoSettings": {
    "AuxiliaryDomain": "example.com",
    "MetadataDocument": "PD94bWwgdmVy****",
    "SsoEnabled": true,
    "SsoLoginWithDomain": true,
    "AuthnSignAlgo": "rsa-sha1"
  },
  "RequestId": "87F2E3F6-28A0-43F3-A77F-F7760E62F61E"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.