{ "id":"/axapi/v3/admin/{user}", "type":"object", "node-type":"list", "title":"admin", "partition-visibility":"shared", "description":"System admin user configuration", "properties":{ "user":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"System admin user name", "optional":false }, "password-key":{ "type":"number", "format":"flag", "platform-specific-default":1, "partition-visibility":"shared", "description":"Config admin user password", "optional":true }, "passwd-string":{ "type":"string", "format":"password", "platform-specific-range":1, "platform-specific-default":1, "partition-visibility":"shared", "description":"Config admin user password", "optional":true }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Specify an ENCRYPTED password string (System admin user password)", "optional":true }, "action":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'enable': Enable user; 'disable': Disable user; ", "enum":[ "enable", "disable" ], "optional":true }, "trusted-host":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set trusted network administrator can login in", "optional":true }, "trusted-host-cidr":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "not":"access-list", "description":"Trusted IP Address with network mask", "optional":true }, "access-list":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"trusted-host-cidr", "description":"Specify an ACL to classify a trusted host", "optional":true }, "trusted-host-acl-id":{ "type":"number", "format":"number", "minimum":1, "maximum":99, "partition-visibility":"shared", "description":"ACL ID", "optional":true }, "privilege-global":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'read': Set read privilege; 'write': Set write privilege; 'hm': Set external health monitor script content operations privilege; ", "enum":[ "read", "write", "hm" ], "optional":true }, "privilege-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "privilege-partition":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'partition-enable-disable': Set per-partition enable/disable privilege; 'partition-read': Set per-partition read privilege; 'partition-write': Set per-partition write privilege; ", "enum":[ "partition-enable-disable", "partition-read", "partition-write" ] }, "partition-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref-list":["/axapi/v3/partition", "/axapi/v3/service-partition"], "description":"Partition Name" } } } ] }, "privilege-shell-root":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set shell root privilege", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "aws-accesskey":{ "type":"object", "$ref":"/axapi/v3/admin/{user}/aws-accesskey", "properties":{ "import":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Import an aws-accesskey" }, "use-mgmt-port":{ "type":"number", "format":"flag", "plat-neg-list":["softax-aws"], "default":0, "partition-visibility":"shared", "description":"Use management port as source port" }, "file-url":{ "type":"string", "format":"url", "partition-visibility":"shared", "description":"File URL" }, "delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete an authorized aws accesskey" }, "show":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Show authorized aws accesskey" } } }, "azure-cred":{ "type":"object", "$ref":"/axapi/v3/admin/{user}/azure-cred", "properties":{ "import":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Import an azure-credentials" }, "use-mgmt-port":{ "type":"number", "format":"flag", "plat-pos-list":["softax-azure"], "default":0, "partition-visibility":"shared", "description":"Use management port as source port" }, "file-url":{ "type":"string", "format":"url", "partition-visibility":"shared", "description":"File URL" }, "delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete an authorized Azure credentials" }, "show":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Show authorized azure credentials" } } }, "gcp-cred":{ "type":"object", "$ref":"/axapi/v3/admin/{user}/gcp-cred", "properties":{ "import":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Import an GCP-credentials" }, "use-mgmt-port":{ "type":"number", "format":"flag", "plat-pos-list":["softax-gcp"], "default":0, "partition-visibility":"shared", "description":"Use management port as source port" }, "file-url":{ "type":"string", "format":"url", "partition-visibility":"shared", "description":"File URL" }, "delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete an authorized GCP credentials" }, "show":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Show authorized GCP credentials" } } }, "cloud-cred":{ "type":"object", "$ref":"/axapi/v3/admin/{user}/cloud-cred", "properties":{ "type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'aws-cred': aws-cred; 'aws-config': aws-config; 'azure-cred': azure-cred; 'vmware-cred': vmware-cred; ", "enum":[ "aws-cred", "aws-config", "azure-cred", "vmware-cred" ] }, "import":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Import an Cloud-Cred and Cloud-Config" }, "use-mgmt-port":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use management port as source port" }, "file-url":{ "type":"string", "format":"url", "partition-visibility":"shared", "description":"File URL" }, "delete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Delete an authorized cloud credentials and cloud configuration" }, "show":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Show authorized cloud credentials and cloud configuration" } } }, "ssh-pubkey":{ "type":"object", "$ref":"/axapi/v3/admin/{user}/ssh-pubkey", "properties":{ "import":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Import an authorized public key" }, "use-mgmt-port":{ "type":"number", "format":"flag", "plat-neg-list":["softax-aws"], "default":0, "partition-visibility":"shared", "description":"Use management port as source port" }, "file-url":{ "type":"string", "format":"url", "partition-visibility":"shared", "description":"File URL" }, "delete":{ "type":"number", "format":"number", "minimum":1, "maximum":1000000, "partition-visibility":"shared", "description":"Delete an authorized public key (SSH key index)" }, "list":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"List all authorized public keys" } } }, "access":{ "type":"object", "$ref":"/axapi/v3/admin/{user}/access", "properties":{ "access-type":{ "type":"string", "format":"enum-list", "default":"axapi,cli,web", "partition-visibility":"shared", "enum":[ "axapi", "cli", "web" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "password":{ "type":"object", "$ref":"/axapi/v3/admin/{user}/password", "properties":{ "password-in-module":{ "type":"string", "format":"password", "platform-specific-range":1, "platform-specific-default":1, "partition-visibility":"shared", "description":"Config admin user password" }, "encrypted-in-module":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Specify an ENCRYPTED password string (System admin user password)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "object-keys":[ "user" ], "required":[ "user" ] }