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

Register an Organization

POST/api/registrations
Công khai

Mở /register để tạo một Organization cùng tài khoản đầu tiên của nó, tài khoản này là quản trị viên. REST client gọi POST /api/registrations với {"organizationName", "displayName", "email", "password", "outputLanguage"} sau khi lấy CSRF token (xem REST API); outputLanguage không bắt buộc và mặc định là tiếng Anh. Mỗi địa chỉ email chỉ thuộc về một tài khoản trên toàn bộ hệ thống triển khai, nên đăng ký lại cùng một email sẽ trả về 409 email_already_registered. Việc đăng ký cũng tạo sẵn danh mục category của Organization, bốn audience mẫu, và địa chỉ changelog công khai.

Đọc thêm: Đăng kýMã nguồn: RegistrationApiController#register(mở trong thẻ mới)

Request body​

application/json

TrườngKiểuBắt buộcGhi chú
organizationNamestringBắt buộcmax 120
displayNamestringBắt buộcmax 120
emailstringBắt buộcemail · max 254
passwordstringBắt buộc
outputLanguagestringTùy chọnmax 64

Response​

Thành công: 201

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

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
400malformed_requestkhông đọc được bodyMọ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
403access_deniedendpoint dành cho quản trị viên, hoặc CSRF token thiếu hay đã cũMọ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
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/registrations" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"organizationName": "<string>",
"displayName": "<string>",
"email": "<string>",
"password": "<string>",
"outputLanguage": "<string>"
}'

Request body là ví dụ dựng từ schema; thay mọi giá trị giữ chỗ trước khi gửi.

Response

201

Ví dụ

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