Get User by Id
Name
get_user
Description
Get a specific user. [API reference]
Related Tables
Parameters
Parameter | Label | Required | Options | Description |
---|---|---|---|---|
UserId | User ID or Email | YES | 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') | |
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 |
|
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 |
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:
Lookup a row in 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:

ODBC application
Use these SQL queries in your ODBC application data source:
Get user by id
SELECT * FROM get_user
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 get_user
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).