Box Terms of Service User Statuses API

openapi: 3.2.0
info:
  title: Box Platform Terms of service user statuses API
  description: Box Platform provides functionality to provide access to content stored within Box. 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: 53bdced3cd
servers:
- url: https://api.box.com/2.0
  description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- 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
paths:
  /terms_of_service_user_statuses:
    get:
      operationId: get_terms_of_service_user_statuses
      summary: List terms of service user statuses
      description: Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when.
      parameters:
      - name: tos_id
        in: query
        description: The ID of the terms of service.
        required: true
        schema:
          type: string
        example: '324234'
      - name: user_id
        in: query
        description: Limits results to the given user ID.
        required: false
        schema:
          type: string
        example: '123334'
      responses:
        '200':
          description: Returns a list of terms of service statuses.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsOfServiceUserStatuses'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: terms_of_service_user_statuses
      tags:
      - Terms of service user statuses
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: List terms of service user statuses
        source: "curl -i -X GET \"https://api.box.com/2.0/terms_of_service_user_statuses?tos_id=324234\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: List terms of service user statuses
        source: 'await client.TermsOfServiceUserStatuses.GetTermsOfServiceUserStatusesAsync(queryParams: new GetTermsOfServiceUserStatusesQueryParams(tosId: tos.Id) { UserId = user.Id });'
      - lang: swift
        label: List terms of service user statuses
        source: 'try await client.termsOfServiceUserStatuses.getTermsOfServiceUserStatuses(queryParams: GetTermsOfServiceUserStatusesQueryParams(tosId: tos.id, userId: user.id))'
      - lang: java
        label: List terms of service user statuses
        source: client.getTermsOfServiceUserStatuses().getTermsOfServiceUserStatuses(new GetTermsOfServiceUserStatusesQueryParams.Builder(tos.getId()).userId(user.getId()).build())
      - lang: node
        label: List terms of service user statuses
        source: "await client.termsOfServiceUserStatuses.getTermsOfServiceUserStatuses({\n  tosId: tos.id,\n  userId: user.id,\n} satisfies GetTermsOfServiceUserStatusesQueryParams);"
      - lang: python
        label: List terms of service user statuses
        source: "client.terms_of_service_user_statuses.get_terms_of_service_user_statuses(\n    tos.id, user_id=user.id\n)"
    post:
      operationId: post_terms_of_service_user_statuses
      summary: Create terms of service status for new user
      description: Sets the status for a terms of service for a user.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tos:
                  description: The terms of service to set the status for.
                  type: object
                  properties:
                    type:
                      description: The type of object.
                      type: string
                      example: terms_of_service
                      enum:
                      - terms_of_service
                    id:
                      description: The ID of terms of service.
                      type: string
                      example: '1232132'
                  required:
                  - id
                  - type
                user:
                  description: The user to set the status for.
                  type: object
                  properties:
                    type:
                      description: The type of object.
                      type: string
                      example: user
                      enum:
                      - user
                    id:
                      description: The ID of user.
                      type: string
                      example: '3423423'
                  required:
                  - id
                  - type
                is_accepted:
                  description: Whether the user has accepted the terms.
                  type: boolean
                  example: true
              required:
              - tos
              - user
              - is_accepted
      responses:
        '201':
          description: Returns a terms of service status object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsOfServiceUserStatus'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: terms_of_service_user_statuses
      tags:
      - Terms of service user statuses
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Create terms of service status for new user
        source: "curl -i -X POST \"https://api.box.com/2.0/terms_of_service_user_statuses\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"tos\": {\n         \"type\": \"terms_of_service\",\n         \"id\": \"1232132\"\n       },\n       \"user\": {\n         \"type\": \"user\",\n         \"id\": \"3423423\"\n       },\n       \"is_accepted\": true\n     }'"
      - lang: dotnet
        label: Create terms of service status for new user
        source: 'await client.TermsOfServiceUserStatuses.CreateTermsOfServiceStatusForUserAsync(requestBody: new CreateTermsOfServiceStatusForUserRequestBody(tos: new CreateTermsOfServiceStatusForUserRequestBodyTosField(id: tos.Id), user: new CreateTermsOfServiceStatusForUserRequestBodyUserField(id: user.Id), isAccepted: false));'
      - lang: swift
        label: Create terms of service status for new user
        source: 'try await client.termsOfServiceUserStatuses.createTermsOfServiceStatusForUser(requestBody: CreateTermsOfServiceStatusForUserRequestBody(tos: CreateTermsOfServiceStatusForUserRequestBodyTosField(id: tos.id), user: CreateTermsOfServiceStatusForUserRequestBodyUserField(id: user.id), isAccepted: false))'
      - lang: java
        label: Create terms of service status for new user
        source: client.getTermsOfServiceUserStatuses().createTermsOfServiceStatusForUser(new CreateTermsOfServiceStatusForUserRequestBody(new CreateTermsOfServiceStatusForUserRequestBodyTosField(tos.getId()), new CreateTermsOfServiceStatusForUserRequestBodyUserField(user.getId()), false))
      - lang: node
        label: Create terms of service status for new user
        source: "await client.termsOfServiceUserStatuses.createTermsOfServiceStatusForUser({\n  tos: new CreateTermsOfServiceStatusForUserRequestBodyTosField({ id: tos.id }),\n  user: new CreateTermsOfServiceStatusForUserRequestBodyUserField({\n    id: user.id,\n  }),\n  isAccepted: false,\n} satisfies CreateTermsOfServiceStatusForUserRequestBody);"
      - lang: python
        label: Create terms of service status for new user
        source: "client.terms_of_service_user_statuses.create_terms_of_service_status_for_user(\n    CreateTermsOfServiceStatusForUserTos(id=tos.id),\n    CreateTermsOfServiceStatusForUserUser(id=user.id),\n    False,\n)"
  /terms_of_service_user_statuses/{terms_of_service_user_status_id}:
    put:
      operationId: put_terms_of_service_user_statuses_id
      summary: Update terms of service status for existing user
      description: Updates the status for a terms of service for a user.
      parameters:
      - name: terms_of_service_user_status_id
        in: path
        description: The ID of the terms of service status.
        required: true
        schema:
          type: string
        example: '324234'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                is_accepted:
                  description: Whether the user has accepted the terms.
                  type: boolean
                  example: true
              required:
              - is_accepted
      responses:
        '200':
          description: Returns the updated terms of service status object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsOfServiceUserStatus'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: terms_of_service_user_statuses
      tags:
      - Terms of service user statuses
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Update terms of service status for existing user
        source: "curl -i -X PUT \"https://api.box.com/2.0/terms_of_service_user_statuses/324234\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"is_accepted\": true\n     }'"
      - lang: dotnet
        label: Update terms of service status for existing user
        source: 'await client.TermsOfServiceUserStatuses.UpdateTermsOfServiceStatusForUserByIdAsync(termsOfServiceUserStatusId: createdTosUserStatus.Id, requestBody: new UpdateTermsOfServiceStatusForUserByIdRequestBody(isAccepted: true));'
      - lang: swift
        label: Update terms of service status for existing user
        source: 'try await client.termsOfServiceUserStatuses.updateTermsOfServiceStatusForUserById(termsOfServiceUserStatusId: createdTosUserStatus.id, requestBody: UpdateTermsOfServiceStatusForUserByIdRequestBody(isAccepted: true))'
      - lang: java
        label: Update terms of service status for existing user
        source: client.getTermsOfServiceUserStatuses().updateTermsOfServiceStatusForUserById(createdTosUserStatus.getId(), new UpdateTermsOfServiceStatusForUserByIdRequestBody(true))
      - lang: node
        label: Update terms of service status for existing user
        source: "await client.termsOfServiceUserStatuses.updateTermsOfServiceStatusForUserById(\n  createdTosUserStatus.id,\n  {\n    isAccepted: true,\n  } satisfies UpdateTermsOfServiceStatusForUserByIdRequestBody,\n);"
      - lang: python
        label: Update terms of service status for existing user
        source: "client.terms_of_service_user_statuses.update_terms_of_service_status_for_user_by_id(\n    created_tos_user_status.id, True\n)"
components:
  schemas:
    TermsOfServiceUserStatuses:
      description: A list of terms of service user statuses.
      type: object
      properties:
        total_count:
          description: The total number of objects.
          type: integer
          format: int64
          example: 2
        entries:
          description: A list of terms of service user statuses.
          type: array
          items:
            $ref: '#/components/schemas/TermsOfServiceUserStatus'
      title: Terms of service user statuses
      x-box-resource-id: terms_of_services_user_statuses
      x-box-tag: terms_of_service_user_statuses
    ClientError:
      description: A generic error.
      type: object
      properties:
        type:
          description: The value will always be `error`.
          type: string
          example: error
          enum:
          - error
        status:
          description: The HTTP status of the response.
          type: integer
          format: int32
          example: 400
        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
          - unprocessable_entity
          - 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
        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
          - 'null'
          example:
            message: Something went wrong
          additionalProperties: {}
        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/
        request_id:
          description: A unique identifier for this response, which can be used when contacting Box support.
          type: string
          example: abcdef123456
      title: Client error
      x-box-resource-id: client_error
    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
          login:
            description: The primary email address of this user.
            type: string
            format: email
            example: ceo@example.com
      title: User (Mini)
      x-box-resource-id: user--mini
      x-box-tag: users
      x-box-variant: mini
    TermsOfService--Base:
      description: The root-level record that is supposed to represent a single Terms of Service.
      type: object
      properties:
        id:
          description: The unique identifier for this terms of service.
          type: string
          example: '11446498'
        type:
          description: The value will always be `terms_of_service`.
          type: string
          example: terms_of_service
          enum:
          - terms_of_service
      required:
      - id
      - type
      title: Terms of service (Base)
      x-box-resource-id: terms_of_service--base
      x-box-tag: terms_of_services
      x-box-variant: base
      x-box-variants:
      - base
      - standard
    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
      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
    TermsOfServiceUserStatus:
      description: The association between a Terms of Service and a user.
      type: object
      properties:
        id:
          description: The unique identifier for this terms of service user status.
          type: string
          example: '11446498'
        type:
          description: The value will always be `terms_of_service_user_status`.
          type: string
          example: terms_of_service_user_status
          enum:
          - terms_of_service_user_status
        tos:
          allOf:
          - $ref: '#/components/schemas/TermsOfService--Base'
          - description: The terms of service.
        user:
          allOf:
          - $ref: '#/components/schemas/User--Mini'
          - description: The user.
        is_accepted:
          description: If the user has accepted the terms of services.
          type: boolean
          example: true
        created_at:
          description: When the legal item was created.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
        modified_at:
          description: When the legal item was modified.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
      required:
      - id
      - type
      title: Terms of service user status
      x-box-resource-id: terms_of_service_user_status
      x-box-tag: terms_of_service_user_statuses
  securitySchemes:
    OAuth2Security:
      type: oauth2
      description: The access token received from the authorization server in the OAuth 2.0 flow.
      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
externalDocs:
  description: Box Developer Documentation.
  url: https://developer.box.com
x-mint:
  mcp:
    enabled: true
x-provenance:
  method: harvested
  publisher: Box
  source: https://developer.box.com/box-openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)