> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update user
> Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.
This endpoint is in the version **2024.0**. No changes are required to continue using it. For more details, see **[Box API versioning](/guides/api-calls/api-versioning-strategy)**.
Learn more about [Box SDK versioning strategy](/guides/tooling/sdks/sdk-versioning/).
## OpenAPI
````yaml /box-openapi.json PUT /users/{user_id}
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box Platform](https://developer.box.com) provides functionality to provide
access to content stored within [Box](https://box.com). It provides
endpoints for basic manipulation of files and folders, management of users
within an enterprise, as well as more complex topics such as legal holds and
retention policies.
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 95117b97f9
servers:
- url: https://api.box.com/2.0
description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: AI
description: A set of endpoints used to interact with supported LLMs.
x-box-tag: ai
- name: AI Studio
description: A set of endpoints used to interact with AI Studio.
x-box-tag: ai_studio
- name: App item associations
x-box-tag: app_item_associations
- name: Authorization
description: A set of endpoints used to manage user authorization process.
x-box-tag: authorization
x-box-priority: true
- name: Box Sign requests
description: Box Sign requests are used to submit a file for signature.
x-box-tag: sign_requests
- name: Classifications
description: >-
Classification labels are used for content that is sensitive or under
security restrictions.
x-box-tag: classifications
- name: Classifications on files
description: >-
Classification labels are used for files that are sensitive or under
security restrictions.
x-box-tag: file_classifications
- name: Classifications on folders
description: >-
Classification labels are used for folders that are sensitive or under
security restrictions.
x-box-tag: folder_classifications
- name: Collaborations
description: >-
Collaborations define access permissions for users and groups to files and
folders, similar to access control lists.
x-box-tag: user_collaborations
- name: Collaborations (List)
description: >-
A set of endpoints used to retrieve file, folder, pending, and group
collaborations.
x-box-tag: list_collaborations
- name: Collections
description: >-
Collections are a way to group files, folders, and web links without
putting them all into a folder.
x-box-tag: collections
- name: Comments
description: >-
Comments are messages generated users on files, allowing users to
collaborate on a file, discussing any feedback they might have on the
content.
x-box-tag: comments
- name: Device pinners
description: >-
Device pinners allow enterprises to control what devices can use native
Box applications.
x-box-tag: device_pinners
- name: Domain restrictions (User exemptions)
description: >-
A set of endpoints that allow exempting users from restrictions imposed by
the list of allowed collaboration domains for a specific enterprise.
x-box-tag: collaboration_allowlist_exempt_targets
- name: Domain restrictions for collaborations
description: >-
A set of endpoints that manage domains for which users can collaborate
with files and folders in an enterprise.
x-box-tag: collaboration_allowlist_entries
- name: Downloads
description: >-
Downloads allow saving files to the application's server, or directly by
the end user in a browser.
x-box-tag: downloads
- name: Email aliases
description: >-
Email aliases provide a list of emails additional to the user's primary
login email.
x-box-tag: email_aliases
- name: Events
description: >-
Events provide a way for an application to subscribe to any actions
performed by any user, users, or service in an enterprise.
x-box-tag: events
- name: File requests
description: >-
File Requests provide a fast and secure way to request files and
associated metadata from anyone. Users can create new file requests based
on an existing file request, update file request settings, activate,
deactivate, and delete file requests programmatically.
x-box-tag: file_requests
- name: File version legal holds
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated. A File Version Legal Hold represents all the
policies that are assigned to a specific file version.
x-box-tag: file_version_legal_holds
- name: File version retentions
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. A file version retention is a record for a retained file.
x-box-tag: file_version_retentions
- name: File versions
description: A set of endpoints used to manage specific versions of a file.
x-box-tag: file_versions
- name: Files
description: >-
Files, together with Folders, are at the core of the Box API. Files can be
uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: files
- name: Folder Locks
description: >-
Folder locks define access restrictions placed by folder owners to prevent
specific folders from being moved or deleted.
x-box-tag: folder_locks
- name: Folders
description: >-
Folders, together with Files, are at the core of the Box API. Folders can
be uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: folders
- name: Integration mappings
description: >-
Integration Mappings allow the users to manage where content from partner
apps is stored in Box.
x-box-tag: integration_mappings
- name: Group memberships
description: Group memberships signify that a user is a part of the group.
x-box-tag: memberships
- name: Groups
description: Groups created in an enterprise.
x-box-tag: groups
- name: Invites
description: Invites are used to invite the user to an enterprise.
x-box-tag: invites
- name: Legal hold policies
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated.
x-box-tag: legal_hold_policies
- name: Legal hold policy assignments
description: >-
A Legal Hold Policy Assignment is a relation between a policy and
custodian. In this case, as custodian can be a user, folder, file, or file
version.
x-box-tag: legal_hold_policy_assignments
- name: Metadata cascade policies
description: >-
A metadata cascade policy describes how metadata instances applied to a
folder should be applied to any item within that folder.
x-box-tag: metadata_cascade_policies
- name: Metadata instances (Files)
description: >-
A metadata instance describes the relation between a template and a file,
including the values that are assigned for every field.
x-box-tag: file_metadata
- name: Metadata instances (Folders)
description: >-
A metadata instance describes the relation between a template and a
folder, including the values that are assigned for every field.
x-box-tag: folder_metadata
- name: Metadata taxonomies
description: >-
A metadata taxonomy is a hierarchical classification system that helps
organize and manage metadata within an enterprise.
x-box-tag: metadata_taxonomies
- name: Metadata templates
description: >-
A metadata template describes a reusable set of key/value pairs that can
be assigned to a file.
x-box-tag: metadata_templates
- name: Recent items
description: >-
Recent items represent items such as files or folders that the user
accessed recently.
x-box-tag: recent_items
- name: Retention policies
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. Admins can create retention policies and then assign them
to specific folders or their entire enterprise.
x-box-tag: retention_policies
- name: Retention policy assignments
description: >-
A Retention Policy Assignment is a relation between a policy and folder or
enterprise. Creating an assignment puts a retention on all the file
versions that belong to that folder or enterprise.
x-box-tag: retention_policy_assignments
- name: Search
description: >-
The Box API provides a way to find content in Box using full-text search
queries.
x-box-tag: search
- name: Session termination
description: >-
Session termination API is used to validate the roles and permissions of
the group, and creates asynchronous jobs to terminate the group's
sessions.
x-box-tag: session_termination
- name: Shared links (Files)
description: >-
Files shared links are URLs that are generated for files stored in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_files
- name: Shared links (Folders)
description: >-
Folders shared links are URLs that are generated for folders stored in
Box, which provide direct, read-only access to the resource.
x-box-tag: shared_links_folders
- name: Shared links (Web Links)
description: >-
Web links for files are URLs that are generated for web links in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_web_links
- name: Shared links (App Items)
description: >-
URLs generated for app items stored in Box, which provide direct,
read-only access to the resource.
x-box-tag: shared_links_app_items
- name: Shield information barriers
description: >-
Shield information barrier in Box defines an ethical wall. An ethical wall
is a mechanism that prevents exchanges or communication that could lead to
conflicts of interest and therefore result in business activities
ethically or legally questionable.
x-box-tag: shield_information_barriers
- name: Shield information barrier segments
description: >-
Shield information barrier segment represents a defined group of users. A
user can be a member of only one segment, which makes segments different
from groups.
x-box-tag: shield_information_barrier_segments
- name: Shield information barrier segment members
description: >-
Shield information barrier segment member represents a user that is
assigned to a specific segment.
x-box-tag: shield_information_barrier_segment_members
- name: Shield information barrier reports
description: >-
Shield information barrier reports contain information on what existing
collaborations will be removed permanently when the information barrier is
enabled.
x-box-tag: shield_information_barrier_reports
- name: Shield information barrier segment restrictions
description: >-
Shield information barrier segment restriction is an access restriction
based on the content (file or folder) owner.
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Sign templates
description: >-
Sign templates allow you to use a predefined Box Sign template when
creating a signature request. The template includes placeholders that are
automatically populated with data when creating the request.
x-box-tag: sign_templates
- name: Skills
description: >-
Box Skills are designed to allow custom processing of files uploaded to
Box, with the intent of enhancing the underlying metadata of the file.
x-box-tag: skills
- name: Standard and Zones Storage Policies
description: >-
Storage policy assignment represents the storage zone for items in a given
enterprise.
x-box-tag: storage_policies
- name: Standard and Zones Storage Policy Assignments
description: >-
Storage policy assignment represents the relation between storage zone and
the assigned item (for example a file stored in a specific zone).
x-box-tag: storage_policy_assignments
- name: Task assignments
description: >-
A task assignment defines which task is assigned to which user to
complete.
x-box-tag: task_assignments
- name: Tasks
description: >-
Tasks allow users to request collaborators on a file to review a file or
complete a piece of work. Tasks can be used by developers to create
file-centric workflows.
x-box-tag: tasks
- name: Terms of service
description: A set of endpoints used to manage terms of service agreements.
x-box-tag: terms_of_services
- name: Terms of service user statuses
description: >-
A set of endpoints used to manage the status of terms of service for a
particular user.
x-box-tag: terms_of_service_user_statuses
- name: Transfer folders
description: >-
API designed to move all of the items (files, folders and workflows) owned
by a user into another user's account.
x-box-tag: transfer
- name: Trashed files
description: Files that were deleted and are in trash.
x-box-tag: trashed_files
- name: Trashed folders
description: Folders that were deleted and are in trash.
x-box-tag: trashed_folders
- name: Trashed items
description: Items that were deleted and are in trash.
x-box-tag: trashed_items
- name: Trashed web links
description: Web links that were deleted and are in trash.
x-box-tag: trashed_web_links
- name: Uploads
description: >-
The direct file upload API supports files up to 50MB in size and sends all
the binary data to the Box API in 1 API request.
x-box-tag: uploads
- name: Uploads (Chunked)
description: >-
The chunked upload endpoints support files from 20MB in size and allow an
application to upload the file in parts, allowing for more control to
catch any errors and retry parts individually.
x-box-tag: chunked_uploads
- name: User avatars
description: >-
User avatars are JPG or PNG files uploaded to Box to represent the user
image. They are then displayed in the user account.
x-box-tag: avatars
- name: Users
description: >-
Box API supports a variety of users, ranging from real employees logging
in with their Managed User account, to applications using App Users to
drive powerful automation workflows.
x-box-tag: users
- name: Watermarks (Files)
description: >-
A watermark is a semi-transparent overlay on an embedded file preview that
displays a viewer's email address or user ID and the time of access over
the file.
x-box-tag: file_watermarks
- name: Watermarks (Folders)
description: >-
A watermark is a semi-transparent overlay on an embedded folder preview
that displays a viewer's email address or user ID and the time of access
over the folder content.
x-box-tag: folder_watermarks
- name: Web links
description: >-
Web links are objects that point to URLs. These objects are also known as
bookmarks within the Box web application.
x-box-tag: web_links
- name: Webhooks
description: >-
Webhooks allow you to monitor Box content for events, and receive
notifications to a URL of your choice when they occur. For example, a
workflow may include waiting for a file to be downloaded to delete a
shared link.
x-box-tag: webhooks
- name: Workflows
description: >-
Box Relay Workflows are objects that represent a named collection of
flows.
x-box-tag: workflows
- name: Zip Downloads
description: >-
Zip downloads represent a successful request to create a ZIP archive with
files and folders.
x-box-tag: zip_downloads
externalDocs:
description: Box Developer Documentation.
url: https://developer.box.com
paths:
/users/{user_id}:
put:
tags:
- Users
summary: Update user
description: >-
Updates a managed or app user in an enterprise. This endpoint is only
available to users and applications with the right admin permissions.
operationId: put_users_id
parameters:
- name: user_id
in: path
description: The ID of the user.
required: true
schema:
type: string
example: '12345'
- name: fields
in: query
description: >-
A comma-separated list of attributes to include in the response.
This can be used to request fields that are not normally returned in
a standard response.
Be aware that specifying this parameter will have the effect that
none of the standard fields are returned in the response unless
explicitly specified, instead only fields for the mini
representation are returned, additional to the fields requested.
required: false
schema:
type: array
items:
type: string
example:
- id
- type
- name
explode: false
requestBody:
content:
application/json:
schema:
type: object
properties:
enterprise:
description: >-
Set this to `null` to roll the user out of the enterprise
and make them a free user.
type: string
example: null
nullable: true
notify:
description: >-
Whether the user should receive an email when they are
rolled out of an enterprise.
type: boolean
example: true
name:
description: The name of the user.
type: string
example: Aaron Levie
maxLength: 50
login:
description: >-
The email address the user uses to log in
Note: If the target user's email is not confirmed, then the
primary login address cannot be changed.
type: string
example: somename@box.com
role:
description: The user’s enterprise role.
type: string
example: user
enum:
- coadmin
- user
language:
description: >-
The language of the user, formatted in modified version of
the [ISO 639-1](/guides/api-calls/language-codes) format.
type: string
example: en
is_sync_enabled:
description: Whether the user can use Box Sync.
type: boolean
example: true
job_title:
description: The user’s job title.
type: string
example: CEO
maxLength: 100
phone:
description: The user’s phone number.
type: string
example: '6509241374'
maxLength: 100
address:
description: The user’s address.
type: string
example: 900 Jefferson Ave, Redwood City, CA 94063
maxLength: 255
tracking_codes:
description: >-
Tracking codes allow an admin to generate reports from the
admin console and assign an attribute to a specific group of
users. This setting must be enabled for an enterprise before
it can be used.
type: array
items:
$ref: '#/components/schemas/TrackingCode'
can_see_managed_users:
description: >-
Whether the user can see other enterprise users in their
contact list.
type: boolean
example: true
timezone:
description: The user's timezone.
type: string
format: timezone
example: Africa/Bujumbura
is_external_collab_restricted:
description: >-
Whether the user is allowed to collaborate with users
outside their enterprise.
type: boolean
example: true
is_exempt_from_device_limits:
description: Whether to exempt the user from enterprise device limits.
type: boolean
example: true
is_exempt_from_login_verification:
description: Whether the user must use two-factor authentication.
type: boolean
example: true
is_password_reset_required:
description: Whether the user is required to reset their password.
type: boolean
example: true
status:
description: The user's account status.
type: string
example: active
enum:
- active
- inactive
- cannot_delete_edit
- cannot_delete_edit_upload
space_amount:
description: >-
The user’s total available space in bytes. Set this to `-1`
to indicate unlimited storage.
type: integer
format: int64
example: 11345156112
notification_email:
description: >-
An alternate notification email address to which email
notifications are sent. When it's confirmed, this will be
the email address to which notifications are sent instead of
to the primary email address.
Set this value to `null` to remove the notification email.
type: object
nullable: true
properties:
email:
description: The email address to send the notifications to.
type: string
example: notifications@example.com
external_app_user_id:
description: >-
An external identifier for an app user, which can be used to
look up the user. This can be used to tie user IDs from
external identity providers to Box users.
Note: In order to update this field, you need to request a
token using the application that created the app user.
type: string
example: my-user-1234
responses:
'200':
description: Returns the updated user object.
content:
application/json:
schema:
$ref: '#/components/schemas/User--Full'
'400':
description: >-
Returns an error if some of the parameters are missing or not valid.
- `invalid_parameter` when a parameter is formatted incorrectly, for
example when the `notification_email` has an incorrectly formatted
email address.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'403':
description: >-
Returns an error if the user is not allowed to make the changes.
- `access_denied_insufficient_permissions` when the user does not
have the right permissions, for example when updating the
notification email is turned off for the enterprise.
- `denied_by_policy` when the user does not have the right
permissions due to the information barrier restrictions.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
default:
description: An unexpected client error.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: Update user
source: |-
curl -i -X PUT "https://api.box.com/2.0/users/12345" \
-H "authorization: Bearer " \
-H "content-type: application/json" \
-d '{
"name": "Aaron Levie"
}'
- lang: dotnet
label: Update user
source: >-
await client.Users.UpdateUserByIdAsync(userId: user.Id, requestBody:
new UpdateUserByIdRequestBody() { Name = updatedUserName });
- lang: swift
label: Update user
source: >-
try await client.users.updateUserById(userId: user.id, requestBody:
UpdateUserByIdRequestBody(name: updatedUserName))
- lang: java
label: Update user
source: >-
client.getUsers().updateUserById(user.getId(), new
UpdateUserByIdRequestBody.Builder().name(updatedUserName).build())
- lang: node
label: Update user
source: |-
await client.users.updateUserById(user.id, {
requestBody: { name: updatedUserName } satisfies UpdateUserByIdRequestBody,
} satisfies UpdateUserByIdOptionalsInput);
- lang: python
label: Update user
source: client.users.update_user_by_id(user.id, name=updated_user_name)
components:
schemas:
TrackingCode:
description: >-
Tracking codes allow an admin to generate reports from the admin console
and assign an attribute to a specific group of users. This setting must
be enabled for an enterprise before it can be used.
type: object
properties:
type:
description: The value will always be `tracking_code`.
type: string
example: tracking_code
enum:
- tracking_code
name:
description: >-
The name of the tracking code, which must be preconfigured in the
Admin Console.
type: string
example: department
value:
description: The value of the tracking code.
type: string
example: Sales
title: Tracking code
User--Full:
description: >-
A full representation of a user, as can be returned from any user API
endpoint.
type: object
allOf:
- $ref: '#/components/schemas/User'
- properties:
role:
description: The user’s enterprise role.
type: string
example: admin
enum:
- admin
- coadmin
- user
tracking_codes:
description: >-
Tracking codes allow an admin to generate reports from the admin
console and assign an attribute to a specific group of users.
This setting must be enabled for an enterprise before it can be
used.
type: array
items:
$ref: '#/components/schemas/TrackingCode'
can_see_managed_users:
description: >-
Whether the user can see other enterprise users in their contact
list.
type: boolean
example: true
is_sync_enabled:
description: Whether the user can use Box Sync.
type: boolean
example: true
is_external_collab_restricted:
description: >-
Whether the user is allowed to collaborate with users outside
their enterprise.
type: boolean
example: true
is_exempt_from_device_limits:
description: Whether to exempt the user from Enterprise device limits.
type: boolean
example: true
is_exempt_from_login_verification:
description: Whether the user must use two-factor authentication.
type: boolean
example: true
enterprise:
allOf:
- title: Enterprise
type: object
description: A representation of a Box enterprise.
properties:
id:
description: The unique identifier for this enterprise.
type: string
example: '11446498'
type:
description: The value will always be `enterprise`.
type: string
example: enterprise
enum:
- enterprise
name:
description: The name of the enterprise.
type: string
example: Acme Inc.
- description: Representation of the user’s enterprise.
my_tags:
description: >-
Tags for all files and folders owned by the user. Values
returned will only contain tags that were set by the requester.
type: array
items:
type: string
example:
- important
hostname:
description: >-
The root (protocol, subdomain, domain) of any links that need to
be generated for the user.
type: string
example: https://example.app.box.com/
is_platform_access_only:
description: Whether the user is an App User.
type: boolean
example: true
external_app_user_id:
description: >-
An external identifier for an app user, which can be used to
look up the user. This can be used to tie user IDs from external
identity providers to Box users.
type: string
example: my-user-1234
title: User (Full)
x-box-resource-id: user--full
x-box-tag: users
x-box-variant: full
ClientError:
description: A generic error.
type: object
properties:
type:
description: The value will always be `error`.
type: string
example: error
enum:
- error
nullable: false
status:
description: The HTTP status of the response.
type: integer
format: int32
example: 400
nullable: false
code:
description: A Box-specific error code.
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: A short message describing the error.
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
A free-form object that contains additional context about the error.
The possible fields are defined on a per-endpoint basis. `message`
is only one example.
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: A URL that links to more information about why this error occurred.
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: >-
A unique identifier for this response, which can be used when
contacting Box support.
type: string
example: abcdef123456
nullable: false
title: Client error
x-box-resource-id: client_error
User:
description: >-
A standard representation of a user, as returned from any user API
endpoints by default.
type: object
allOf:
- $ref: '#/components/schemas/User--Mini'
- properties:
created_at:
description: When the user object was created.
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
modified_at:
description: When the user object was last modified.
type: string
format: date-time
example: '2012-12-12T10:53:43-08:00'
language:
description: >-
The language of the user, formatted in modified version of the
[ISO 639-1](/guides/api-calls/language-codes) format.
type: string
example: en
timezone:
description: The user's timezone.
type: string
format: timezone
example: Africa/Bujumbura
space_amount:
description: The user’s total available space amount in bytes.
type: integer
format: int64
example: 11345156112
space_used:
description: The amount of space in use by the user.
type: integer
format: int64
example: 1237009912
max_upload_size:
description: The maximum individual file size in bytes the user can have.
type: integer
format: int64
example: 2147483648
status:
description: The user's account status.
type: string
example: active
enum:
- active
- inactive
- cannot_delete_edit
- cannot_delete_edit_upload
job_title:
description: The user’s job title.
type: string
example: CEO
maxLength: 100
phone:
description: The user’s phone number.
type: string
example: '6509241374'
maxLength: 100
address:
description: The user’s address.
type: string
example: 900 Jefferson Ave, Redwood City, CA 94063
maxLength: 255
avatar_url:
description: URL of the user’s avatar image.
type: string
example: https://www.box.com/api/avatar/large/181216415
notification_email:
description: >-
An alternate notification email address to which email
notifications are sent. When it's confirmed, this will be the
email address to which notifications are sent instead of to the
primary email address.
type: object
nullable: true
properties:
email:
description: The email address to send the notifications to.
type: string
example: notifications@example.com
is_confirmed:
description: Specifies if this email address has been confirmed.
type: boolean
example: true
title: User
x-box-resource-id: user
x-box-tag: users
x-box-variant: standard
User--Mini:
description: >-
A mini representation of a user, as can be returned when nested within
other resources.
type: object
allOf:
- $ref: '#/components/schemas/User--Base'
- properties:
name:
description: The display name of this user.
type: string
example: Aaron Levie
maxLength: 50
nullable: false
login:
description: The primary email address of this user.
type: string
format: email
example: ceo@example.com
nullable: false
title: User (Mini)
x-box-resource-id: user--mini
x-box-tag: users
x-box-variant: mini
User--Base:
description: >-
A mini representation of a user, used when nested within another
resource.
type: object
properties:
id:
description: The unique identifier for this user.
type: string
example: '11446498'
type:
description: The value will always be `user`.
type: string
example: user
enum:
- user
nullable: false
required:
- type
- id
title: User (Base)
x-box-resource-id: user--base
x-box-tag: users
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
securitySchemes:
OAuth2Security:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Read all files and folders stored in Box
root_readwrite: Read and write all files and folders stored in Box
manage_app_users: Provision and manage app users
manage_managed_users: Provision and manage managed users
manage_groups: Manage an enterprise's groups
manage_webhook: Create webhooks programmatically through the API
manage_enterprise_properties: Manage enterprise properties
manage_data_retention: Manage data retention polices
manage_legal_hold: Manage Legal Holds
````