既存の外部ユーザーを会社に招待します。
すでに他の会社に所属しているユーザーや、Boxアカウントを持たないユーザーを招待することはできません。招待されたユーザーには、Boxウェブアプリケーションで招待を承認するように促すメールが届きます。
この方法を使用する場合は、対象アプリケーションに対して「Enterpriseの管理」スコープを有効にする必要があります。これは、開発者コンソールから有効にできます。
id,type,name
レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
招待するユーザー
"john@example.com"
招待されたユーザーのログイン
ユーザーの招待先となる会社
"1232234"
会社のID
curl -i -X POST "https://api.box.com/2.0/invites" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"enterprise": {
"id": "1232234"
},
"actionable_by": {
"login" : "freeuser@box.com"
}
}'
{
"id": "11446498",
"type": "invite",
"actionable_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"created_at": "2012-12-12T10:53:43-08:00",
"invited_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"invited_to": {
"id": "11446498",
"type": "enterprise",
"name": "Acme Inc."
},
"modified_at": "2012-12-12T10:53:43-08:00",
"status": "pending"
}