> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.UserCandidate

# <a id="SuperOffice_WebApi_Data_UserCandidate" /> Class UserCandidate

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

Carrier object for UserCandidate.
The UserCandidate carrier is used to represent a Customer Centre User.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[UserCandidate](SuperOffice.WebApi.Data.UserCandidate.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)

## Constructors

### <a id="SuperOffice_WebApi_Data_UserCandidate__ctor" /> UserCandidate()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_UserCandidate_PersonId" /> PersonId

Foreign key. Id of a person representing Customer Center User.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UserCandidate_SecretKey" /> SecretKey

Username of a Customer Centre User.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UserCandidate_SecretValue" /> SecretValue

Password of a Customer Centre User.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_UserCandidate_UserCandidateId" /> UserCandidateId

Primary key

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

#### Property Value

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


## Related topics

- [SuperOffice.WebApi.Agents.PersonAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PersonAgent.md)
- [SuperOffice.WebApi.Agents.IPersonAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IPersonAgent.md)
- [SuperOffice.WebApi.Data.Person GetUserCandidateByPersonRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Person_GetUserCandidateByPersonRequest.md)
- [SuperOffice.WebApi.Data.Person CreateOrUpdateUserCandidateRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Person_CreateOrUpdateUserCandidateRequest.md)
- [SuperOffice.WebApi.Data.NetServerBuildType](/en/api/reference/webapi/SuperOffice.WebApi.Data.NetServerBuildType.md)
- [SuperOffice.WebApi.Data.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)