{ "restSchemaVersion": "1.0", "errors": [ { "error_id": "PARTIAL_CONTENT", "description": "Operation was partially successfull.", "http_status": "206" }, { "error_id": "BAD_REQUEST", "description": "Invalid argument.", "http_status": "400" }, { "error_id": "AUTH_REQUIRED", "description": "Authentication required.", "http_status": "401" }, { "error_id": "AUTH_INVALID_CREDENTIALS", "description": "Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.", "http_status": "401" }, { "error_id": "INTERNAL_ERROR", "description": "Internal error.", "http_status": "500" } ], "name": "mgmt.users_config", "title": "Security Compliance - Configure Users passwords, Inactivity Timeout API, Password requirements & Login Settings.", "version": "1.0", "schemas": [], "defaultAuthorization": "required", "servicePath": "/api/mgmt.users_config/1.0", "resources": { "Users": { "methods": { "Display Users Detail": { "description": "Display Web(local)/Shell User details.", "formats": [ "json" ], "httpmethod": "GET", "path": "users", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Web(local)/Shell Users detail.", "items": { "description": "Web(local)/Shell User detail.", "required": true, "properties": { "username": { "description": "Web(local) or Shell username.", "required": true, "type": "string" }, "user_enabled": { "description": "Displays user is enabled or not.", "required": true, "type": "string" }, "current_password": { "description": "Always hidden with asterisks.", "required": true, "type": "string" }, "user_type": { "description": "Displays if a user is of type web(local) or shell.", "required": true, "type": "string" } }, "id": "user", "type": "object" }, "id": "users", "type": "array", "example": [ { "username": "mazu", "user_enabled": "True", "current_password": "********", "user_type": "shell" }, { "username": "admin", "user_enabled": "True", "current_password": "********", "user_type": "shell" }, { "username": "root", "user_enabled": "True", "current_password": "********", "user_type": "shell" }, { "username": "dhcp", "user_enabled": "True", "current_password": "********", "user_type": "shell" }, { "username": "admin", "user_enabled": "True", "current_password": "********", "user_type": "web" } ] }, "authorization": "required" }, "Configure User Password": { "description": "Resets Web(local)/Shell Users password.", "formats": [ "json" ], "httpmethod": "POST", "path": "users", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "List of Web(local)/Shell Users details for which password needs to be reset.", "items": { "description": "Web(local)/Shell User details for which password needs to be reset.", "required": true, "properties": { "username": { "description": "Web(local)/Shell username.", "required": true, "type": "string" }, "user_enabled": { "description": "User is enabled or not.", "required": true, "type": "string" }, "current_password": { "description": "Current password can be empty for web users.", "required": true, "type": "string" }, "new_password": { "description": "New password should be in plain text.", "required": true, "type": "string" }, "user_type": { "description": "User is of type shell/web.", "required": true, "type": "string" } }, "id": "user", "type": "object" }, "id": "users", "type": "array", "example": [ { "username": "mazu", "user_enabled": "True", "current_password": "abcdef", "new_password": "qwerty", "user_type": "shell" }, { "username": "admin", "user_enabled": "True", "current_password": "", "new_password": "bb!xiops", "user_type": "web" } ] }, "authorization": "required" } } }, "Inactivity Timeout": { "methods": { "Display Settings": { "description": "Display Inactivity Timeout Settings.", "formats": [ "json" ], "httpmethod": "GET", "path": "inactivity_timeout", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Inactivity Timeout Settings.", "items": { "description": "Inactivity timeout settings.", "required": true, "properties": { "inactivity_timeout_enabled": { "description": "Inactivity timeout is in enabled/disabled state.", "required": true, "type": "string" }, "inactivity_timeout": { "description": "Inactivity timeout value in minutes.", "required": true, "type": "string" } }, "id": "setting", "type": "object" }, "id": "settings", "type": "array", "example": [ { "inactivity_timeout_enabled": "false", "inactivity_timeout": "2" } ] }, "authorization": "required" }, "Configure Settings": { "description": "Configure Inactivity Timeout Settings.", "formats": [ "json" ], "httpmethod": "POST", "path": "inactivity_timeout", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "List of Web(local)/Shell Users details for which password needs to be reset.", "items": { "description": "Inactivity timeout settings.", "required": true, "properties": { "inactivity_timeout_enabled": { "description": "Inactivity timeout is in enabled/disabled state.", "required": true, "type": "string" }, "inactivity_timeout": { "description": "Inactivity timeout value in minutes.", "required": true, "type": "string" } }, "id": "setting", "type": "object" }, "id": "settings", "type": "array", "example": [ { "inactivity_timeout_enabled": "true", "inactivity_timeout": "2" } ] }, "authorization": "required" } } }, "Password Requirements": { "methods": { "Display Settings": { "description": "Display Password Requirement Settings.", "formats": [ "json" ], "httpmethod": "GET", "path": "password_requirements", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Password Requirement Settings.", "items": { "description": "Password Requirement settings.", "required": true, "properties": { "Minimum number of characters": { "description": "Minimum number of characters in integer format.", "required": true, "type": "number" }, "Require mixed case": { "description": "Require mixed case value as true/false.", "required": true, "type": "string" }, "Require non-alphanumeric characters": { "description": "Require non-alphanumeric characters value as true/false.", "required": true, "type": "string" }, "Number of passwords to remember to prevent repeats": { "description": "Number of passwords to remember to prevent repeats value in integer format.", "required": true, "type": "number" }, "Enable password aging": { "description": "Enable password aging value as true/false.", "required": true, "type": "string" }, "Number of days before password expiration": { "description": "Number of days before password expiration in integer format.", "required": true, "type": "number" } }, "id": "setting", "type": "object" }, "id": "settings", "type": "array", "example": [ { "Minimum number of characters": 6, "Require mixed case": "false", "Require non-alphanumeric characters": "false", "Number of passwords to remember to prevent repeats": 1, "Enable password aging": "false", "Number of days before password expiration": 0 } ] }, "authorization": "required" }, "Configure Settings": { "description": "Configure Password Requirement Settings.", "formats": [ "json" ], "httpmethod": "POST", "path": "password_requirements", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "Password Requirement Settings that need to be configured.", "items": { "description": "Password Requirement settings.", "required": true, "properties": { "Minimum number of characters": { "description": "Minimum number of characters in integer format.", "required": true, "type": "number" }, "Require mixed case": { "description": "Require mixed case value as true/false.", "required": true, "type": "string" }, "Require non-alphanumeric characters": { "description": "Require non-alphanumeric characters value as true/false.", "required": true, "type": "string" }, "Number of passwords to remember to prevent repeats": { "description": "Number of passwords to remember to prevent repeats value in integer format.", "required": true, "type": "number" }, "Enable password aging": { "description": "Enable password aging value as true/false.", "required": true, "type": "string" }, "Number of days before password expiration": { "description": "Number of days before password expiration in integer format.", "required": true, "type": "number" } }, "id": "setting", "type": "object" }, "id": "settings", "type": "array", "example": [ { "Minimum number of characters": 6, "Require mixed case": "false", "Require non-alphanumeric characters": "false", "Number of passwords to remember to prevent repeats": 1, "Enable password aging": "false", "Number of days before password expiration": 0 } ] }, "authorization": "required" } } }, "Login Settings": { "methods": { "Display Settings": { "description": "Display Login Settings.", "formats": [ "json" ], "httpmethod": "GET", "path": "login_settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Login Settings.", "items": { "description": "Login settings.", "required": true, "properties": { "Allow only one log-in per user name/password combination": { "description": "Allow only one log-in per user name/password combination value as true/false.", "required": true, "type": "string" }, "Force password change on first log-in": { "description": "Force password change on first log-in value as true/false.", "required": true, "type": "string" }, "Number of log-in attempts before account is locked": { "description": "Number of log-in attempts before account is locked value in integer format.", "required": true, "type": "number" }, "Number of minutes to keep an account locked": { "description": "Number of minutes to keep an account locked value in integer format.", "required": true, "type": "number" }, "Prevent user 'admin' from being locked out via DoS attack": { "description": "Prevent user 'admin' from being locked out via DoS attack value as true/false.", "required": true, "type": "string" }, "Log-in splash screen display": { "description": "Log-in splash screen display in integer format.", "required": true, "type": "number" }, "Log-in text": { "description": "Log-in text value as true/false.", "required": true, "type": "string" } }, "id": "setting", "type": "object" }, "id": "settings", "type": "array", "example": [ { "Allow only one log-in per user name/password combination": "false", "Force password change on first log-in": "false", "Number of log-in attempts before account is locked": 3, "Number of minutes to keep an account locked": 30, "Prevent user 'admin' from being locked out via DoS attack": "false", "Log-in splash screen display": 0, "Log-in text": "Welcome" } ] }, "authorization": "required" }, "Configure Settings": { "description": "Configure Login Settings.", "formats": [ "json" ], "httpmethod": "POST", "path": "login_settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "Login Settings that need to be configured.", "items": { "description": "Login settings.", "required": true, "properties": { "Allow only one log-in per user name/password combination": { "description": "Allow only one log-in per user name/password combination value as true/false.", "required": true, "type": "string" }, "Force password change on first log-in": { "description": "Force password change on first log-in value as true/false.", "required": true, "type": "string" }, "Number of log-in attempts before account is locked": { "description": "Number of log-in attempts before account is locked value in integer format.", "required": true, "type": "number" }, "Number of minutes to keep an account locked": { "description": "Number of minutes to keep an account locked value in integer format.", "required": true, "type": "number" }, "Prevent user 'admin' from being locked out via DoS attack": { "description": "Prevent user 'admin' from being locked out via DoS attack value as true/false.", "required": true, "type": "string" }, "Log-in splash screen display": { "description": "Log-in splash screen display in integer format.", "required": true, "type": "number" }, "Log-in text": { "description": "Log-in text value as true/false.", "required": true, "type": "string" } }, "id": "setting", "type": "object" }, "id": "settings", "type": "array", "example": [ { "Allow only one log-in per user name/password combination": "false", "Force password change on first log-in": "false", "Number of log-in attempts before account is locked": 3, "Number of minutes to keep an account locked": 30, "Prevent user 'admin' from being locked out via DoS attack": "false", "Log-in splash screen display": 0, "Log-in text": "Welcome" } ] }, "authorization": "required" } } }, "Banner Image": { "methods": { "Upload Banner Image": { "description": "Only supported image type can be passed as a binary object", "httpmethod": "PUT", "path": "banner_image", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get Banner Image Settings": { "description": "Fetch the Banner Image display settings", "httpmethod": "GET", "path": "banner_image/settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "The current banner settings.", "items": { "description": "Banner settings.", "required": true, "properties": { "login_banner_text": { "description": "Text to be displayed when a user logs in via the console.", "required": true, "type": "string" }, "banner_file": { "description": "The name of the current banner file.", "required": true, "type": "string" }, "banner_display": { "description": "The current banner display setting. Can be: No Splash Screen, 5 second auto-display, or Show until Acknowledged", "required": true, "type": "string" }, "banner_size": { "description": "width and height of current banner file.", "required": true, "type": "string" } }, "id": "banner_setting", "type": "object" }, "id": "banner_settings", "type": "object", "example": { "login_banner_text": "This is a test banner", "banner_file": "banner_yeycfid7.jpg", "banner_display": "5 second auto-display", "banner_size": "width=\"900\" height=\"360\"" } }, "authorization": "required" }, "Set Banner Image Settings": { "description": "Set the Banner Image display settings", "httpmethod": "POST", "path": "banner_image/settings", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Configure banner settings.", "items": { "description": "Banner settings.", "required": true, "properties": { "login_banner_text": { "description": "Text to be displayed when a user logs in via the console.", "required": true, "type": "string" }, "banner_display": { "description": "The current banner display setting. Can be: No Splash Screen, 5 second auto-display, or Show until Acknowledged", "required": true, "type": "string" } }, "id": "banner_setting", "type": "object" }, "id": "banner_settings", "type": "object", "example": { "login_banner_text": "This is a test banner", "banner_display": "5 second auto-display" } }, "authorization": "required" } } } }, "description": "

Overview

\n\n

\nThe documentation pages in this section describe\nthe RESTful APIs included with NetProfiler products. It is assumed \nthat the reader has practical knowledge of\nRESTful APIs, so the documentation does not go into detail about what\nREST is and how to use it. Instead the documentation focuses on how\nto reset user password, view user details, how to view and configure inactivity timeout settings.\n

\n\n

\nThe following operations can be performed via the API:\n

\n\n\n

\nDetails about REST resources can be found in the Resources\nsection. This overview continues with how to run these API's.\n

\n\n

Authentication

\n\n

\nAll REST requests must be authenticated. The Authentication\nsection of the Common API describes which authentication methods\nare presently supported. \n

\n\n" }