> ## Documentation Index
> Fetch the complete documentation index at: https://superofficeas-worktree-351-fix-webapi-escaped-anchors.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.User

<h1 id="SuperOffice_WebApi_Data_User">
  Class User
</h1>

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for User.
SuperOffice User, with login credentials and an associated person.

```csharp theme={null}
public class User : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[User](SuperOffice.WebApi.Data.User.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get User 123 using the WebApi client:
\<pre>\<code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new UserAgent(configuration);
var user = agent.GetUser( 123 );\</code>\</pre>

## Remarks

Use \<xref href="SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent" data-throw-if-not-resolved="false">\</xref>:
All User: \<pre>\<code class="lang-csharp">"AllUsers"\</code>\</pre>

## Constructors

<h3 id="SuperOffice_WebApi_Data_User__ctor">
  User()
</h3>

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public User()
```

## Properties

<h3 id="SuperOffice_WebApi_Data_User_AssociateId">
  AssociateId
</h3>

Primary key

```csharp theme={null}
public virtual int AssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

<h3 id="SuperOffice_WebApi_Data_User_Credentials">
  Credentials
</h3>

List of credentials registered for this user. i.e. valid authentication methods.

```csharp theme={null}
public virtual Credential[] Credentials { get; set; }
```

#### Property Value

[Credential](SuperOffice.WebApi.Data.Credential.md)\[]

<h3 id="SuperOffice_WebApi_Data_User_CustomFields">
  CustomFields
</h3>

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.
Custom fields combines user defined fields and extra fields into one bucket.
The individual \<xref href="SuperOffice.WebApi.Data.User.ExtraFields" data-throw-if-not-resolved="false">\</xref> and UserDefinedFields properties are deprecated in favor of this
combined collection.
The value string is the encoded value: "\[I:123]" or "\[DT:2019-09-11]".

```csharp theme={null}
public virtual StringDictionary CustomFields { get; set; }
```

#### Property Value

[StringDictionary](SuperOffice.WebApi.Data.StringDictionary.md)

#### Remarks

The naming convention of the key string is as follows:
\<table>\<tbody>\<tr>\<td class="term">Extra field data\</td>\<td class="description">
\[Extra field name]\<p>\</p>
Example: \<pre>\<code class="lang-csharp">'x\_gorp' = '\[I:123]'\</code>\</pre>
\</td>\</tr>\<tr>\<td class="term">User defined field data\</td>\<td class="description">
\[Prog-id name]\<p>\</p>
Example: \<pre>\<code class="lang-csharp">'SuperOffice:1' = '\[I:123]'\</code>\</pre>\<p>\</p>
\</td>\</tr>\</tbody>\</table>

<h3 id="SuperOffice_WebApi_Data_User_Deleted">
  Deleted
</h3>

If true, the user is retired and should have no rights, not appear in lists, etc.

```csharp theme={null}
public virtual bool Deleted { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

<h3 id="SuperOffice_WebApi_Data_User_EjUserId">
  EjUserId
</h3>

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users

```csharp theme={null}
public virtual int EjUserId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

<h3 id="SuperOffice_WebApi_Data_User_ExtraFields">
  ExtraFields
</h3>

Deprecated: Use \<xref href="SuperOffice.WebApi.Data.User.CustomFields" data-throw-if-not-resolved="false">\</xref> instead.
Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.
The value string is the encoded value: "\[I:123]" or "\[DT:2019-09-11]".

```csharp theme={null}
public virtual StringDictionary ExtraFields { get; set; }
```

#### Property Value

[StringDictionary](SuperOffice.WebApi.Data.StringDictionary.md)

#### Remarks

The naming convention of the key string is as follows:
\<table>\<tbody>\<tr>\<td class="term">Plug-in data\</td>\<td class="description">
\[Plug-in name].\[Property name]
Example: DocumentPlugin.DocumentType
\</td>\</tr>\<tr>\<td class="term">Foreign key data\</td>\<td class="description">
The device identity is appended directly to the device name if it exists.
This is not commonly used, but the database opens for this as a possibility to have several devices with the same name,
and hence we would ensure an unique key if this field is used.
Example: Audience.SecretService.DefaultCountry
\</td>\</tr>\<tr>\<td class="term">User defined table data\</td>\<td class="description">
\[Table name].\[Field name]
Example: Phunneling.AggregatedSales
\</td>\</tr>\<tr>\<td class="term">Other\</td>\<td class="description">
Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary.
We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).
\</td>\</tr>\</tbody>\</table>

<h3 id="SuperOffice_WebApi_Data_User_IsOnTravel">
  IsOnTravel
</h3>

True if the user is on travel.

```csharp theme={null}
public virtual bool IsOnTravel { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

<h3 id="SuperOffice_WebApi_Data_User_IsPersonRetired">
  IsPersonRetired
</h3>

True if the user is retired and should have no rights, not appear in lists, etc.

```csharp theme={null}
public virtual bool IsPersonRetired { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

<h3 id="SuperOffice_WebApi_Data_User_Lastlogin">
  Lastlogin
</h3>

Last login date

```csharp theme={null}
public virtual DateTime Lastlogin { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

<h3 id="SuperOffice_WebApi_Data_User_Lastlogout">
  Lastlogout
</h3>

Last logout date

```csharp theme={null}
public virtual DateTime Lastlogout { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

<h3 id="SuperOffice_WebApi_Data_User_LicenseOwners">
  LicenseOwners
</h3>

The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user

```csharp theme={null}
public virtual LicenseOwner[] LicenseOwners { get; set; }
```

#### Property Value

[LicenseOwner](SuperOffice.WebApi.Data.LicenseOwner.md)\[]

<h3 id="SuperOffice_WebApi_Data_User_Name">
  Name
</h3>

Initials, UserId - also used as login name for on-site installations. Identifies user in archives.

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_User_NickName">
  NickName
</h3>

The unique nick name for this user. Used in Service as an alias, similar to Name/Initials.

```csharp theme={null}
public virtual string NickName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_User_OtherGroups">
  OtherGroups
</h3>

The other groups this user is a member of, apart from the main user group.
\<p>Use MDO List name "usergroup" to get list items.\</p>

```csharp theme={null}
public virtual UserGroup[] OtherGroups { get; set; }
```

#### Property Value

[UserGroup](SuperOffice.WebApi.Data.UserGroup.md)\[]

<h3 id="SuperOffice_WebApi_Data_User_Person">
  Person
</h3>

The person associated with this user. Detailed information about the user
\<p>Use MDO List name "person\_new" to get list items.\</p>

```csharp theme={null}
public virtual Person Person { get; set; }
```

#### Property Value

[Person](SuperOffice.WebApi.Data.Person.md)

<h3 id="SuperOffice_WebApi_Data_User_PostSaveCommands">
  PostSaveCommands
</h3>

Post custom commands the client should execute after save has completed.

```csharp theme={null}
public virtual CustomCommand[] PostSaveCommands { get; set; }
```

#### Property Value

[CustomCommand](SuperOffice.WebApi.Data.CustomCommand.md)\[]

<h3 id="SuperOffice_WebApi_Data_User_Rank">
  Rank
</h3>

Rank order

```csharp theme={null}
public virtual short Rank { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

<h3 id="SuperOffice_WebApi_Data_User_RequestSignature">
  RequestSignature
</h3>

ej users request signature

```csharp theme={null}
public virtual string RequestSignature { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_User_Role">
  Role
</h3>

Users role for role-based security. Determines permissions and access rights for the user.

```csharp theme={null}
public virtual Role Role { get; set; }
```

#### Property Value

[Role](SuperOffice.WebApi.Data.Role.md)

<h3 id="SuperOffice_WebApi_Data_User_TicketCategories">
  TicketCategories
</h3>

Request Ticket Categories assigned to the user.
\<p>Use MDO List name "ejCategory" to get list items.\</p>

```csharp theme={null}
public virtual MDOListItem[] TicketCategories { get; set; }
```

#### Property Value

[MDOListItem](SuperOffice.WebApi.Data.MDOListItem.md)\[]

<h3 id="SuperOffice_WebApi_Data_User_Tooltip">
  Tooltip
</h3>

Tooltip or other description

```csharp theme={null}
public virtual string Tooltip { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_User_Type">
  Type
</h3>

User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public UserType? Type { get; set; }
```

#### Property Value

[UserType](SuperOffice.WebApi.Data.UserType.md)?

#### See Also

[User](SuperOffice.WebApi.Data.User.md).[Type\_String](SuperOffice.WebApi.Data.User.md#SuperOffice_WebApi_Data_User_Type_String)

<h3 id="SuperOffice_WebApi_Data_User_Type_String">
  Type\_String
</h3>

User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate
Raw string enum value.

```csharp theme={null}
[JsonProperty("Type")]
public string Type_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[User](SuperOffice.WebApi.Data.User.md).[Type](SuperOffice.WebApi.Data.User.md#SuperOffice_WebApi_Data_User_Type)

<h3 id="SuperOffice_WebApi_Data_User_UserGroup">
  UserGroup
</h3>

The main user group that this user belongs to.
\<p>Use MDO List name "usergroup" to get list items.\</p>

```csharp theme={null}
public virtual UserGroup UserGroup { get; set; }
```

#### Property Value

[UserGroup](SuperOffice.WebApi.Data.UserGroup.md)

<h3 id="SuperOffice_WebApi_Data_User_UserName">
  UserName
</h3>

User name, a.k.a. Login name. This might be an e-mail address.

```csharp theme={null}
public virtual string UserName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_User_WaitingForApproval">
  WaitingForApproval
</h3>

The user is waiting for an administrator to approve/grant her/him access.

```csharp theme={null}
public virtual bool WaitingForApproval { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

## See Also

[UserAgent](SuperOffice.WebApi.Agents.UserAgent.md),
[ArchiveAgent](SuperOffice.WebApi.Agents.ArchiveAgent.md),