Titik akhir logout - Amazon Cognito

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Titik akhir logout

Titik /logout akhir adalah titik akhir pengalihan. Ini mengeluarkan pengguna dan mengalihkan ke sign-out URL resmi untuk klien aplikasi Anda, atau ke titik akhir. /login Parameter yang tersedia dalam GET permintaan ke /logout titik akhir disesuaikan dengan kasus penggunaan UI yang dihosting Amazon Cognito.

Untuk mengarahkan pengguna Anda ke UI yang dihosting untuk masuk lagi, tambahkan redirect_uri parameter ke permintaan Anda. logoutPermintaan dengan redirect_uri parameter juga harus menyertakan parameter untuk permintaan Anda berikutnya keTitik akhir masuk, seperticlient_id,response_type, danscope.

Endpoint logout adalah aplikasi web front-end untuk sesi pengguna interaktif dengan pelanggan Anda. Aplikasi Anda harus memanggil ini dan titik akhir UI yang dihosting lainnya di browser pengguna Anda.

Untuk mengarahkan pengguna ke halaman yang Anda pilih, tambahkan Keluar yang Diizinkan URLs ke klien aplikasi Anda. Dalam permintaan pengguna Anda ke logout titik akhir, tambahkan logout_uri dan client_id parameter. Jika nilai logout_uri adalah salah satu Keluar yang Diizinkan URLs untuk klien aplikasi Anda, Amazon Cognito mengarahkan pengguna ke sana. URL

Dengan single logout (SLO) untuk SAML 2.0 IdPs, Amazon Cognito pertama-tama mengalihkan pengguna Anda ke titik akhir yang Anda tentukan SLO dalam konfigurasi iDP Anda. Setelah iDP mengalihkan pengguna Anda kembali ke, Amazon saml2/logout Cognito merespons dengan satu pengalihan lagi ke atau dari permintaan Anda. redirect_uri logout_uri Untuk informasi selengkapnya, lihat SAMLaliran keluar.

Titik akhir logout tidak mengeluarkan pengguna OIDC atau penyedia identitas sosial ()IdPs. Untuk mengeluarkan pengguna dari sesi mereka dengan iDP eksternal, arahkan mereka ke halaman keluar untuk penyedia tersebut.

GET/logout

Titik akhir /logout hanya mendukung HTTPS GET. Klien kumpulan pengguna biasanya membuat permintaan ini melalui browser sistem. Browser biasanya Custom Chrome Tab di Android atau Safari View Control di iOS.

Permintaan parameter

client_id

ID klien aplikasi untuk aplikasi Anda. Untuk mendapatkan ID klien aplikasi, Anda harus mendaftarkan aplikasi di kumpulan pengguna. Untuk informasi selengkapnya, lihat Klien aplikasi kumpulan pengguna.

Diperlukan.

logout_uri

Arahkan pengguna Anda ke halaman keluar khusus dengan parameter logout_uri. Tetapkan nilainya ke sign-out klien aplikasi URL tempat Anda ingin mengarahkan pengguna setelah mereka keluar. Gunakan logout_uri hanya dengan parameter client_id. Untuk informasi selengkapnya, lihat Klien aplikasi kumpulan pengguna.

Anda juga dapat menggunakan parameter logout_uri untuk mengarahkan pengguna ke halaman login untuk klien aplikasi lain. Setel halaman login untuk klien aplikasi lain sebagai callback yang Diizinkan URL di klien aplikasi Anda. Dalam permintaan Anda ke /logout titik akhir, setel nilai parameter logout_uri ke halaman login -encoded. URL

Amazon Cognito memerlukan logout_uri atau parameter redirect_uri dalam permintaan Anda ke titik akhir. /logout Parameter logout_uri mengarahkan pengguna Anda ke situs web lain. Jika parameter logout_uri dan redirect_uri disertakan dalam permintaan Anda ke titik akhir, /logout Amazon Cognito akan menggunakan parameter logout_uri secara eksklusif, mengesampingkan parameter redirect_uri.

redirect_uri

Arahkan pengguna Anda ke halaman login Anda untuk mengautentikasi dengan parameter redirect_uri. Tetapkan nilainya ke callback Izinkan klien aplikasi URL tempat Anda ingin mengarahkan pengguna setelah mereka masuk lagi. Tambahkan parameter client_id, scope, state, dan response_type yang ingin Anda lewatkan ke titik akhir Anda. /login

Amazon Cognito memerlukan logout_uri atau parameter redirect_uri dalam permintaan Anda ke titik akhir. /logout Untuk mengarahkan pengguna ke /login titik akhir Anda untuk mengautentikasi ulang dan meneruskan token ke aplikasi Anda, tambahkan parameter redirect_uri. Jika parameter logout_uri dan redirect_uri disertakan dalam permintaan Anda ke titik akhir, /logout Amazon Cognito akan mengganti parameter redirect_uri dan memproses parameter logout_uri secara eksklusif.

response_type

Respons OAuth 2.0 yang ingin Anda terima dari Amazon Cognito setelah pengguna masuk. codedan token merupakan nilai yang valid untuk parameter response_type.

Diperlukan jika Anda menggunakan parameter redirect_uri.

status

Saat aplikasi Anda menambahkan parameter status ke permintaan, Amazon Cognito mengembalikan nilainya ke aplikasi Anda saat /oauth2/logout titik akhir mengalihkan pengguna Anda.

Tambahkan nilai ini ke permintaan Anda untuk mencegah CSRFserangan.

Anda tidak dapat mengatur nilai state parameter ke string URL -encodedJSON. Untuk meneruskan string yang cocok dengan format ini dalam state parameter, encode string ke base64, lalu decode dalam aplikasi Anda.

Sangat disarankan jika Anda menggunakan parameter redirect_uri.

cakupan

Cakupan OAuth 2.0 yang ingin Anda minta dari Amazon Cognito setelah Anda mengeluarkannya dengan parameter redirect_uri. Amazon Cognito mengarahkan pengguna Anda ke /login titik akhir dengan parameter cakupan dalam permintaan Anda ke titik akhir. /logout

Opsional jika Anda menggunakan parameter redirect_uri. Jika Anda tidak menyertakan parameter cakupan, Amazon Cognito mengalihkan pengguna Anda ke /login titik akhir dengan parameter cakupan. Saat Amazon Cognito mengalihkan pengguna Anda dan mengisi secara otomatisscope, parameter tersebut menyertakan semua cakupan resmi untuk klien aplikasi Anda.

Contoh permintaan

Contoh - log out dan mengarahkan pengguna ke klien

Kecuali untuk logout_uri danclient_id, semua parameter kueri yang mungkin untuk titik akhir ini diteruskan ke. Otorisasi titik akhir Amazon Cognito mengalihkan sesi pengguna ke nilailogout_uri, mengabaikan semua parameter permintaan lainnya, saat permintaan menyertakan dan. URL logout_uri client_id Ini URL harus merupakan sign-out resmi URL untuk klien aplikasi.

Berikut ini adalah contoh permintaan untuk keluar dan redirect ke. https://www.example.com/welcome

GET https://mydomain.auth.us-east-1.amazoncognito.com/logout? client_id=1example23456789& logout_uri=https%3A%2F%2Fwww.example.com%2Fwelcome

Contoh - keluar dan minta pengguna untuk masuk sebagai pengguna lain

Ketika permintaan dihilangkan logout_uri tetapi sebaliknya memberikan parameter yang membentuk permintaan yang dibentuk dengan baik ke titik akhir otorisasi, Amazon Cognito mengarahkan pengguna ke login UI yang dihosting. Titik akhir logout menambahkan parameter dalam permintaan asli Anda ke tujuan pengalihan. Parameter redirect_uri dalam permintaan ke titik akhir logout bukanlah sign-outURL, tetapi login URL yang ingin Anda lewati ke titik akhir otorisasi.

Berikut ini adalah contoh permintaan yang menandatangani pengguna keluar, mengalihkan ke halaman login, dan memberikan kode otorisasi setelah login. https://www.example.com

GET https://mydomain.auth.us-east-1.amazoncognito.com/logout? response_type=code& client_id=1example23456789& redirect_uri=https%3A%2F%2Fwww.example.com& state=example-state-value& nonce=example-nonce-value& scope=openid+profile+aws.cognito.signin.user.admin