ユーザー招待を作成

post

https://api.box.com/2.0

/invites

既存の外部ユーザーを会社に招待します。

すでに他の会社に所属しているユーザーや、Boxアカウントを持たないユーザーを招待することはできません。招待されたユーザーには、Boxウェブアプリケーションで招待を承認するように促すメールが届きます。

この方法を使用する場合は、対象アプリケーションに対して「Enterpriseの管理」スコープを有効にする必要があります。これは、開発者コンソールから有効にできます。

リクエスト

Content-Typeapplication/json

クエリパラメータ

fieldsstring arrayクエリ内省略可能

例id,type,name

応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

リクエスト本文

actionable_by object本文内

招待するユーザー

enterprise object本文内

ユーザーの招待先となる会社

enterprise.id stringnull省略可能

例1232234

会社のID

レスポンス

200application/jsonInvite

新しい招待オブジェクトを返します。

defaultapplication/jsonクライアントエラー

予期しないクライアントエラー。

post

ユーザー招待を作成

このドキュメント内で一部のAPIを試せるようになりました。

リクエストの例

curl -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" 
       }
     }'

BoxUser user = new BoxUser(api, "0");
user.invite("Enterprise ID", "Invited User Login");

enterprise = client.get_current_enterprise()
invitation = enterprise.invite_user('user@example.com')

client.enterprise.inviteUser('1345', 'jsmith@box.com', callback);

client.users.inviteToJoinEnterprise(
    login: "user@example.com",
    enterpriseId: "12345"
) { (result: Result<Invite, BoxSDKError>) in
    guard case let .success(invite) = result else {
        print("Error inviting user to enterprise")
        return
    }

    print("Invited user \(invite.actionableBy.name) to \(invite.invitedTo.name)")
}