Invite a member
POST
/api/invitationsQuản trị viên
Request body
application/json
| Trường | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
email | string | Bắt buộc | email · max 254 |
Response
Thành công: 201
| Trường | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
id | string (uuid) | Tùy chọn | |
email | string | Tùy chọn | |
acceptancePath | string | Tùy chọn | |
expiresAt | string (date-time) | Tùy chọn |
Lỗi
| Trạng thái | Mã | Áp dụng cho |
|---|---|---|
400 | validation_failedthiếu trường hoặc giá trị nằm ngoài khoảng cho phép | Mọi endpoint |
400 | malformed_requestkhông đọc được body | Mọi endpoint |
400 | invalid_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 UUID | Mọi endpoint |
401 | authentication_requiredchưa có phiên đăng nhập | Mọi endpoint |
403 | access_deniedendpoint dành cho quản trị viên, hoặc CSRF token thiếu hay đã cũ | Mọi endpoint |
404 | not_foundkhông có địa chỉ đó | Mọi endpoint |
405 | method_not_allowedđịa chỉ không nhận phương thức đó | Mọi endpoint |
415 | unsupported_media_typeđịa chỉ không đọc body thuộc kiểu đó | Mọi endpoint |
500 | internal_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 |
400 | output_language_invalid | Khu vực Account |
400 | ui_locale_invalid | Khu vực Account |
400 | invitation_invalid | Khu vực Account |
400 | organization_slug_invalid | Khu vực Account |
404 | invitation_not_found | Khu vực Account |
404 | member_not_found | Khu vực Account |
409 | email_already_registered | Khu vực Account |
409 | invitation_already_pending | Khu vực Account |
409 | invitation_email_unavailable | Khu vực Account |
409 | organization_slug_taken | Khu vực Account |
409 | member_last_administrator | Khu vực Account |
Request
bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/invitations" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"email": "<string>"
}'
Request body là ví dụ dựng từ schema; thay mọi giá trị giữ chỗ trước khi gửi.
Response
201Ví dụ
{
"id": "<uuid>",
"email": "<string>",
"acceptancePath": "<string>",
"expiresAt": "<date-time>"
}