{ "opencollection": "1.0.0", "info": { "name": "Box Authorize Authorization Users API", "version": "1.0" }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Box List enterprise users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users", "params": [ { "name": "filter_term", "value": "john", "type": "query", "description": "Limits the results to only users who's `name` or\n`login` start with the search term.\n\nFor externally managed users, the search term needs\nto completely match the in order to find the user, and\nit will only return one user at a time." }, { "name": "user_type", "value": "managed", "type": "query", "description": "Limits the results to the kind of user specified.\n\n* `all` returns every kind of user for whom the\n `login` or `name` partially matches the\n `filter_term`. It will only return an external user\n if the login matches the `filter_term` completely,\n and in that case it will only return that user.\n* `managed` returns all managed and app users for whom\n the `login` or `name` partially matches the\n `filter_term`.\n* `external` returns all external users for whom the\n `login` matches the `filter_term` exactly." }, { "name": "external_app_user_id", "value": "my-user-1234", "type": "query", "description": "Limits the results to app users with the given\n`external_app_user_id` value.\n\nWhen creating an app user, an\n`external_app_user_id` value can be set. This value can\nthen be used in this endpoint to find any users that\nmatch that `external_app_user_id` value." }, { "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." }, { "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." }, { "name": "limit", "value": "1000", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "usemarker", "value": "true", "type": "query", "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response." }, { "name": "marker", "value": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "type": "query", "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`." } ] }, "docs": "Returns a list of all users for the Enterprise along with their `user_id`,\n`public_name`, and `login`.\n\nThe application and the authenticated user need to\nhave the permission to look up users in the entire\nenterprise." }, { "info": { "name": "Box Create user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users", "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 new managed user in an enterprise. This endpoint\nis only available to users and applications with the right\nadmin permissions." }, { "info": { "name": "Box Get current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/me", "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." } ] }, "docs": "Retrieves information about the user who is currently authenticated.\n\nIn the case of a client-side authenticated OAuth 2.0 application\nthis will be the user who authorized the app.\n\nIn the case of a JWT, server-side authenticated application\nthis will be the service account that belongs to the application\nby default.\n\nUse the `As-User` header to change who this API call is made on behalf of." }, { "info": { "name": "Box Get user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_id", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." }, { "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 information about a user in the enterprise.\n\nThe application and the authenticated user need to\nhave the permission to look up users in the entire\nenterprise.\n\nThis endpoint also returns a limited set of information\nfor external users who are collaborated on content\nowned by the enterprise for authenticated users with the\nright scopes. In this case, disallowed fields will return\nnull instead." }, { "info": { "name": "Box Update user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/:user_id", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." }, { "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 managed or app user in an enterprise. This endpoint\nis only available to users and applications with the right\nadmin permissions." }, { "info": { "name": "Box Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_id", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." }, { "name": "notify", "value": "true", "type": "query", "description": "Whether the user will receive email notification of\nthe deletion" }, { "name": "force", "value": "true", "type": "query", "description": "Whether the user should be deleted even if this user\nstill own files" } ] }, "docs": "Deletes a user. By default this will fail if the user\nstill owns any content. Move their owned content first\nbefore proceeding, or use the `force` field to delete\nthe user and their files." }, { "info": { "name": "Box Transfer owned folders", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/:user_id/folders/0", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." }, { "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." }, { "name": "notify", "value": "true", "type": "query", "description": "Determines if users should receive email notification\nfor the action performed." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move all of the items (files, folders and workflows) owned by a user into\nanother user's account\n\nOnly the root folder (`0`) can be transferred.\n\nFolders can only be moved across users by users with administrative\npermissions.\n\nAll existing shared links and folder-level collaborations are transferred\nduring the operation. Please note that while collaborations at the individual\nfile-level are transferred during the operation, the collaborations are\ndeleted when the original user is deleted.\n\nThis" }, { "info": { "name": "Box Create jobs to terminate users session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/terminate_sessions", "body": { "type": "json", "data": "{}" } }, "docs": "Validates the roles and permissions of the user,\nand creates asynchronous jobs\nto terminate the user's sessions.\nReturns the status for the POST request." }, { "info": { "name": "Box Get user avatar", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_id/avatar", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." } ] }, "docs": "Retrieves an image of a the user's avatar." }, { "info": { "name": "Box Add or update user avatar", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_id/avatar", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." } ], "body": { "type": "multipart-form", "data": [ { "name": "pic", "type": "text", "value": "" } ] } }, "docs": "Adds or updates a user avatar." }, { "info": { "name": "Box Delete user avatar", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_id/avatar", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." } ] }, "docs": "Removes an existing user avatar.\nYou cannot reverse this operation." }, { "info": { "name": "Box List user's email aliases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_id/email_aliases", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." } ] }, "docs": "Retrieves all email aliases for a user. The collection\ndoes not include the primary login for the user." }, { "info": { "name": "Box Create email alias", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_id/email_aliases", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new email alias to a user account.." }, { "info": { "name": "Box Remove email alias", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_id/email_aliases/:email_alias_id", "params": [ { "name": "user_id", "value": "12345", "type": "path", "description": "The ID of the user." }, { "name": "email_alias_id", "value": "23432", "type": "path", "description": "The ID of the email alias." } ] }, "docs": "Removes an email alias from a user." }, { "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." } ] } ], "bundled": true }