Endpoint Get User by Id
Name
get_user
Description
Get a specific user. [API reference]
Related Tables
Parameters
Parameter | Required | Options |
---|---|---|
Name:
Label: User ID or Email The Microsoft Mail user ID GUID or email address for the account to read messages from. (Examples: '4ff54a77-9c09-4274-958f-83bdc0a53900' or 'first.last@domain.com') |
YES | |
Name:
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 | |
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 |
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:
Required Parameters | |
---|---|
User ID or Email | Fill-in the parameter... |

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 user by id:
Required Parameters | |
---|---|
User ID or Email | Fill-in the parameter... |

ODBC application
Use these SQL queries in your ODBC application data source:
Get user by id
SELECT * FROM Users
WHERE Id = 'abcd-1234-userid'
get_user
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 user by id
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Users
WHERE Id = ''abcd-1234-userid''';
EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];
get_user
endpoint belongs to
Users
table(s), and can therefore be used via those table(s).