Create an OIDC Provider via API untuk Mengaktifkan SSO - Resource Access Management - Alibaba Cloud - Resource Access Management

Membuat penyedia identitas OpenID Connect (OIDC) (IdP) untuk mengonfigurasi hubungan kepercayaan antara Alibaba Cloud dan IdP eksternal. Topik ini menyediakan contoh cara membuat IdP bernama TestOIDCProvider untuk mengonfigurasi hubungan kepercayaan antara IdP eksternal Okta dan Alibaba Cloud.

Deskripsi operasi

Prerequisites

Before you call this operation, make sure that the information such as the URL of the issuer, the fingerprints of HTTPS certificate authority (CA) certificates, and the client IDs are obtained from an external IdP, such as Google Workspace or Okta.

Limits

You can create a maximum of 100 OIDC IdPs in an Alibaba Cloud account.
You can add a maximum of 50 client IDs to an OIDC IdP.
You can add a maximum of five fingerprints to an OIDC IdP.

Operation description

This topic provides an example on how to create an IdP named TestOIDCProvider to configure a trust relationship between the external IdP and Alibaba Cloud.

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:CreateOIDCProvider

create

*全部资源

*

ram:OidcIssuerUrl

None

Parameter permintaan

Parameter	Type	Required	Description	Example
OIDCProviderName	string	No	Nama Penyedia Identitas OIDC. Nama dapat berisi huruf, digit, dan karakter khusus. Nama tidak boleh diawali atau diakhiri dengan karakter khusus. Karakter khusus tersebut adalah titik (.), tanda hubung (-), dan garis bawah (_). Panjang nama dapat mencapai 128 karakter.	TestOIDCProvider
IssuerUrl	string	No	URL penerbit yang disediakan oleh IdP eksternal. URL penerbit harus unik dalam satu akun Alibaba Cloud. URL penerbit harus diawali dengan https dan memiliki format URL yang valid. URL tidak boleh berisi parameter kueri yang mengikuti tanda tanya (?) atau informasi logon yang diidentifikasi oleh tanda at (@). URL tidak boleh berupa URL fragmen yang berisi tanda pagar (#). Panjang URL dapat mencapai 255 karakter.	https://xxxxxx.example.com
Description	string	No	Deskripsi Penyedia Identitas OIDC. Panjang deskripsi dapat mencapai 256 karakter.	This is an OIDC Provider.
ClientIds	string	No	ID klien yang disediakan oleh IdP eksternal. Untuk menentukan beberapa ID klien, pisahkan ID klien dengan koma (,). ID klien dapat berisi huruf, digit, dan karakter khusus. ID klien tidak boleh diawali dengan karakter khusus. Karakter khusus tersebut adalah titik (.), tanda hubung (-), garis bawah (_), titik dua (:), dan garis miring (/). Panjang ID klien dapat mencapai 128 karakter.	498469743454717****
Fingerprints	string	No	Sidik jari sertifikat CA HTTPS yang disediakan oleh IdP eksternal. Untuk menentukan beberapa sidik jari, pisahkan sidik jari dengan koma (,). Sidik jari dapat berisi huruf dan digit. Panjang sidik jari dapat mencapai 128 karakter.	902ef2deeb3c5b13ea4c3d5193629309e231****
IssuanceLimitTime	integer	No	Waktu paling awal ketika IdP eksternal dapat menerbitkan token ID. Jika nilai bidang iat dalam token ID lebih baru dari waktu saat ini, permintaan akan ditolak. Unit: jam. Nilai valid: 1 hingga 168.	6

Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Referensi API.

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	64B11B41-636D-51E3-A39B-C8703CD2218C
OIDCProvider	object	The information about the OIDC IdP.
UpdateDate	string	The time when the OIDC IdP was modified. The time is displayed in UTC.	2021-11-11T06:56:03Z
Description	string	The description of the OIDC IdP.	This is an OIDC Provider.
OIDCProviderName	string	The name of the OIDC IdP.	TestOIDCProvider
CreateDate	string	The time when the OIDC IdP was created. The time is displayed in UTC.	2021-11-11T06:56:03Z
Arn	string	The Alibaba Cloud Resource Name (ARN) of the OIDC IdP.	acs:ram::177242285274****:oidc-provider/TestOIDCProvider
IssuerUrl	string	The URL of the issuer.	https://xxxxxx.example.com
Fingerprints	string	The fingerprint of the HTTPS certificate.	902ef2deeb3c5b13ea4c3d5193629309e231****
ClientIds	string	The ID of the client.	498469743454717****
GmtCreate	string	The timestamp when the OIDC IdP was created.	1636613763000
GmtModified	string	The timestamp when the OIDC IdP was modified.	1636613763000
IssuanceLimitTime	integer	The earliest time when an external IdP can issue an ID token. If the value of the iat field in the ID token is later than the current time, the request is rejected. Unit: hours. Valid values: 1 to 168.	6

Contoh

Respons sukses

JSONformat

{
  "RequestId": "64B11B41-636D-51E3-A39B-C8703CD2218C",
  "OIDCProvider": {
    "UpdateDate": "2021-11-11T06:56:03Z",
    "Description": "This is an OIDC Provider.",
    "OIDCProviderName": "TestOIDCProvider",
    "CreateDate": "2021-11-11T06:56:03Z",
    "Arn": "acs:ram::177242285274****:oidc-provider/TestOIDCProvider",
    "IssuerUrl": "https://xxxxxx.example.com",
    "Fingerprints": "902ef2deeb3c5b13ea4c3d5193629309e231****",
    "ClientIds": "498469743454717****",
    "GmtCreate": "1636613763000",
    "GmtModified": "1636613763000",
    "IssuanceLimitTime": 6
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.