TDV Adapter for Box

Build 23.0.8839

Users

Create, update, delete, and query the available Users in Box.

Table Specific Information

Select

You can retrieve information about the current User, a User in your enterprise specified by Id, or all the Users in the enterprise.

SELECT * FROM Users

You can also retrieve the information of any User who is in your enterprise:

SELECT * FROM Users WHERE Id = '1'

If you're authenticated as an administrator with user impersonation permissions, you can query users from multiple user accounts:

SELECT * FROM Users WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

  • The authenticated user cannot be impersonated unless that user is a service account.
  • If the authenticated user is a standard user account, they can only query users associated with their account.
  • Users shared with multiple users are only returned for one of the users.

Insert

You can invite a User to your enterprise. The following query will send an invitation email to join your enterprise.

INSERT INTO Users (Login, Name, Role) VALUES ('Email@test.com', 'Username', 'coadmin')

Update

Any column where ReadOnly=False can be updated.

UPDATE Users SET Name = 'Test', Role = 'user', IsExemptFromDeviceLimits = false WHERE Id = '111'

Delete

Users can be deleted by providing an Id and issuing a DELETE statement.

DELETE FROM Users WHERE Id = '111'

Columns

Name Type ReadOnly Description
Id [KEY] String True

The Id of the user. When selecting you can set this to the value me to retrieve information for the logged-user.

Login String False

The login of the user.

Name String False

The name of the user.

EnterpriseId String False

The id of the user's enterprise. Set this to null to disassociate the user from the enterprise.

Role String False

The role of the user.

Language String False

The preferred language of the user.

IsSyncEnabled Boolean False

If the user is allowed to use Box Sync or not.

JobTitle String False

The job title of the user.

Phone String False

The phone of the user.

Address String False

The address of the user.

SpaceAmount Long False

The amount of space the user is allowed to use.

SpaceUsed Long False

The amount of space the user has used.

MaxUploadSize Long False

The maximum upload size the user is allowed to upload.

TrackingCodes String False

The tracking codes of the user, separated by commas.

CanSeeManagedUsers Boolean False

The date the content of the user was created at.

TimeZone String False

The preferred timezone of the user.

IsExemptFromDeviceLimits Boolean False

If the user is exempt from device limitations or not.

IsExemptFromLoginVerification Boolean False

If the user is exempt from login verification or not.

Status String False

The status of the user.

IsPasswordResetRequired Boolean False

If the user should be asked to change his password on the next login or not.

CreatedAt Datetime True

The date the user was created.

ModifiedAt Datetime True

The date the user was modified.

AsUserId String False

The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839