Endpoint Get Users
Name
get_users
Description
Get the list of users. [API reference]
Related Tables
Parameters
Parameter | Required | Options | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Name:
Label: Order By Order the specified column by ascending or descending order |
|
|||||||||||
Name:
Label: Search Criteria Data filter (e.g. somecolumn -eq 'somevalue') |
|
|||||||||||
Name:
Label: Page Size The number of records to include in each page of results |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(255)
|
255 | |
DisplayName |
DT_WSTR
|
nvarchar(500)
|
500 | |
Description |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
BusinessPhones |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
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 | |
CreatedDateTime |
DT_DBTIMESTAMP
|
datetime
|
||
DeletedDateTime |
DT_DBTIMESTAMP
|
datetime
|
||
IdPath |
DT_WSTR
|
nvarchar(255)
|
255 |
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 OneDrive 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:
Optional Parameters | |
---|---|
DataFormat | OData |

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:
Optional Parameters | |
---|---|
DataFormat | OData |

ODBC application
Use these SQL queries in your ODBC application data source:
Get Users
SELECT * FROM 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 Users';
EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY];
get_users
endpoint belongs to
Users
table(s), and can therefore be used via those table(s).