Endpoint Get User by Id or Name
Name
get_user
Description
Gets database user information for a specific Id [API reference]
Related Tables
Parameters
| Parameter | Required | Options |
|---|---|---|
|
Name:
Label: User Name (Case-Sensitive) |
YES | |
|
Name:
Label: Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(255)
|
255 | The unique name that identifies the collection. |
| ResourceId |
DT_WSTR
|
nvarchar(2000)
|
2000 | System generated property. The resource ID is a unique identifier that is also hierarchical per the resource stack on the resource model. It is used internally for placement and navigation of the permission resource. |
| LastUpdated |
DT_I4
|
int
|
System generated property. Specifies the last updated timestamp of the resource. | |
| ETag |
DT_WSTR
|
nvarchar(4000)
|
4000 | System generated property representing the resource etag required for optimistic concurrency control. |
| Permissions |
DT_WSTR
|
nvarchar(4000)
|
4000 | System generated property that specifies the addressable path of the conflicts resource. During an operation on a resource within a collection, if a conflict occurs, users can inspect the conflicting resources by performing a GET on the conflicts URI path. |
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 Cosmos DB Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the SysUsers table, therefore it is better to use it, instead of accessing the endpoint directly:
| Required Parameters | |
|---|---|
| User Name (Case-Sensitive) | Fill-in the parameter... |
| Optional Parameters | |
| Database Name (keep blank to use default) Case-Sensitive | |
API Destination
This Endpoint belongs to the SysUsers 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 or name:
| Required Parameters | |
|---|---|
| User Name (Case-Sensitive) | Fill-in the parameter... |
| Optional Parameters | |
| Database Name (keep blank to use default) Case-Sensitive | |
ODBC application
Use these SQL queries in your ODBC application data source:
Get user by id or name
SELECT * FROM SysUsers
WHERE Id = 'abcd-1234-id'
get_user endpoint belongs to
SysUsers
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 or name
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM SysUsers
WHERE Id = ''abcd-1234-id''';
EXEC (@MyQuery) AT [LS_TO_COSMOS_DB_IN_GATEWAY];
get_user endpoint belongs to
SysUsers
table(s), and can therefore be used via those table(s).