RESTAPI Manual
Security
User Management
11 min
urls summary urls summary url get post patch put delete /rest/v1/running/linux password policy y n y n n /rest/v1/running/linux user y n y n n /rest/v1/running/linux user policy y n y n n /rest/v1/running/linux user/user/{name} y y y n y examples examples modify linux password policy modify linux password policy patch https //{switch ip}/rest/v1/running/linux password policy { "expiration time" 66, "min length" 9, "enabled" "false" } get all linux users information get all linux users information get https //{switch ip}/rest/v1/running/linux user modify linux user policy modify linux user policy patch https //{switch ip}/rest/v1/running/linux user policy { "enabled" "false", "retry count" 3, "lock time" 300, "session hold time" 600 } create a linux user create a linux user post https //{switch ip}/rest/v1/running/linux user/user { "name" "test99", "password" "123456", "privilege level" "config" } properties descriptions properties descriptions linux user policy linux user policy tree diagrams + rw linux user policy \| + rw enabled? \| + rw retry count? \| + rw lock time? \| + rw session hold time? table of properties name required type/range description linux user policy m path only node, has no configurable value linux user policy enabled o "true" "false" (sub property of linux user policy) linux user policy state, default is false default value "false" retry count o 2 99 (sub property of linux user policy) maximum number of password attempts, default is 3 default value 3 lock time o 60 99999 (sub property of linux user policy) the lockout time after the maximum number of incorrect passwords is reached, default is 300s default value 300 session hold time o 0 60 99999 (sub property of linux user policy) how long the terminal stays connected, default is 600s default value 600 linux users linux users tree diagrams + rw linux user \| + rw user \[name] \| + rw name \| + rw password? \| + rw cipher password? \| + rw privilege level? table of properties name required type/range description linux user m path only node, has no configurable value linux user user m (sub property of linux user) path only node, has no configurable value the list of user in linux name m a letter, followed by up to 31 letters, digits, or underscores (sub property of user) linux user name password o string (sub property of user) linux user's password cipher password o string (sub property of user) linux user's cipher password privilege level o "none" "show" "config" "sys admin" (sub property of user) linux user privilege level default value "none" linux passwork policy linux passwork policy tree diagrams + rw linux password policy + ro include digit? + ro include lowercase? + ro include uppercase? + ro include special? + rw expiration time? + ro expiration warning time? + ro history password count? + rw min length? + ro vague hint? + rw enabled? table of properties name required type/range description linux password policy m path only node, has no configurable value linux user password policy include digit ro "true" "false" (sub property of linux password policy) password should contain numbers default value "true" include lowercase ro "true" "false" (sub property of linux password policy) password should contain lowercase letters default value "true" include uppercase ro "true" "false" (sub property of linux password policy) password should contain uppercase letters default value "true" include special ro "true" "false" (sub property of linux password policy) password should contain special letters default value "true" expiration time o 30 365 (sub property of linux password policy) password expiration days default value 180 expiration warning time ro 1 30 (sub property of linux password policy) prompt password expiration n days in advance default value 15 history password count ro 1 100 (sub property of linux password policy) num of old password that the system will recorded default value 10 min length o 6 32 (sub property of linux password policy) minimum password length default value 8 vague hint ro "true" "false" (sub property of linux password policy) no prompt is given for username error or password error default value "true" enabled o "true" "false" (sub property of linux password policy) state of the feature default value "false"
