Documentation

Mistake on this page? Email us

User User

Hierarchy

Index

Constructors

constructor

Properties

accountId

accountId: string

The ID of the account. The UUID of the account.

example

01619571e2e90242ac12000600000000

activeSessions

activeSessions: Array<ActiveSession>

Represents an active user session.

address

address: string

Address.

example

110 Fulbourn Rd, Cambridge, United Kingdom

createdAt

createdAt: Date

Creation UTC time RFC3339. Creation time.

example

2018-02-13T09:35:20Z

creationTime

creationTime: number

A timestamp of the user creation in the storage, in milliseconds. A timestamp of the user creation in the storage, in milliseconds.

example

1518630727683

customFields

customFields: object

User's account-specific custom properties. The value is a string.

Type declaration

  • [key: string]: string

email

email: string

The email address.

example

user@arm.com

emailVerified

emailVerified: boolean

A flag indicating whether the user's email address has been verified or not. A flag indicating whether the user's email address has been verified or not.

example

true

fullName

fullName: string

The full name of the user.

example

User Doe

groups

groups: Array<string>

A list of group IDs this user belongs to.

id

id: string

The unique identifier of the entity

isGtcAccepted

isGtcAccepted: boolean

A flag indicating that the user has accepted General Terms and Conditions.

example

true

isMarketingAccepted

isMarketingAccepted: boolean

A flag indicating that the user has consented to receive marketing information.

example

true

isTotpEnabled

isTotpEnabled: boolean

A flag indicating whether two-factor authentication (TOTP) has been enabled.

example

true

lastLoginTime

lastLoginTime: number

A timestamp of the latest login of the user, in milliseconds. A timestamp of the latest login of the user, in milliseconds.

example

1518630727688

loginHistory

loginHistory: Array<LoginHistory>

Represents an entry in login history. History of logins for this user.

loginProfiles

loginProfiles: Array<LoginProfile>

Represents a user login profile in Device Management.

marketingAccepted

marketingAccepted: boolean

A flag indicating that receiving marketing information has been accepted.

password

password: string

The password when creating a new user. It will be generated when not present in the request.

example

PZf9eEUH43DAPE9ULINFeuj

passwordChangedTime

passwordChangedTime: number

A timestamp of the latest change of the user password, in milliseconds. A timestamp of the latest change of the user password, in milliseconds.

example

1518630727688

phoneNumber

phoneNumber: string

Phone number.

example

+44 (1223) 400 400

status

The status of the user. ENROLLING state indicates that the user is in the middle of the enrollment process. INVITED means that the user has not accepted the invitation request. RESET means that the password must be changed immediately. INACTIVE users are locked out and not permitted to use the system. The status of the user. INVITED means that the user has not accepted the invitation request. RESET means that the password must be changed immediately.

example

ACTIVE

termsAccepted

termsAccepted: boolean

A flag indicating that the General Terms and Conditions has been accepted.

totpScratchCodes

totpScratchCodes: Array<string>

totpScratchCodes

twoFactorAuthentication

twoFactorAuthentication: boolean

Whether two factor authentication has been enabled for this user.

updatedAt

updatedAt: Date

Last update UTC time RFC3339.

example

2018-02-14T15:24:14Z

username

username: string

A username.

example

admin

Methods

delete

  • delete(): Promise<void>
  • Delete the user

    Returns Promise<void>

    Promise containing any error

  • Delete the user

    Parameters

    • callback: CallbackFn<void>

      A function that is passed any error

    Returns void

listApiKeys

  • List the API keys for this user

    Parameters

    Returns Promise<ListResponse<ApiKey>>

    Promise containing API keys

  • List the API keys for this user

    Parameters

    Returns void

listGroups

  • listGroups(): Promise<Array<Group>>
  • List the groups this user belongs to

    Returns Promise<Array<Group>>

    Promise containing groups

  • List the groups this user belongs to

    Parameters

    • callback: CallbackFn<Array<Group>>

      A function that is passed the return arguments (error, groups)

    Returns void

update

  • update(): Promise<User>
  • Updates the user

    Returns Promise<User>

    Promise containing user

  • Updates the user

    Parameters

    • callback: CallbackFn<User>

      A function that is passed the return arguments (error, user)

    Returns void