# RainbowAdminPortal.PutUsers

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**loginEmail** | **String** | User email address (used for login).    Must be unique (409 error is returned if a user already exists with the same email address). | [optional] 
**password** | **String** | User password.    Rules: more than 8 characters, at least 1 capital letter, 1 number, 1 special character. | [optional] 
**phoneNumbers** | [**[PutUsersPhoneNumbers]**](PutUsersPhoneNumbers.md) | Array of user PhoneNumbers objects       _Notes:_* Provided PhoneNumbers data overwrite previous values:    * PhoneNumbers which are not known on server side are added,   * PhoneNumbers which are changed are updated,   * PhoneNumbers which are not provided but existed on server side are deleted.   * This does not applies to PhoneNumbers linked to a system(pbx), which can only be updated (addition and deletion of system PhoneNumbers are ignored). * When number is present, the server tries to compute the associated E.164 number (`numberE164` field) using provided PhoneNumber country if available, user country otherwise. If `numberE164` can't be computed, an error 400 is returned (ex: wrong phone number, phone number not matching country code, ...) * PhoneNumber linked to a system (pbx) can also be updated. In that case, `shortNumber` and `systemId` of the existing system PhoneNumber must be provided with the fields to update (see example bellow). * System phoneNumbers can't be created nor deleted using this API, only PCG can create/delete system PhoneNumbers.   | [optional] 
**firstName** | **String** | User first name | [optional] 
**lastName** | **String** | User last name | [optional] 
**nickName** | **String** | User nickName | [optional] 
**title** | **String** | User title (honorifics title, like Mr, Mrs, Sir, Lord, Lady, Dr, Prof,...) | [optional] 
**jobTitle** | **String** | User job title | [optional] 
**emails** | [**[PutUsersEmails]**](PutUsersEmails.md) | Array of user emails addresses objects | [optional] 
**country** | **String** | User country (ISO 3166-1 alpha3 format) | [optional] 
**state** | **String** | When country is 'USA' or 'CAN', a state can be defined. Else it is not managed.    USA states code list: `AA`:\"Armed Forces America\", `AE`:\"Armed Forces\", `AP`:\"Armed Forces Pacific\", `AK`:\"Alaska\", `AL`:\"Alabama\", `AR`:\"Arkansas\", `AZ`:\"Arizona\", `CA`:\"California\", `CO`:\"Colorado\", `CT`:\"Connecticut\", `DC`:\"Washington DC\", `DE`:\"Delaware\", `FL`:\"Florida\", `GA`:\"Georgia\", `GU`:\"Guam\", `HI`:\"Hawaii\", `IA`:\"Iowa\", `ID`:\"Idaho\", `IL`:\"Illinois\", `IN`:\"Indiana\", `KS`:\"Kansas\", `KY`:\"Kentucky\", `LA`:\"Louisiana\", `MA`:\"Massachusetts\", `MD`:\"Maryland\", `ME`:\"Maine\", `MI`:\"Michigan\", `MN`:\"Minnesota\", `MO`:\"Missouri\", `MS`:\"Mississippi\", `MT`:\"Montana\", `NC`:\"North Carolina\", `ND`:\"North Dakota\", `NE`:\"Nebraska\", `NH`:\"New Hampshire\", `NJ`:\"New Jersey\", `NM`:\"New Mexico\", `NV`:\"Nevada\", `NY`:\"New York\", `OH`:\"Ohio\", `OK`:\"Oklahoma\", `OR`:\"Oregon\", `PA`:\"Pennsylvania\", `PR`:\"Puerto Rico\", `RI`:\"Rhode Island\", `SC`:\"South Carolina\", `SD`:\"South Dakota\", `TN`:\"Tennessee\", `TX`:\"Texas\", `UT`:\"Utah\", `VA`:\"Virginia\", `VI`:\"Virgin Islands\", `VT`:\"Vermont\", `WA`:\"Washington\", `WI`:\"Wisconsin\", `WV`:\"West Virginia\", `WY`:\"Wyoming\"    Canada states code list: `AB`: \"Alberta\", `BC`: \"British Columbia\", `MB`: \"Manitoba\", `NB`: \"New Brunswick\", `NL`: \"Newfoundland and Labrador\", `NS`: \"Nova Scotia\", `NT`: \"Northwest Territories\", `NU`: \"Nunavut\", `ON`: \"Ontario\", `PE`: \"Prince Edward Island\", `QC`: \"Quebec\", `SK`: \"Saskatchewan\", `YT`: \"Yukon\"  | [optional] 
**language** | **String** | User language       Language format is composed of locale using format `ISO 639-1`, with optionally the regional variation using `ISO 3166‑1 alpha-2` (separated by hyphen).    Locale part is in lowercase, regional part is in uppercase. Examples: en, en-US, fr, fr-FR, fr-CA, es-ES, es-MX, ...    More information about the format can be found on this [link][0].  [0]: https://en.wikipedia.org/wiki/Language_localisation#Language_tags_and_codes | [optional] 
**timezone** | **String** | User timezone name    Allowed values: one of the timezone names defined in [IANA tz database][0]   Timezone name are composed as follow: `Area/Location` (ex: Europe/Paris, America/New_York,...)  [0]: https://www.iana.org/time-zones | [optional] 
**accountType** | **String** | User subscription type | [optional] [default to 'free']
**roles** | **[String]** | List of user roles       The general rule is that a user must have the roles that the wants to assign to someone else.    Examples:   * an `admin` can add or remove the role `admin` to another user of the company(ies) he manages, * an `bp_admin` can add or remove the role `bp_admin` to another user of the company(ies) he manages, * an `app_superadmin` can add or remove the role `app_superadmin` to another user...  Here are some explanations regarding the roles available in Rainbow:   * `admin`, `bp_admin` and `bp_finance` roles are related to company management (and resources linked to companies, such as users, systems, subscriptions, ...). * `bp_admin` and `bp_finance` roles can only be set to users of a BP company (company with isBP=true). * `app_admin`, `app_support` and `app_superadmin` roles are related to application management. * `all_company_channels_admin`, `public_channels_admin` and `closed_channels_admin` roles are related to channels management. * Only `superadmin` can set `superadmin` and `support` roles to a user. * A user with admin rights (admin, bp_admin, superadmin) can't change his own roles, except for roles related to channels (`all_company_channels_admin`, `public_channels_admin` and `closed_channels_admin`).   | [optional] 
**adminType** | **String** | Mandatory if roles array contains `admin` role: specifies at which entity level the administrator has admin rights in the hierarchy ORGANIZATIONS/COMPANIES/SITES/SYSTEMS | [optional] 
**companyId** | **String** | User company unique identifier (like 569ce8c8f9336c471b98eda1)    companyName field is automatically filled on server side based on companyId. | [optional] 
**isActive** | **Boolean** | Is user active | [optional] [default to true]
**isInitialized** | **Boolean** | Is user initialized | [optional] [default to false]
**visibility** | **String** | User visibility (define if the user can be searched by users being in other company). * private: can be searched by users of his company only * public: can be searched by all users * none: Default value reserved for guest. Means 'can't be search inside or outside his company'   | [optional] 
**timeToLive** | **Number** | Duration in second to wait before automatically starting a user deletion from the creation date.    Once the timeToLive has been reached, the user won't be usable to use APIs anymore (error 401523). His account may then be deleted from the database at any moment.    Value -1 means timeToLive is disable (i.e. user account will not expire).    If created user has role `guest` and no timeToLive is provided, a default value of 172800 seconds is set (48 hours).    If created user does not have role `guest` and no timeToLive is provided, a default value of -1 is set (no expiration). | [optional] 
**authenticationType** | **String** | User authentication type (if not set company default authentication will be used) | [optional] 



## Enum: StateEnum


* `null` (value: `"null"`)

* `AA` (value: `"AA"`)

* `AE` (value: `"AE"`)

* `AP` (value: `"AP"`)

* `AK` (value: `"AK"`)

* `AL` (value: `"AL"`)

* `AR` (value: `"AR"`)

* `AZ` (value: `"AZ"`)

* `CA` (value: `"CA"`)

* `CO` (value: `"CO"`)

* `CT` (value: `"CT"`)

* `DC` (value: `"DC"`)

* `DE` (value: `"DE"`)

* `FL` (value: `"FL"`)

* `GA` (value: `"GA"`)

* `GU` (value: `"GU"`)

* `HI` (value: `"HI"`)

* `IA` (value: `"IA"`)

* `ID` (value: `"ID"`)

* `IL` (value: `"IL"`)

* `IN` (value: `"IN"`)

* `KS` (value: `"KS"`)

* `KY` (value: `"KY"`)

* `LA` (value: `"LA"`)

* `MA` (value: `"MA"`)

* `MD` (value: `"MD"`)

* `ME` (value: `"ME"`)

* `MI` (value: `"MI"`)

* `MN` (value: `"MN"`)

* `MO` (value: `"MO"`)

* `MS` (value: `"MS"`)

* `MT` (value: `"MT"`)

* `NC` (value: `"NC"`)

* `ND` (value: `"ND"`)

* `NE` (value: `"NE"`)

* `NH` (value: `"NH"`)

* `NJ` (value: `"NJ"`)

* `NM` (value: `"NM"`)

* `NV` (value: `"NV"`)

* `NY` (value: `"NY"`)

* `OH` (value: `"OH"`)

* `OK` (value: `"OK"`)

* `OR` (value: `"OR"`)

* `PA` (value: `"PA"`)

* `PR` (value: `"PR"`)

* `RI` (value: `"RI"`)

* `SC` (value: `"SC"`)

* `SD` (value: `"SD"`)

* `TN` (value: `"TN"`)

* `TX` (value: `"TX"`)

* `UT` (value: `"UT"`)

* `VA` (value: `"VA"`)

* `VI` (value: `"VI"`)

* `VT` (value: `"VT"`)

* `WA` (value: `"WA"`)

* `WI` (value: `"WI"`)

* `WV` (value: `"WV"`)

* `WY` (value: `"WY"`)

* `AB` (value: `"AB"`)

* `BC` (value: `"BC"`)

* `MB` (value: `"MB"`)

* `NB` (value: `"NB"`)

* `NL` (value: `"NL"`)

* `NS` (value: `"NS"`)

* `NT` (value: `"NT"`)

* `NU` (value: `"NU"`)

* `ON` (value: `"ON"`)

* `PE` (value: `"PE"`)

* `QC` (value: `"QC"`)

* `SK` (value: `"SK"`)

* `YT` (value: `"YT"`)





## Enum: AccountTypeEnum


* `free` (value: `"free"`)

* `basic` (value: `"basic"`)

* `advanced` (value: `"advanced"`)





## Enum: AdminTypeEnum


* `organization_admin` (value: `"organization_admin"`)

* `company_admin` (value: `"company_admin"`)

* `site_admin` (value: `"site_admin"`)





## Enum: VisibilityEnum


* `private` (value: `"private"`)

* `public` (value: `"public"`)

* `none` (value: `"none"`)





## Enum: AuthenticationTypeEnum


* `DEFAULT` (value: `"DEFAULT"`)

* `RAINBOW` (value: `"RAINBOW"`)

* `SAML` (value: `"SAML"`)