HubSpot API Data Model
UserRoleIDsByUserID |
Retrieves a userRetrieves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.
Catalog: UserProvisioning3
Schema: Users
Label: {res:itgen_hubspot_userroleidsbyuserid_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function UserRoleIDsByUserID. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
idProperty |
string |
☐ |
|
The name of a property with unique user values. Valid values are `USER_ID`(default) or `EMAIL` (Waarden: USER_ID, EMAIL) |
userId |
string |
☑ |
|
Identifier of user to retrieve |
Columns of Table Function
The columns of the table function UserRoleIDsByUserID are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
string |
☐ |
The user's email |
||
firstName |
string |
First Name |
☐ |
|
id |
string |
ID |
☐ |
The user's unique ID |
lastName |
string |
Last Name |
☐ |
|
primaryTeamId |
string |
Primary Team ID |
☐ |
The user's primary team |
roleId |
string |
Role ID |
☐ |
The user's role |
sendWelcomeEmail |
boolean |
{res:itgen_hubspot_sendwelcomeemail} |
☐ |
|
superAdmin |
boolean |
{res:itgen_hubspot_superadmin} |
☐ |
|
TEXT |
string |
Text |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180
