google_api_admin v0.18.0 GoogleApi.Admin.Directory_v1.Model.User View Source

JSON template for User object in Directory API.

Attributes

  • ims (type: any(), default: nil) -
  • posixAccounts (type: any(), default: nil) -
  • etag (type: String.t, default: nil) - ETag of the resource.
  • orgUnitPath (type: String.t, default: nil) - OrgUnit of User
  • suspensionReason (type: String.t, default: nil) - Suspension reason if user is suspended (Read-only)
  • agreedToTerms (type: boolean(), default: nil) - Indicates if user has agreed to terms (Read-only)
  • customSchemas (type: %{optional(String.t) => GoogleApi.Admin.Directory_v1.Model.UserCustomProperties.t}, default: nil) - Custom fields of the user.
  • externalIds (type: any(), default: nil) -
  • gender (type: any(), default: nil) -
  • recoveryPhone (type: String.t, default: nil) - Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
  • deletionTime (type: DateTime.t, default: nil) -
  • keywords (type: any(), default: nil) -
  • isEnrolledIn2Sv (type: boolean(), default: nil) - Is enrolled in 2-step verification (Read-only)
  • includeInGlobalAddressList (type: boolean(), default: nil) - Boolean indicating if user is included in Global Address List
  • addresses (type: any(), default: nil) -
  • kind (type: String.t, default: admin#directory#user) - Kind of resource this is.
  • sshPublicKeys (type: any(), default: nil) -
  • languages (type: any(), default: nil) -
  • password (type: String.t, default: nil) - User's password
  • thumbnailPhotoEtag (type: String.t, default: nil) - ETag of the user's photo (Read-only)
  • hashFunction (type: String.t, default: nil) - Hash function name for password. Supported are MD5, SHA-1 and crypt
  • name (type: GoogleApi.Admin.Directory_v1.Model.UserName.t, default: nil) - User's name
  • suspended (type: boolean(), default: nil) - Indicates if user is suspended.
  • lastLoginTime (type: DateTime.t, default: nil) - User's last login time. (Read-only)
  • relations (type: any(), default: nil) -
  • recoveryEmail (type: String.t, default: nil) - Recovery email of the user.
  • websites (type: any(), default: nil) -
  • primaryEmail (type: String.t, default: nil) - username of User
  • ipWhitelisted (type: boolean(), default: nil) - Boolean indicating if ip is whitelisted
  • creationTime (type: DateTime.t, default: nil) - User's G Suite account creation time. (Read-only)
  • customerId (type: String.t, default: nil) - CustomerId of User (Read-only)
  • archived (type: boolean(), default: nil) - Indicates if user is archived.
  • isDelegatedAdmin (type: boolean(), default: nil) - Boolean indicating if the user is delegated admin (Read-only)
  • locations (type: any(), default: nil) -
  • nonEditableAliases (type: list(String.t), default: nil) - List of non editable aliases (Read-only)
  • emails (type: any(), default: nil) -
  • isAdmin (type: boolean(), default: nil) - Boolean indicating if the user is admin (Read-only)
  • aliases (type: list(String.t), default: nil) - List of aliases (Read-only)
  • id (type: String.t, default: nil) - Unique identifier of User (Read-only)
  • isEnforcedIn2Sv (type: boolean(), default: nil) - Is 2-step verification enforced (Read-only)
  • thumbnailPhotoUrl (type: String.t, default: nil) - Photo Url of the user (Read-only)
  • phones (type: any(), default: nil) -
  • notes (type: any(), default: nil) -
  • changePasswordAtNextLogin (type: boolean(), default: nil) - Boolean indicating if the user should change password in next login
  • isMailboxSetup (type: boolean(), default: nil) - Is mailbox setup (Read-only)
  • organizations (type: any(), default: nil) -

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Admin.Directory_v1.Model.User{
  addresses: any(),
  agreedToTerms: boolean(),
  aliases: [String.t()],
  archived: boolean(),
  changePasswordAtNextLogin: boolean(),
  creationTime: DateTime.t(),
  customSchemas: %{
    optional(String.t()) =>
      GoogleApi.Admin.Directory_v1.Model.UserCustomProperties.t()
  },
  customerId: String.t(),
  deletionTime: DateTime.t(),
  emails: any(),
  etag: String.t(),
  externalIds: any(),
  gender: any(),
  hashFunction: String.t(),
  id: String.t(),
  ims: any(),
  includeInGlobalAddressList: boolean(),
  ipWhitelisted: boolean(),
  isAdmin: boolean(),
  isDelegatedAdmin: boolean(),
  isEnforcedIn2Sv: boolean(),
  isEnrolledIn2Sv: boolean(),
  isMailboxSetup: boolean(),
  keywords: any(),
  kind: String.t(),
  languages: any(),
  lastLoginTime: DateTime.t(),
  locations: any(),
  name: GoogleApi.Admin.Directory_v1.Model.UserName.t(),
  nonEditableAliases: [String.t()],
  notes: any(),
  orgUnitPath: String.t(),
  organizations: any(),
  password: String.t(),
  phones: any(),
  posixAccounts: any(),
  primaryEmail: String.t(),
  recoveryEmail: String.t(),
  recoveryPhone: String.t(),
  relations: any(),
  sshPublicKeys: any(),
  suspended: boolean(),
  suspensionReason: String.t(),
  thumbnailPhotoEtag: String.t(),
  thumbnailPhotoUrl: String.t(),
  websites: any()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.