Documentation

Mistake on this page? Email us

This object represents a user in mbed Cloud.

Index

Type aliases

ObjectEnum

ObjectEnum: "user"

StatusEnum

StatusEnum: "ENROLLING" | "INVITED" | "ACTIVE" | "RESET" | "INACTIVE"

Properties

account_id

account_id: string

The UUID of the account.

address

address: string

Address.

created_at

created_at: Date

Creation UTC time RFC3339.

creation_time

creation_time: number

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

custom_fields

custom_fields: object

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

Type declaration

  • [key: string]: string

email

email: string

The email address.

email_verified

email_verified: boolean

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

etag

etag: string

API resource entity version.

full_name

full_name: string

The full name of the user.

groups

groups: Array<string>

A list of IDs of the groups this user belongs to.

id

id: string

The UUID of the user.

is_gtc_accepted

is_gtc_accepted: boolean

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

is_marketing_accepted

is_marketing_accepted: boolean

A flag indicating that receiving marketing information has been accepted.

is_totp_enabled

is_totp_enabled: boolean

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

last_login_time

last_login_time: number

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

login_history

login_history: Array<LoginHistory>

Timestamps, succeedings, IP addresses and user agent information of the last five logins of the user, with timestamps in RFC3339 format.

object

object: ObjectEnum

Entity name: always 'user'

password

password: string

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

password_changed_time

password_changed_time: number

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

phone_number

phone_number: string

Phone number.

status

status: StatusEnum

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.

updated_at

updated_at: Date

Last update UTC time RFC3339.

username

username: string

A username containing alphanumerical letters and -,._@+= characters.