View a markdown version of this page

Titik akhir login keluar terkelola: /logout - Amazon Cognito
GET /logout

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

Titik akhir login keluar terkelola: /logout

T /logout itik akhir adalah titik akhir pengalihan. Aplikasi ini membuat pengguna keluar dan mengalihkan ke URL keluar resmi untuk klien aplikasi Anda, atau ke titik akhir/login. Parameter yang tersedia dalam permintaan GET ke titik akhir disesuaikan /logout dengan kasus penggunaan login terkelola Amazon Cognito.

Titik akhir logout adalah aplikasi web front-end untuk sesi pengguna interaktif dengan pelanggan Anda. Aplikasi Anda harus memanggil ini dan titik akhir login terkelola lainnya di browser pengguna Anda.

Untuk mengarahkan pengguna Anda ke login terkelola untuk masuk lagi, tambahkan redirect_uri parameter ke permintaan Anda. Per logout mintaan dengan redirect_uri parameter juga harus menyertakan parameter untuk permintaan Anda berikutnya keTitik akhir login, likeclient_id,response_type, danscope.

Untuk mengarahkan pengguna ke halaman yang Anda pilih, tambahkan URL keluar yang diizinkan ke klien aplikasi Anda. Dalam permintaan pengguna Anda ke titik logout akhir, tambahkan logout_uri dan client_id parameter. Jika nilainya logout_uri adalah salah satu URL keluar yang diizinkan untuk klien aplikasi Anda, Amazon Cognito mengalihkan pengguna ke URL tersebut.

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

Titik akhir logout tidak membuat pengguna keluar dari OIDC atau penyedia identitas sosial ()IdPs. Untuk keluar 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 adalah Tab Chrome Kustom di Android atau Kontrol Tampilan Safari 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 Pengaturan khusus aplikasi dengan klien aplikasi.

Diperlukan.

logout_uri

Arahkan pengguna Anda ke halaman keluar khusus dengan parameter logout _uri. Tetapkan nilainya ke URL keluar klien aplikasi tempat Anda ingin mengarahkan ulang pengguna setelah mereka keluar. Gunakan logout_uri hanya dengan parameter client_id. Untuk informasi selengkapnya, lihat Pengaturan khusus aplikasi dengan klien aplikasi.

Anda juga dapat menggunakan parameter logout_uri untuk mengarahkan pengguna ke halaman masuk untuk klien aplikasi lain. Tetapkan halaman masuk untuk klien aplikasi lain sebagai URL panggilan balik yang diizinkan di klien aplikasi Anda. Dalam permintaan Anda ke /logout titik akhir, atur nilai parameter logout_uri ke halaman masuk. URL-encoded

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

nonce

(Opsional) Nilai acak yang dapat Anda tambahkan ke permintaan. Nilai nonce yang Anda berikan disertakan dalam token ID yang dikeluarkan Amazon Cognito. Untuk mencegah serangan replay, aplikasi Anda dapat memeriksa nonce klaim di token ID dan membandingkannya dengan yang Anda buat. Untuk informasi selengkapnya tentang nonce klaim, lihat validasi token ID dalam standar OpenID Connect.

redirect_uri

Arahkan pengguna Anda ke halaman masuk Anda untuk mengotentikasi dengan parameter re direct_uri. Tetapkan nilainya ke klien aplikasi URL panggilan balik yang diizinkan tempat Anda ingin mengarahkan ulang pengguna setelah mereka masuk lagi. Tambahkan parameter client_id, scope, state, dan response_type yang ingin Anda lewati ke titik akhir Anda. /login

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

response_type

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

Diperlukan jika Anda menggunakan parameter redirect_uri.

status

Saat aplikasi 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 melindungi dari serangan CSRF.

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

Sangat disarankan jika Anda menggunakan parameter redirect_uri.

cakupan

Cakupan OAuth 2.0 yang ingin Anda minta dari Amazon Cognito setelah Anda keluar dengan parameter redirect_uri. Amazon Cognito mengalihkan pengguna Anda ke /login titik akhir dengan parameter cak upan dalam permintaan Anda ke titik akhir/logout.

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

Contoh permintaan

Contoh - log out dan mengarahkan pengguna ke klien

Amazon Cognito mengalihkan sesi pengguna ke URL dalam nilailogout_uri, mengabaikan semua parameter permintaan lainnya, ketika permintaan menyertakan logout_uri dan. client_id URL ini harus berupa URL keluar resmi untuk klien aplikasi.

Berikut ini adalah contoh permintaan untuk keluar dan pengalihan kehttps://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 menghilangkan logout_uri tetapi memberikan parameter yang membentuk permintaan yang dibentuk dengan baik ke titik akhir otorisasi, Amazon Cognito mengarahkan pengguna ke login masuk terkelola. Titik akhir logout menambahkan parameter dalam permintaan awal Anda ke tujuan pengalihan.

Parameter tambahan yang Anda tambahkan ke permintaan logout harus ada dalam daftar diPermintaan parameter. Misalnya, titik akhir logout tidak mendukung pengalihan IdP otomatis dengan parameter identity_provider atauidp_identifier. Parameter redirect_uri dalam permintaan ke titik akhir logout bukanlah URL keluar, tetapi URL pasca-masuk yang ingin Anda lewati ke titik akhir otorisasi.

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

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