プロジェクトにメンバーを追加する

POST https://deploygate.com/api/organizations/{PROJECT_NAME}/members

新しいユーザーをプロジェクトのメンバーに追加します。もし対象がDeployGateの登録ユーザで無い場合は、招待状を送付します。

---

Path Params

Name	Type	Required	Description
PROJECT_NAME	string	true	プロジェクト名

Body

Name	Type	Required	Description
username	string	false	DeployGateのユーザ名
email	string	false	DeployGateに登録しているメールアドレス、もしくは、招待状を送付する宛先アドレス

bodyに指定するパラメーター

ユーザーを招待する場合、username もしくは email のいずれか１つをクエリパラメータとして与えてください。

• usernameを指定する場合、DeployGateに登録済みのユーザーの中から該当するユーザーが追加されます。
• emailを指定する場合
  • DeployGateにユーザーとして登録されているメールアドレスの場合、該当ユーザーが追加されます。
  • DeployGateに未登録のメールアドレスの場合、指定されたメールアドレス宛に招待メールが送付されます。招待メール内の案内にしたがってサインアップをしていただき、登録が完了すると自動的に招待されたグループに追加されます。

Example

curl \
  -X POST \
  --url "https://deploygate.com/api/organizations/${PROJECT_NAME}/members" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${API_TOKEN}" \
  --form-string "email=${EMAIL}"

Result 200

{
  "error": false,
  "message": "${EMAIL} was invited to ${PROJECT_NAME}"
}

Result 400

{}