Skip to content

Latest commit

 

History

History
193 lines (174 loc) · 5.92 KB

enterprise.md

File metadata and controls

193 lines (174 loc) · 5.92 KB
Raw

Enterprise

Get Enterprise Users

Get a list of users in the current enterprise by calling the enterprise.getUsers(options, callback) method. This method supports offset-based pagination and marker-based pagintation. To use offset-based pagination, do not pass in the usemarker parameter or set it to false. To use marker-based pagination, pass in the usemarker parameter as true. Use the fields option to specify the desired response fields, and limit (along with offset or marker) to control result set paging. Requesting information for only the fields you need can improve performance by reducing the size of the network response.

client.enterprise.getUsers({usemarker: true, marker: 'JFUirotE56hfyr56FH123'})
	.then(users => {
		/* users -> {
			total_count: 1,
			entries: 
			[ { type: 'user',
				id: '33333',
				name: 'Example User',
				login: '[email protected]',
				created_at: '2012-05-03T21:39:11-07:00',
				modified_at: '2012-08-23T14:57:48-07:00',
				language: 'en',
				space_amount: 5368709120,
				space_used: 52947,
				max_upload_size: 104857600,
				status: 'active',
				job_title: '',
				phone: '5555551374',
				address: '10 Cloud Way Los Altos CA',
				avatar_url: 'https://app.box.com/api/avatar/large/deprecated' } ] }
		*/
	});

Invite User to Enterprise

Invite a user to an enterprise by calling the enterprise.inviteUser(enterpriseID, email, callback) method with the ID of the enterprise and the user's email address.

client.enterprise.inviteUser('1345', '[email protected]', callback);

Add New User

To provision a new managed user within the current enterprise, call the enterprise.addUser(login, name, options, callback) method with the email address the user will use to log in and the user's name.

client.enterprise.addUser(
	'[email protected]',
	'Ned Stark',
	{
		role: client.enterprise.userRoles.COADMIN,
		address: '555 Box Lane',
		status: client.enterprise.userStatuses.CANNOT_DELETE_OR_EDIT
	})
	.then(user => {
		/* user -> {
			type: 'user',
			id: '44444',
			name: 'Ned Stark',
			login: '[email protected]',
			created_at: '2012-11-15T16:34:28-08:00',
			modified_at: '2012-11-15T16:34:29-08:00',
			role: 'coadmin',
			language: 'en',
			timezone: 'America/Los_Angeles',
			space_amount: 5368709120,
			space_used: 0,
			max_upload_size: 2147483648,
			status: 'active',
			job_title: '',
			phone: '',
			address: '555 Box Lane',
			avatar_url: 'https://www.box.com/api/avatar/large/deprecated' }
        */
	});

Add New App User

To provision a new app user within the current enterprise, call the enterprise.addAppUser(name, options, callback) method with the user's name.

client.enterprise.addAppUser('Daenerys Targaryen', { external_app_user_id: 'external-id' })
	.then(appUser => {
		/* appUser -> {
			type: 'user',
			id: '55555',
			name: 'Daenerys Targaryen',
			login: '[email protected]',
			created_at: '2015-04-20T20:09:59-07:00',
			modified_at: '2015-04-20T20:09:59-07:00',
			language: 'en',
			timezone: 'America/Los_Angeles',
			space_amount: 5368709120,
			space_used: 0,
			max_upload_size: 16106127360,
			status: 'active',
			job_title: '',
			phone: '',
			address: '',
			avatar_url: '' }
		*/
	});

Transfer User Content

To transfer one managed user's content to another user's account, call the enterprise.transferUserContent(sourceUserID, destUserID, callback) method with the IDs of the source and destination users.

var sourceUserID = '33333';
var destinationUserID = '44444';
client.enterprise.transferUserContent(sourceUserID, destinationUserID)
	.then(movedFolder => {
		/* movedFolder -> {
			type: 'folder',
			id: '123456789',
			sequence_id: '1',
			etag: '1',
			name: 'Other User's Files and Folders',
			created_at: '2018-04-23T11:00:07-07:00',
			modified_at: '2018-04-23T11:00:07-07:00',
			description: 'This folder contains files previously owned by Other User, and were transferred to you by your enterprise administrator. If you have any questions, please contact Enterprise Admin ([email protected]).',
			size: 0,
			path_collection: 
			{ total_count: 1,
				entries: 
				[ { type: 'folder',
					id: '0',
					sequence_id: null,
					etag: null,
					name: 'All Files' } ] },
			created_by: 
			{ type: 'user',
				id: '99999',
				name: 'Enterprise Admin',
				login: '[email protected]' },
			modified_by: 
			{ type: 'user',
				id: '99999',
				name: 'Enterprise Admin',
				login: '[email protected]' },
			trashed_at: null,
			purged_at: null,
			content_created_at: '2018-04-23T11:00:07-07:00',
			content_modified_at: '2018-04-23T11:00:07-07:00',
			owned_by: 
			{ type: 'user',
				id: '33333',
				name: 'Example User',
				login: '[email protected]' },
			shared_link: null,
			folder_upload_email: null,
			parent: 
			{ type: 'folder',
				id: '0',
				sequence_id: null,
				etag: null,
				name: 'All Files' },
			item_status: 'active' }
		*/
	});