メインコンテンツへスキップ
POST
cURL
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

fields
string[]

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

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

ボディ

application/json
user
object
必須

グループに追加するユーザー。

group
object
必須

ユーザーを追加するグループ。

role
enum<string>

グループ内のユーザーのロール。

利用可能なオプション:
member,
admin
例:

"member"

configurable_permissions
object | null

管理者権限のカスタム設定 (グループが受け入れる場合)。このオプションは、ロールがmemberであるメンバーには影響しません。

これらの権限を設定すると、管理者のデフォルトのアクセスレベルが上書きされます。

このオブジェクトの値としてnullを指定すると、設定可能なすべての権限が無効になります。権限を指定すると、それに応じて権限が設定され、省略した権限はデフォルトで有効になります。

例:

レスポンス

新しいグループメンバーシップオブジェクトを返します。

メンバーシップは、ユーザーがグループに属していることを示すために使用されます。

id
string

このグループメンバーシップの一意の識別子。

例:

"11446498"

type
enum<string>

値は常にgroup_membershipになります。

利用可能なオプション:
group_membership
例:

"group_membership"

user
ユーザー (Mini) · object

メンバーシップが適用されるユーザー。

group
グループ (Mini) · object

メンバーシップが適用されるグループ。

role
enum<string>

グループ内のユーザーのロール。

利用可能なオプション:
member,
admin
例:

"member"

created_at
string<date-time>

このメンバーシップが作成された日時。

例:

"2012-12-12T10:53:43-08:00"

modified_at
string<date-time>

このメンバーシップが最後に変更された日時。

例:

"2012-12-12T10:53:43-08:00"

最終更新日 2026年1月23日