Reference

Endpoint Get Users

Name

get_users

Description

Get the list of users. [API reference]

Related Tables

Users

Parameters

Parameter Required Options
Name: OrderBy

Label: Order By

Order the specified column by ascending or descending order
Option Value
None
AscendingOrder SomeColumn asc
DescendingOrder SomeColumn desc
Name: SearchCriteria

Label: Search Criteria

Data filter (e.g. somecolumn -eq 'somevalue')
Option Value
None
Equal Search SomeColumn eq 'SomeValue'
Substring Search substringof(SomeField,'abc')
Starts With startswith(SomeField, 'abc')
Name: PageSize

Label: Page Size

The number of records to include in each page of results
Name: SelectedColumns

Label: Selected Columns

Select the individual columns to be included in the response, to reduce the response size and increase performance

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
BusinessPhones DT_WSTR nvarchar(4000) 4000
DisplayName DT_WSTR nvarchar(500) 500
GivenName DT_WSTR nvarchar(80) 80
JobTitle DT_WSTR nvarchar(200) 200
Mail DT_WSTR nvarchar(200) 200
MobilePhone DT_WSTR nvarchar(500) 500
OfficeLocation DT_WSTR nvarchar(500) 500
PreferredLanguage DT_WSTR nvarchar(100) 100
SurName DT_WSTR nvarchar(80) 80
UserPrincipalName DT_WSTR nvarchar(200) 200
Id DT_WSTR nvarchar(4000) 4000
If the column you are looking for is missing, consider customizing Outlook Mail (Office 365) Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Outlook Mail (Office 365) Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Users table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Outlook Mail (Office 365)
Outlook Mail Connector (Office 365) can be used to integrate Office 365 Outlook Mail API in your App / BI Tools. You can download attachment, read / search Emails, Users, MailFolders, Send email and more.
Outlook Mail (Office 365)
Users
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Users table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get users:

API Destination - Outlook Mail (Office 365)
Outlook Mail Connector (Office 365) can be used to integrate Office 365 Outlook Mail API in your App / BI Tools. You can download attachment, read / search Emails, Users, MailFolders, Send email and more.
Outlook Mail (Office 365)
Users
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get users 

select * from Users 
			--Where Id='049beb7f-03e0-4b0d-825d-73567b6786e9'

get_users endpoint belongs to Users table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get users 

DECLARE @MyQuery NVARCHAR(MAX) = 'select * from Users 
			--Where Id=''049beb7f-03e0-4b0d-825d-73567b6786e9''';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

get_users endpoint belongs to Users table(s), and can therefore be used via those table(s).