CloudSSO:GetDirectorySAMLServiceProviderInfo-CloudSSO-Alibaba Cloud - CloudSSO

Deskripsi operasi

During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).

This topic provides an example on how to query information about the SP within the directory d-00fc2p61****.

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

cloudsso:GetDirectorySAMLServiceProviderInfo

get

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	ID direktori.	d-00fc2p61****

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4632107D-BCE1-5A96-B30B-182EE0709625
SAMLServiceProvider	object	The information about the SP.
EntityId	string	The entity ID of the SP.	https://signin-cn-shanghai.alibabacloudsso.com/saml/sp/d-00fc2p61****
DirectoryId	string	The ID of the directory.	d-00fc2p61****
EncodedMetadataDocument	string	The metadata file of the SP. The value of this parameter is Base64-encoded.	PD94bWwgdmVyc2lv****
AcsUrl	string	The Assertion Consumer Service (ACS) URL of the SP.	https://signin-cn-shanghai.alibabacloudsso.com/saml/acs/51d298a9-2a3f-4e23-97c7-7ad1cfa9****
AuthnSignAlgo	string	The signature algorithm supported by the AuthNRequest initiated by Alibaba Cloud. Value: rsa-sha256 rsa-sha1	rsa-sha256
CertificateType	string	The certificate type used by Alibaba Cloud for signing during the SSO process. Value: self-signed: Use a self-signed certificate. public: Use a certificate issued by CA.	public
SupportEncryptedAssertion	boolean	Whether to support Assertion encryption on the IdP side.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "4632107D-BCE1-5A96-B30B-182EE0709625",
  "SAMLServiceProvider": {
    "EntityId": "https://signin-cn-shanghai.alibabacloudsso.com/saml/sp/d-00fc2p61****",
    "DirectoryId": "d-00fc2p61****",
    "EncodedMetadataDocument": "PD94bWwgdmVyc2lv****",
    "AcsUrl": "https://signin-cn-shanghai.alibabacloudsso.com/saml/acs/51d298a9-2a3f-4e23-97c7-7ad1cfa9****",
    "AuthnSignAlgo": "rsa-sha256",
    "CertificateType": "public",
    "SupportEncryptedAssertion": true
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.