Documentation

Mistake on this page? Email us

This object represents a user in requests towards mbed Cloud.

Hierarchy

  • UserUpdateReq

Index

Properties

address

address: string

Address, not longer than 100 characters.

custom_fields

custom_fields: object

User's account specific custom properties, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.

Type declaration

  • [key: string]: string

email

email: string

The email address, not longer than 254 characters.

full_name

full_name: string

The full name of the user, not longer than 100 characters.

groups

groups: Array<string>

A list of group IDs this user belongs to.

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 to be enabled or disabled.

phone_number

phone_number: string

Phone number, not longer than 100 characters.

status

status: string

The status of the user.

username

username: string

A username containing alphanumerical letters and -,._@+= characters. It must be at least 4 but not more than 30 character long.