グループメンバーシップを取得

get

https://api.box.com/2.0

/group_memberships/:group_membership_id

特定のグループメンバーシップを取得します。

リクエスト

Content-Typeapplication/json

パスパラメータ

group_membership_id stringパス内必須

例434534

グループメンバーシップのID。

クエリパラメータ

fieldsstring arrayクエリ内省略可能

例id,type,name

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

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

レスポンス

200application/jsonグループメンバーシップ

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

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

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

get

グループメンバーシップを取得

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

ログイン

リクエストの例

cURL

curl -X GET https://api.box.com/2.0/group_memberships/434534 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

Java

BoxGroupMembership membership = new BoxGroupMembership(api, id);
BoxGroupMembership.Info groupMembershipInfo = membership.getInfo();

Python

membership_id = '11111'
membership = client.group_membership(membership_id).get()
print('User "{0}" is a member of the {1} group'.format(membership.user.name, membership.group.name))

Node

client.groups.getMembership('33333')
	.then(membership => {
		/* membership -> {
			type: 'group_membership',
			id: '33333',
			user: 
			{ type: 'user',
				id: '22222',
				name: 'Alison Wonderland',
				login: 'alice@example.com' },
			group: { type: 'group', id: '11111', name: 'Employees' },
			role: 'member',
			configurable_permissions: 
			{ can_run_reports: false,
				can_instant_login: false,
				can_create_accounts: false,
				can_edit_accounts: false },
			created_at: '2013-05-16T15:27:57-07:00',
			modified_at: '2013-05-16T15:27:57-07:00' }
		*/
	});

iOS

client.groups.getMembershipInfo(membershipId: "12345") { 
(result: Result<GroupMembership, BoxSDKError>) in
    guard case let .success(membership) = result else {
        print("Error retrieving group membership information")
        return
    }

    print("Group Membership for group \(membership.group?.name) was retrieved")
}