Chuyển tới nội dung chính

Get the session

GET/api/session
Thành viên đã đăng nhậpChỉ đọc

1. Gọi GET /api/csrf và giữ cookie phiên đăng nhập mà nó đặt. Nó trả về {"headerName": "X-CSRF-TOKEN", "parameterName": "_csrf", "token"}. 2. Gửi token trong header đó kèm mọi POST, PUT và DELETE, ví dụ POST /api/registrations. 3. Đăng nhập qua POST /login với các trường biểu mẫu email, password và token. Nó trả về một redirect, không bao giờ là JSON: tới / khi thành công, và tới /login?error khi thất bại. 4. Lấy token mới. Đăng nhập thay phiên đăng nhập và token của nó, nên token ở bước 1 giờ bị từ chối với 403 access_denied. 5. Đọc danh tính đang đăng nhập từ GET /api/session.

Đọc thêm: Phiên đăng nhập và CSRFMã nguồn: SessionApiController#current(mở trong thẻ mới)

Response​

Thành công: 200

TrườngKiểuBắt buộcGhi chú
userIdstring (uuid)Tùy chọn
organizationIdstring (uuid)Tùy chọn
emailstringTùy chọn
displayNamestringTùy chọn
roleenum AppUserRoleTùy chọnADMINMEMBER

Lỗi​

Trạng tháiMãÁp dụng cho
400validation_failedthiếu trường hoặc giá trị nằm ngoài khoảng cho phépMọi endpoint
400invalid_parametermột tham số trên đường dẫn hoặc query bị thiếu hoặc không chuyển đổi được, chẳng hạn một ID không phải UUIDMọi endpoint
401authentication_requiredchưa có phiên đăng nhậpMọi endpoint
404not_foundkhông có địa chỉ đóMọi endpoint
405method_not_allowedđịa chỉ không nhận phương thức đóMọi endpoint
415unsupported_media_typeđịa chỉ không đọc body thuộc kiểu đóMọi endpoint
500internal_errormột lỗi ReleaseFlow không lường trước; body không bao giờ chứa exception gây ra nóMọi endpoint
400output_language_invalidKhu vực Account
400ui_locale_invalidKhu vực Account
400invitation_invalidKhu vực Account
400organization_slug_invalidKhu vực Account
404invitation_not_foundKhu vực Account
404member_not_foundKhu vực Account
409email_already_registeredKhu vực Account
409invitation_already_pendingKhu vực Account
409invitation_email_unavailableKhu vực Account
409organization_slug_takenKhu vực Account
409member_last_administratorKhu vực Account

Request

bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
curl "http://localhost:8080/api/session" \
-b cookies.txt -c cookies.txt

Response

200

Ví dụ

{
  "userId": "<uuid>",
  "organizationId": "<uuid>",
  "email": "<string>",
  "displayName": "<string>",
  "role": "ADMIN"
}