グループを更新 - Box Dev Docs

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

Authorizations

Authorization

string

header

required

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

Path Parameters

group_id

string

required

グループのID。

Query Parameters

fields

string[]

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

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

Body

application/json

name

string

作成する新しいグループの名前。企業内で一意である必要があります。

Example:

"Customer Support"

provenance

string

Active DirectoryやOktaなど、このグループの元になっている外部ソースを追跡します。

また、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。

これはグループを一方向にのみ同期する場合に適しています。

Maximum string length: 255

Example:

"Active Directory"

external_sync_identifier

string

このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。

このフィールドの値には、Active DirectoryオブジェクトIDやGoogleグループIDなどを使用できます。

Boxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。

Example:

"AD:123456"

description

string

グループについての人間が判読できる説明。

Maximum string length: 255

Example:

"\"Customer Support Group - as imported from Active Directory\""

invitability_level

enum<string>

フォルダでのコラボレーションにグループを招待できるユーザーを指定します。

admins_onlyに設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。

admins_and_membersに設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。

all_managed_usersに設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。

利用可能なオプション:

admins_only,

admins_and_members,

all_managed_users

Example:

"admins_only"

member_viewability_level

enum<string>

グループのメンバーを表示できるユーザーを指定します。

admins_only - 企業の管理者、共同管理者、グループのグループ管理者。
admins_and_members - すべての管理者とグループメンバー。
all_managed_users - 企業のすべての管理対象ユーザー。

利用可能なオプション:

admins_only,

admins_and_members,

all_managed_users

Example:

"admins_only"

Response

更新されたグループオブジェクトを返します。

グループは複数のユーザーを含み、グループを使用するとコラボレーションなどの一部の操作をユーザーの代わりに実行できます。任意のグループAPIエンドポイントからデフォルトで返されるグループのStandard版の表示。グループのIDや名前を含むグループのMini版の表示。グループのBase版の表示。

string

required

このオブジェクトの一意の識別子。

Example:

"11446498"

type

enum<string>

required

値は常にgroupになります。

利用可能なオプション:

group

Example:

"group"

name

string

グループの名前。

Example:

"Support"

group_type

enum<string>

グループのタイプ。

利用可能なオプション:

managed_group,

all_users_group

Example:

"managed_group"

created_at

string<date-time>

グループオブジェクトが作成された日時。

Example:

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

modified_at

string<date-time>

グループオブジェクトが最後に変更された日時。

Example:

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

provenance

string

このグループの元になっている外部ソース ("Active Directory"、"Google Groups"、"Facebook Groups"など) を追跡します。また、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。

Maximum string length: 255

Example:

"Active Directory"

external_sync_identifier

string

このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。このフィールドの値には、Active DirectoryオブジェクトIDやGoogleグループIDなどを使用できます。Boxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。

Example:

"AD:123456"

description

string

グループについての人間が判読できる説明。

Maximum string length: 255

Example:

"Support Group - as imported from Active Directory"

invitability_level

enum<string>

項目でのコラボレーションにグループを招待できるユーザーを指定します。

admins_onlyに設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。

admins_and_membersに設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。

all_managed_usersに設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。

利用可能なオプション:

admins_only,

admins_and_members,

all_managed_users

Example:

"admins_only"

member_viewability_level

enum<string>

グループのメンバーを表示できるユーザーを指定します (グループのメンバーを取得)。

admins_only - 企業の管理者、共同管理者、グループのグループ管理者。
admins_and_members - すべての管理者とグループメンバー。
all_managed_users - 企業のすべての管理対象ユーザー。

利用可能なオプション:

admins_only,

admins_and_members,

all_managed_users

Example:

"admins_only"

permissions

object

このグループに対して現在のユーザーが持っている権限について説明します。

表示子属性

permissions.can_invite_as_collaborator

boolean

ユーザーが項目でのコラボレーションにグループを招待できるかどうかを指定します。

Example:

true