招待

• 招待の一覧
• 招待の作成
• 招待の取り消し

招待の一覧

GET /api/v0/invitations

APIキーに必要な権限

• Read

応答

成功時

{
  "invitations": [<invitation>, <invitation>, ...]
}

<invitation> は以下のキーを持つオブジェクトです。

KEY	TYPE	DESCRIPTION
email	string	招待を送ったメールアドレス。
authority	string	招待から加入した時の権限(manager,collaborator,viewer)
expiresAt	number	招待の有効期限 (epoch秒)

招待の作成

メールアドレスと権限を指定してユーザーをオーガニゼーションに招待します。

POST /api/v0/invitations

APIキーに必要な権限

• Read
• Write

入力

KEY	TYPE	DESCRIPTION
email	string	招待を送るメールアドレス
authority	string	招待から加入したときの権限 (manager,collaborator,viewer)

入力例

{
  "email": "example@example.com",
  "authority": "viewer"
}

応答

成功時

入力にexpiresAt(epoch秒)が付与されて返却されます。招待はexpiresAtの時刻以降は使えなくなります。

{
  "email": "example@example.com",
  "authority": "viewer",
  "expiresAt": 1492393387
}

失敗時

STATUS CODE	DESCRIPTION
400	JSON のフォーマットが不正であるとき、既に招待しているメールアドレスやメンバーのメールアドレスが指定されたとき
403	APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

招待の取り消し

メールアドレスを指定してオーガニゼーションへの招待を取り消します。

POST /api/v0/invitations/revoke

APIキーに必要な権限

• Read
• Write

入力

KEY	TYPE	DESCRIPTION
email	string	招待を取り消すメールアドレス

入力例

{
  "email": "example@example.com"
}

応答

成功時

{
  "success": true
}

失敗時

STATUS CODE	DESCRIPTION
400	JSON のフォーマットが不正であるとき
403	APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合
404	指定したemailの招待がなかった時