{ "opencollection": "1.0.0", "info": { "name": "Box Authorize Authorization Group Memberships API", "version": "1.0" }, "items": [ { "info": { "name": "Group Memberships", "type": "folder" }, "items": [ { "info": { "name": "Box List user's groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_id/memberships", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." }, { "name": "limit", "value": "1000", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "offset", "value": "1000", "type": "query", "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response." } ] }, "docs": "Retrieves all the groups for a user. Only members of this\ngroup or users with admin-level permissions will be able to\nuse this API." }, { "info": { "name": "Box List members of group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/groups/:group_id/memberships", "params": [ { "name": "group_id", "value": "57645", "type": "path", "description": "The ID of the group." }, { "name": "limit", "value": "1000", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "offset", "value": "1000", "type": "query", "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response." } ] }, "docs": "Retrieves all the members for a group. Only members of this\ngroup or users with admin-level permissions will be able to\nuse this API." }, { "info": { "name": "Box Add user to group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/group_memberships", "params": [ { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a group membership. Only users with\nadmin-level permissions will be able to use this API." }, { "info": { "name": "Box Get group membership", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/group_memberships/:group_membership_id", "params": [ { "name": "group_membership_id", "value": "434534", "type": "path", "description": "The ID of the group membership." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ] }, "docs": "Retrieves a specific group membership. Only admins of this\ngroup or users with admin-level permissions will be able to\nuse this API." }, { "info": { "name": "Box Update group membership", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/group_memberships/:group_membership_id", "params": [ { "name": "group_membership_id", "value": "434534", "type": "path", "description": "The ID of the group membership." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user's group membership. Only admins of this\ngroup or users with admin-level permissions will be able to\nuse this API." }, { "info": { "name": "Box Remove user from group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/group_memberships/:group_membership_id", "params": [ { "name": "group_membership_id", "value": "434534", "type": "path", "description": "The ID of the group membership." } ] }, "docs": "Deletes a specific group membership. Only admins of this\ngroup or users with admin-level permissions will be able to\nuse this API." } ] } ], "bundled": true }