Class UsersRequestBuilder.UsersRequestBuilderGetQueryParameters
Private Use - Returns a list of the users associated to an account.
public class UsersRequestBuilder.UsersRequestBuilderGetQueryParameters- Inheritance
-
UsersRequestBuilder.UsersRequestBuilderGetQueryParameters
- Inherited Members
Properties
Fields
List of fields to return in the response. Defaults to all fields. Valid list of fields are name, email, firstName, lastName, autodeskId, analyticsId, addressLine1, addressLine2, city, stateOrProvince, status, postalCode, country, imageUrl, lastSignIn, phone, jobTitle, industry, aboutMe, createdAt, updatedAt, accessLevels, defaultRoleId, defaultRoleName, defaultCompanyId, and defaultCompanyName.
[Obsolete("This property is deprecated, use FieldsAsGetFieldsQueryParameterType instead")]
[QueryParameter("fields")]
public string[]? Fields { get; set; }Property Value
- string[]
FieldsAsGetFieldsQueryParameterType
List of fields to return in the response. Defaults to all fields. Valid list of fields are name, email, firstName, lastName, autodeskId, analyticsId, addressLine1, addressLine2, city, stateOrProvince, status, postalCode, country, imageUrl, lastSignIn, phone, jobTitle, industry, aboutMe, createdAt, updatedAt, accessLevels, defaultRoleId, defaultRoleName, defaultCompanyId, and defaultCompanyName.
[QueryParameter("fields")]
public GetFieldsQueryParameterType[]? FieldsAsGetFieldsQueryParameterType { get; set; }Property Value
FilterTextMatch
When filtering on a text based field this indicates how to do the matching. Valid values are contains, startsWith, endsWith and equals. Default is contains.
[Obsolete("This property is deprecated, use FilterTextMatchAsGetFilterTextMatchQueryParameterType instead")]
[QueryParameter("filterTextMatch")]
public string? FilterTextMatch { get; set; }Property Value
FilterTextMatchAsGetFilterTextMatchQueryParameterType
When filtering on a text based field this indicates how to do the matching. Valid values are contains, startsWith, endsWith and equals. Default is contains.
[QueryParameter("filterTextMatch")]
public GetFilterTextMatchQueryParameterType? FilterTextMatchAsGetFilterTextMatchQueryParameterType { get; set; }Property Value
FilteraccessLevels
Filter account users by their access levels. Valid values are accountAdmin, projectAdmin, projectMember, executive and noAccess.
[Obsolete("This property is deprecated, use FilteraccessLevelsAsGetFilterAccessLevelsQueryParameterType instead")]
[QueryParameter("filter%5BaccessLevels%5D")]
public string[]? FilteraccessLevels { get; set; }Property Value
- string[]
FilteraccessLevelsAsGetFilterAccessLevelsQueryParameterType
Filter account users by their access levels. Valid values are accountAdmin, projectAdmin, projectMember, executive and noAccess.
[QueryParameter("filter%5BaccessLevels%5D")]
public GetFilterAccessLevelsQueryParameterType[]? FilteraccessLevelsAsGetFilterAccessLevelsQueryParameterType { get; set; }Property Value
FilterautodeskId
Filter account users by one or many autodeskIds. For example filter[autodeskId]=LR3JVSFPDEAB, ....
[QueryParameter("filter%5BautodeskId%5D")]
public string[]? FilterautodeskId { get; set; }Property Value
- string[]
FilterdefaultCompanyId
Filter account users by default company id.
[QueryParameter("filter%5BdefaultCompanyId%5D")]
public Guid? FilterdefaultCompanyId { get; set; }Property Value
- Guid?
FilterdefaultCompanyName
Filter account users by company name. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5BdefaultCompanyName%5D")]
public string? FilterdefaultCompanyName { get; set; }Property Value
FilterdefaultRoleId
Filter account users by default role id.
[QueryParameter("filter%5BdefaultRoleId%5D")]
public Guid? FilterdefaultRoleId { get; set; }Property Value
- Guid?
FilterdefaultRoleName
Filter account users by role name. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5BdefaultRoleName%5D")]
public string? FilterdefaultRoleName { get; set; }Property Value
Filteremail
Filter account users by email address. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5Bemail%5D")]
public string? Filteremail { get; set; }Property Value
Filteremails
Filter account users by one or many email. For example filter[emails]=test@autodesk.com, ..., ....
[QueryParameter("filter%5Bemails%5D")]
public string[]? Filteremails { get; set; }Property Value
- string[]
Filterid
Filter account users by one or many ids. For example filter[id]=883e1a66-6775-4045-b3cc-cf0e614ff7b5, ..., ....
[QueryParameter("filter%5Bid%5D")]
public Guid?[]? Filterid { get; set; }Property Value
- Guid?[]
Filtername
Filter account users by name. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5Bname%5D")]
public string? Filtername { get; set; }Property Value
Filterstatus
Filter account users by their status. Valid values are active, not_invited, pending, disabled and deleted. Defaults to active.
[Obsolete("This property is deprecated, use FilterstatusAsGetFilterStatusQueryParameterType instead")]
[QueryParameter("filter%5Bstatus%5D")]
public string[]? Filterstatus { get; set; }Property Value
- string[]
FilterstatusAsGetFilterStatusQueryParameterType
Filter account users by their status. Valid values are active, not_invited, pending, disabled and deleted. Defaults to active.
[QueryParameter("filter%5Bstatus%5D")]
public GetFilterStatusQueryParameterType[]? FilterstatusAsGetFilterStatusQueryParameterType { get; set; }Property Value
Limit
The maximum number of records to return in a single request. Possible range: 1-200. Default Can be a number between 1 and 200. Default value: 20. If a number greater than 200 is provided 200 will be returned.
[QueryParameter("limit")]
public int? Limit { get; set; }Property Value
- int?
Offset
The number of records to skip before returning the result records. Increase this value in subsequent requests to continue getting results when the number of records exceeds the requested limit.
[QueryParameter("offset")]
public int? Offset { get; set; }Property Value
- int?
OrFilters
List of filtered fields to apply an "or" operator. Valid list of fields are id, name, email, autodeskId, status, accessLevels, defaultCompanyId, defaultCompanyName and defaultRoleName.
[Obsolete("This property is deprecated, use OrFiltersAsGetOrFiltersQueryParameterType instead")]
[QueryParameter("orFilters")]
public string[]? OrFilters { get; set; }Property Value
- string[]
OrFiltersAsGetOrFiltersQueryParameterType
List of filtered fields to apply an "or" operator. Valid list of fields are id, name, email, autodeskId, status, accessLevels, defaultCompanyId, defaultCompanyName and defaultRoleName.
[QueryParameter("orFilters")]
public GetOrFiltersQueryParameterType[]? OrFiltersAsGetOrFiltersQueryParameterType { get; set; }Property Value
Sort
The list of fields to sort by. When multiple fields are listed the later property is used to sort the resources where the previous fields have the same value. Each property can be followed by a direction modifier of either asc (ascending) or desc (descending). If no direction is specified then asc is assumed. Valid fields for sorting are name, email, firstName, lastName, country, stateOrProvince, status, postalCode, city, defaultCompanyName, defaultRoleName, createdAt and updatedAt. Default sort is name.
[Obsolete("This property is deprecated, use SortAsGetSortQueryParameterType instead")]
[QueryParameter("sort")]
public string[]? Sort { get; set; }Property Value
- string[]
SortAsGetSortQueryParameterType
The list of fields to sort by. When multiple fields are listed the later property is used to sort the resources where the previous fields have the same value. Each property can be followed by a direction modifier of either asc (ascending) or desc (descending). If no direction is specified then asc is assumed. Valid fields for sorting are name, email, firstName, lastName, country, stateOrProvince, status, postalCode, city, defaultCompanyName, defaultRoleName, createdAt and updatedAt. Default sort is name.
[QueryParameter("sort")]
public GetSortQueryParameterType[]? SortAsGetSortQueryParameterType { get; set; }