グループにメンバーを追加する

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

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

---

usernameとemailの使い分け

ユーザーを招待する場合、usernameもしくはemailのいずれか１つをクエリパラメータとして与えてください。usernameを指定する場合、DeployGateユーザの中から該当するユーザ名のユーザーがメンバーに追加されます。emailを指定する場合、もし対象のメールアドレスが既にDeployGateのユーザである場合はそのユーザーを追加し、DeployGateにまだサインアップしていないユーザの場合はサインアップの案内を含む招待状メールを送付します。招待状を受け取ったユーザはサインアップ完了後、自動的に招待されたグループのメンバーになります。

Path Params

Name	Type	Required	Description
ORGANIZATION_NAME	string	true	グループ名

Body

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

Example

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

Result 200

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

Result 400

{}