Outlook Mail (Office 365) Connector
Documentation
Version: 3
Documentation
Endpoint

Get Users


Name

get_users

Description

Get the list of users. [API reference]

Related Tables

Users

Parameters

Parameter Label Required Options Description
OrderBy Order By NO
Option Value
None
AscendingOrder SomeColumn asc
DescendingOrder SomeColumn desc
Order the specified column by ascending or descending order [API reference]
SearchCriteria Search Criteria NO
Option Value
None
Equal Search SomeColumn eq 'SomeValue'
Substring Search substringof(SomeField,'abc')
Starts With startswith(SomeField, 'abc')
Data filter (e.g. somecolumn -eq 'somevalue') [API reference]
PageSize Page Size NO The number of records to include in each page of results [API reference]
SelectedColumns Selected Columns NO Select the individual columns to be included in the response, to reduce the response size and increase performance [API reference]

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
BusinessPhones DT_WSTR nvarchar(4000) 4000 False
DisplayName DT_WSTR nvarchar(500) 500 False
GivenName DT_WSTR nvarchar(80) 80 False
JobTitle DT_WSTR nvarchar(200) 200 False
Mail DT_WSTR nvarchar(200) 200 False
MobilePhone DT_WSTR nvarchar(500) 500 False
OfficeLocation DT_WSTR nvarchar(500) 500 False
PreferredLanguage DT_WSTR nvarchar(100) 100 False
SurName DT_WSTR nvarchar(80) 80 False
UserPrincipalName DT_WSTR nvarchar(200) 200 False
Id DT_WSTR nvarchar(4000) 4000 False
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 Raw 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 component to read data or in API Destination component to read/write data:

Read from Users table using API Destination

This Endpoint belongs to Users table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Outlook Mail (Office 365)
Users
Select
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get users

SELECT * FROM get_users

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 get_users';

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).