User Management
User Management APIs are used to create and manage users in the Arista server.
JSON Table
Attribute | Data Type | Description |
---|---|---|
userId | long | System-generated unique ID for the user. |
langId | int | The language selected by the user. All data on the AMC UI will be displayed in this language. Currently, the supported language is ENGLISH and the ID assigned to it is 0. |
customerId | long | System-generated customer ID for an Mojo Cloud Services user account. |
defaultPassword | boolean | This attribute is for future use. The default value is false. |
loginId | String | Login ID of the user. |
firstName | String | The first name of the user. |
lastName | String | The last name of the user. |
String | Email ID of the user. | |
role | String | Role assigned to the user account. The applicable values are:
|
timeZone | String | Time zone configured for the user account. |
timeZonOffSetInMins | int | Time zone offset from UTC (in mins). |
fontPref | String | Whether the system must support English-only or multi-byte characters. The applicable values are ENGLISH_ONLY and MULTILINGUAL. |
passwdSettings | application/json | Password settings for the user. |
passwdSettings/passwordExpires | boolean | A true or false value indicating that the password for this user can expire. If set to true, the ExpiryDateTime and ExpiryDaysInterval fields must be configured. |
passwdSettings/passwordExpiryDateTime | long | Date and time when the password will expire. |
passwdSettings/passwordExpiryDaysInterval | long | Number of days after which the password will expire. |
passwdSettings/passwordExpiryWarningDays | int | If the password will expire, the number of days by which the user wil be shown a warning for password expiry. |
logoutInterval | int | Minutes after which the user’s UI login session will expire. |
allowedLocations | application/json | List of locations that the user can access. |
allowedLocations/type | String | Location type. The only acceptable value is locallocationid. |
allowedLocations/id | int | System-generated unique ID of the location. |
userLockedState | String | Applicable values are:
|
userType | String | User type. The applicable values are:
|
allowAccessMgmt | boolean | A true or false value indicating whether the user has access to the Wi-Fi management functionality. |
allowSecurityMgmt | boolean | A true or false value indicating whether the user has access to the WIPS management functionality. |
temporaryLockDateTime | long | Duration for which the user account is temporarily locked due to incorrect login attempts. |
serviceOrSupportUser | boolean | For internal use only. |
userLanguage | application/json | Language details of the user. |
userLanguage/langId | int | System-generated unique ID for the user language. |
userLanguage/langCode | String | Language-specific display labels fetched from the property files. For example, en for English, ja for Japanese, zh for Chinese, etc. |
userLanguage/name | String | Display name of the user language. |
userLanguage/systemLanguage | boolean | A true or false value indicating whether the specified language is defined in the system. True indicates that the language is a system language. |
userLanguage/supported | boolean | A true or false value indicating whether the specified language is configured for the user in the AMC server. |
userLanguage/defaultLanguage | boolean | A true or false value indicating whether the language is a default language for the user. If the user is created without assigning a language, the default language is used. |
userLanguage/countryCode | String | Country code associated with the user language. For example, US for English, CN for China, TW for Taiwan, etc. |
passwordChangeEnforced | boolean | Whether the user must change password. |
userDefinedFields | application/json | A list of JSON values that include the name-value pairs of custom fields defined for a user. |
Copy Sample JSON
Sample JSON
{ "userId":1, "langId":0, "customerId":-1, "defaultPassword":false, "loginId":"admin", "firstName":"System", "lastName":"Superuser", "email":"", "role":"SUPERUSER", "timeZone":"America/New_York", "timezonOffSetInMins":0, "fontPref":"ENGLISH_ONLY", "passwdSettings":{ "passwordExpires":false, "passwordExpiryDateTime":0, "passwordExpiryDaysInterval":365, "passwordExpiryWarningDays":15 }, "logoutInterval":-1, "allowedLocations":[{ "type":"locallocationid", "id":0 }], "userLockedState":"NOT_LOCKED", "userType":"LOCAL", "allowAccessMgmt":true, "allowSecurityMgmt":true, "temporaryLockDateTime":0, "serviceOrSupportUser":false "userLanguage": { "langId": 0, "langCode": "en", "name": "English", "systemLanguage": true, "supported": true, "defaultLanguage": true, "countryCode": "US" }, "passwordChangeEnforced": false, "userDefinedFields":null }, { "userId":2, "langId":0, "customerId":10, "defaultPassword":false, "loginId":"test", "firstName":"test", "lastName":"test", "email":"[email protected]", "role":"POWERUSER", "timeZone":"America/New_York", "timezonOffSetInMins":0, "fontPref":"ENGLISH_ONLY", "passwdSettings":{ "passwordExpires":false, "passwordExpiryDateTime":0, "passwordExpiryDaysInterval":60, "passwordExpiryWarningDays":15 }, "logoutInterval":-1, "allowedLocations":[{ "type":"locallocationid", "id":13 }], "userLockedState":"NOT_LOCKED", "userType":"LOCAL", "allowAccessMgmt":true, "allowSecurityMgmt":true, "temporaryLockDateTime":0, "serviceOrSupportUser":false "userLanguage": { "langId": 0, "langCode": "en", "name": "English", "systemLanguage": true, "supported": true, "defaultLanguage": true, "countryCode": "US" }, "passwordChangeEnforced": false, "userDefinedFields":null }
API Calls
V5/users
V5/users/customfields
V5/users/current
/V3/users/features
V5/users
V5/users
V5/users/ownpassword
V5/users/{userid}