partition-admin

Partition admin user configuration

partition-admin Specification

   
Type Collection
Object Key(s) user
Collection Name partition-admin-list
Collection URI /axapi/v3/partition-admin
Element Name partition-admin
Element URI /axapi/v3/partition-admin/{user}
Element Attributes partition-admin_attributes
Schema partition-admin schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/partition-admin

partition-admin attributes

Create List

POST

/axapi/v3/partition-admin

partition-admin attributes

Get Object

GET

/axapi/v3/partition-admin/{user}

partition-admin attributes

Get List

GET

/axapi/v3/partition-admin

partition-admin-list

Modify Object

POST

/axapi/v3/partition-admin/{user}

partition-admin attributes

Replace Object

PUT

/axapi/v3/partition-admin/{user}

partition-admin attributes

Replace List

PUT

/axapi/v3/partition-admin

partition-admin-list

Delete Object

DELETE

/axapi/v3/partition-admin/{user}

partition-admin attributes

partition-admin-list

partition-admin-list is JSON List of partition-admin attributes

partition-admin-list : [

partition-admin attributes

access-list

Description Specify an ACL to classify a trusted host

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: access-list and trusted-host-cidr are mutually exclusive

access-type

Description

Type: string

Format: enum-list

Default: axapi,cli,web

action

Description ‘enable’: Enable user; ‘disable’: Disable user;

Type: string

Supported Values: enable, disable

Default: enable

passwd-string

Description Config admin user password

Type: string

Format: password

Maximum Length: platform specific characters

Maximum Length: platform specific characters

password

Description: password is a JSON Block. Please see below for password

Type: Object

Refernce Object: /axapi/v3/partition-admin/{user}/password

password-key

Description Config admin user password

Type: boolean

Supported Values: true, false, 1, 0

privilege-list

Type: List

trusted-host

Description Set trusted network administrator can login in

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

trusted-host-acl-id

Description ACL ID

Type: number

Range: 1-99

trusted-host-cidr

Description Trusted IP Address with network mask

Type: string

Format: ipv4-cidr

Mutual Exclusion: trusted-host-cidr and access-list are mutually exclusive

unlock

Description Unlock admin user

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user

Description Partition admin user name

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

privilege-list

Specification  
Type list
Block object keys  

privilege-partition

Description ‘partition-enable-disable’: Set per-partition enable/disable privilege; ‘partition-read’: Set per-partition read privilege; ‘partition-write’: Set per-partition write privilege;

Type: string

Supported Values: partition-enable-disable, partition-read, partition-write

password

Specification  
Type object

encrypted-in-module

Description Specify an ENCRYPTED password string (System admin user password)

password-in-module

Description Config admin user password

Type: string

Format: password

Maximum Length: platform specific characters

Maximum Length: platform specific characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters