Titik akhir UserInfo

Titik userInfo akhir adalah titik akhir UserInfo OpenID Connect (OIDC). Ini merespons dengan atribut pengguna ketika penyedia layanan menyajikan token akses yang Anda Titik akhir token keluarkan. Cakupan dalam token akses pengguna Anda menentukan atribut pengguna yang ditampilkan oleh titik akhir UserInfo dalam responsnya. Ruang openid lingkup harus menjadi salah satu klaim token akses.

Amazon Cognito mengeluarkan token akses sebagai respons terhadap permintaan API kumpulan pengguna seperti. InitiateAuth Karena tidak mengandung cakupan apa pun, userInfo titik akhir tidak menerima token akses ini. Sebagai gantinya, Anda harus menunjukkan token akses dari titik akhir token Anda.

Penyedia identitas pihak ketiga (iDP) OAuth 2.0 Anda juga menghosting titik akhir. userInfo Saat pengguna Anda mengautentikasi dengan IDP tersebut, Amazon Cognito secara diam-diam menukar kode otorisasi dengan endpoint iDP. token Kumpulan pengguna Anda meneruskan token akses iDP untuk mengotorisasi pengambilan informasi pengguna dari titik akhir iDP. userInfo

GET /oauth2/userInfo

Aplikasi Anda membuat permintaan ke titik akhir ini secara langsung dan bukan melalui browser.

Untuk informasi selengkapnya, lihat UserInfoEndpoint dalam spesifikasi OpenID Connect (OIDC).

Minta parameter di header

Authorization: Bearer <access_token>

Lulus token akses di bidang header otorisasi.

Wajib.

Contoh - permintaan

GET /oauth2/userInfo HTTP/1.1
Content-Type: application/x-amz-json-1.1
Authorization: Bearer eyJra12345EXAMPLE
User-Agent: [User agent]
Accept: */*
Host: auth.example.com
Accept-Encoding: gzip, deflate, br
Connection: keep-alive

Contoh — respon positif

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: [Integer]
Date: [Timestamp]
x-amz-cognito-request-id: [UUID]
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Server: Server
Connection: keep-alive
{
    "sub": "[UUID]",
    "email_verified": "true",
    "custom:mycustom1": "CustomValue",
    "phone_number_verified": "true",
    "phone_number": "[phone]",
    "email": "[e-mail]",
    "username": "bob"
}

Untuk daftar klaim OIDC, lihat Klaim Standar. Saat ini, Amazon Cognito mengembalikan nilai untuk email_verified dan phone_number_verified sebagai string.

Contoh tanggapan negatif

Contoh - permintaan buruk

HTTP/1.1 400 Bad Request
WWW-Authenticate: error="invalid_request",
error_description="Bad OAuth2 request at UserInfo Endpoint"

invalid_request

Permintaan tidak memiliki parameter yang diperlukan, termasuk nilai parameter yang tidak didukung, atau jika tidak, salah bentuk.

Contoh — token buruk

HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="Access token is expired, disabled, or deleted, or the user has globally signed out."

invalid_token

Token akses kedaluwarsa, dicabut, cacat, atau tidak valid.