Class User

The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin- sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin- sdk/directory/v1/guides/manage-user-aliases.html).

Inheritance

System.Object

User

Implements

IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Admin.Directory.directory_v1.Data

Assembly: Google.Apis.Admin.Directory.directory_v1.dll

Syntax

public class User : IDirectResponseSchema

Properties

Addresses

A list of the user's addresses. The maximum allowed data size for this field is 10Kb.

Declaration

[JsonProperty("addresses")]
public virtual object Addresses { get; set; }

Property Value

Type	Description
System.Object

AgreedToTerms

Output only. This property is true if the user has completed an initial login and accepted the Terms of Service agreement.

Declaration

[JsonProperty("agreedToTerms")]
public virtual bool? AgreedToTerms { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Aliases

Output only. List of the user's alias email addresses.

Declaration

[JsonProperty("aliases")]
public virtual IList<string> Aliases { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Archived

Indicates if user is archived.

Declaration

[JsonProperty("archived")]
public virtual bool? Archived { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ChangePasswordAtNextLogin

Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.

Declaration

[JsonProperty("changePasswordAtNextLogin")]
public virtual bool? ChangePasswordAtNextLogin { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

CreationTime

System.DateTime representation of CreationTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTime? CreationTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

CreationTimeRaw

User's G Suite account creation time. (Read-only)

Declaration

[JsonProperty("creationTime")]
public virtual string CreationTimeRaw { get; set; }

Property Value

Type	Description
System.String

CustomerId

Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage- users.html#get_all_users). You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a [users.list](/admin- sdk/directory/v1/reference/users/list) request.

Declaration

[JsonProperty("customerId")]
public virtual string CustomerId { get; set; }

Property Value

Type	Description
System.String

CustomSchemas

Custom fields of the user.

Declaration

[JsonProperty("customSchemas")]
public virtual IDictionary<string, IDictionary<string, object>> CustomSchemas { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IDictionary<System.String, System.Object>>

DeletionTime

System.DateTime representation of DeletionTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTime? DeletionTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

DeletionTimeRaw

Declaration

[JsonProperty("deletionTime")]
public virtual string DeletionTimeRaw { get; set; }

Property Value

Type	Description
System.String

Emails

A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.

Declaration

[JsonProperty("emails")]
public virtual object Emails { get; set; }

Property Value

Type	Description
System.Object

ETag

Output only. ETag of the resource.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

ExternalIds

A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb.

Declaration

[JsonProperty("externalIds")]
public virtual object ExternalIds { get; set; }

Property Value

Type	Description
System.Object

Gender

The user's gender. The maximum allowed data size for this field is 1Kb.

Declaration

[JsonProperty("gender")]
public virtual object Gender { get; set; }

Property Value

Type	Description
System.Object

HashFunction

Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.

Declaration

[JsonProperty("hashFunction")]
public virtual string HashFunction { get; set; }

Property Value

Type	Description
System.String

Id

The unique ID for the user. A user id can be used as a user request URI's userKey.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
System.String

Ims

The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb.

Declaration

[JsonProperty("ims")]
public virtual object Ims { get; set; }

Property Value

Type	Description
System.Object

IncludeInGlobalAddressList

Indicates if the user's profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the administration help center.

Declaration

[JsonProperty("includeInGlobalAddressList")]
public virtual bool? IncludeInGlobalAddressList { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IpWhitelisted

If true, the user's IP address is white listed.

Declaration

[JsonProperty("ipWhitelisted")]
public virtual bool? IpWhitelisted { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsAdmin

Output only. Indicates a user with super admininistrator privileges. The isAdmin property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage- users.html#make_admin) operation ( makeAdmin method). If edited in the user insert or update methods, the edit is ignored by the API service.

Declaration

[JsonProperty("isAdmin")]
public virtual bool? IsAdmin { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsDelegatedAdmin

Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.

Declaration

[JsonProperty("isDelegatedAdmin")]
public virtual bool? IsDelegatedAdmin { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsEnforcedIn2Sv

Output only. Is 2-step verification enforced (Read-only)

Declaration

[JsonProperty("isEnforcedIn2Sv")]
public virtual bool? IsEnforcedIn2Sv { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsEnrolledIn2Sv

Output only. Is enrolled in 2-step verification (Read-only)

Declaration

[JsonProperty("isEnrolledIn2Sv")]
public virtual bool? IsEnrolledIn2Sv { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsMailboxSetup

Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.

Declaration

[JsonProperty("isMailboxSetup")]
public virtual bool? IsMailboxSetup { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Keywords

The user's keywords. The maximum allowed data size for this field is 1Kb.

Declaration

[JsonProperty("keywords")]
public virtual object Keywords { get; set; }

Property Value

Type	Description
System.Object

Kind

Output only. The type of the API resource. For Users resources, the value is admin#directory#user.

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
System.String

Languages

The user's languages. The maximum allowed data size for this field is 1Kb.

Declaration

[JsonProperty("languages")]
public virtual object Languages { get; set; }

Property Value

Type	Description
System.Object

LastLoginTime

System.DateTime representation of LastLoginTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTime? LastLoginTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

LastLoginTimeRaw

User's last login time. (Read-only)

Declaration

[JsonProperty("lastLoginTime")]
public virtual string LastLoginTimeRaw { get; set; }

Property Value

Type	Description
System.String

Locations

The user's locations. The maximum allowed data size for this field is 10Kb.

Declaration

[JsonProperty("locations")]
public virtual object Locations { get; set; }

Property Value

Type	Description
System.Object

Name

Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the administration help center. Maximum allowed data size for this field is 1Kb.

Declaration

[JsonProperty("name")]
public virtual UserName Name { get; set; }

Property Value

Type	Description
UserName

NonEditableAliases

Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.

Declaration

[JsonProperty("nonEditableAliases")]
public virtual IList<string> NonEditableAliases { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Notes

Notes for the user.

Declaration

[JsonProperty("notes")]
public virtual object Notes { get; set; }

Property Value

Type	Description
System.Object

Organizations

A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb.

Declaration

[JsonProperty("organizations")]
public virtual object Organizations { get; set; }

Property Value

Type	Description
System.Object

OrgUnitPath

The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).

Declaration

[JsonProperty("orgUnitPath")]
public virtual string OrgUnitPath { get; set; }

Property Value

Type	Description
System.String

Password

User's password

Declaration

[JsonProperty("password")]
public virtual string Password { get; set; }

Property Value

Type	Description
System.String

Phones

A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.

Declaration

[JsonProperty("phones")]
public virtual object Phones { get; set; }

Property Value

Type	Description
System.Object

PosixAccounts

A list of POSIX account information for the user.

Declaration

[JsonProperty("posixAccounts")]
public virtual object PosixAccounts { get; set; }

Property Value

Type	Description
System.Object

PrimaryEmail

The user's primary email address. This property is required in a request to create a user account. The primaryEmail must be unique and cannot be an alias of another user.

Declaration

[JsonProperty("primaryEmail")]
public virtual string PrimaryEmail { get; set; }

Property Value

Type	Description
System.String

RecoveryEmail

Recovery email of the user.

Declaration

[JsonProperty("recoveryEmail")]
public virtual string RecoveryEmail { get; set; }

Property Value

Type	Description
System.String

RecoveryPhone

Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.

Declaration

[JsonProperty("recoveryPhone")]
public virtual string RecoveryPhone { get; set; }

Property Value

Type	Description
System.String

Relations

A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.

Declaration

[JsonProperty("relations")]
public virtual object Relations { get; set; }

Property Value

Type	Description
System.Object

SshPublicKeys

A list of SSH public keys.

Declaration

[JsonProperty("sshPublicKeys")]
public virtual object SshPublicKeys { get; set; }

Property Value

Type	Description
System.Object

Suspended

Indicates if user is suspended.

Declaration

[JsonProperty("suspended")]
public virtual bool? Suspended { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

SuspensionReason

Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.

Declaration

[JsonProperty("suspensionReason")]
public virtual string SuspensionReason { get; set; }

Property Value

Type	Description
System.String

ThumbnailPhotoEtag

Output only. ETag of the user's photo (Read-only)

Declaration

[JsonProperty("thumbnailPhotoEtag")]
public virtual string ThumbnailPhotoEtag { get; set; }

Property Value

Type	Description
System.String

ThumbnailPhotoUrl

Output only. Photo Url of the user (Read-only)

Declaration

[JsonProperty("thumbnailPhotoUrl")]
public virtual string ThumbnailPhotoUrl { get; set; }

Property Value

Type	Description
System.String

Websites

The user's websites. The maximum allowed data size for this field is 2Kb.

Declaration

[JsonProperty("websites")]
public virtual object Websites { get; set; }

Property Value

Type	Description
System.Object

Implements

IDirectResponseSchema