rba

Role-Based Access Control (RBA) configuration. This feature supports the creation of multiple users, groups, and roles with varying degrees of permissions. RBA can limit the read/write privileges on different partitions and for different objects.

rba Specification

Type Configuration Resource
Element Name rba
Element URI /axapi/v3/rba
Element Attributes rba_attributes
Schema rba schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/rba

rba Attributes

Get Object

GET

/axapi/v3/rba

rba Attributes

Modify Object

POST

/axapi/v3/rba

rba Attributes

Replace Object

PUT

/axapi/v3/rba

rba Attributes

Delete Object

DELETE

/axapi/v3/rba

rba Attributes

rba Attributes

action

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

Type: string

Supported Values: enable, disable

Default: disable

group-list

Description: group-list is a JSON List . Please see below for group-list

Type: List

Reference Object: /axapi/v3/rba/group/{name}

role-list

Description: role-list is a JSON List . Please see below for role-list

Type: List

Reference Object: /axapi/v3/rba/role/{name}

user-list

Description: user-list is a JSON List . Please see below for user-list

Type: List

Reference Object: /axapi/v3/rba/user/{name}

uuid

Description: uuid of the object

Type: string

group-list

Specification
Type list
Block object keys

name

Description: Name of a RBA group

Type: string

partition-list

Description: partition-list is a JSON List . Please see below for l323_partition-list

Type: List

Reference Object: /axapi/v3/rba/group/{name}/partition/{partition-name}

user-list

Description: user-list is a JSON List . Please see below for user-list

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

group-list.partition-list

Specification
Type list
Block object keys

partition-name

Description: partition name

Type: string

Reference Object: /axapi/v3/partition

role-list

Description: role-list is a JSON List . Please see below for role-list

Type: List

rule-list

Description: rule-list is a JSON List . Please see below for l323_rule-list

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

group-list.partition-list.role-list

Specification
Type list
Block object keys

role

Description: Role in a given partition

Type: string

Reference Object: /axapi/v3/rba/role

group-list.partition-list.rule-list

Specification
Type list
Block object keys

object

Description: Lineage of object class for permitted operation

Type: string

Format: string-rlx

operation

Description: ‘no-access’: no-access; ‘read’: read; ‘write’: write;

Type: string

Supported Values: no-access, read, write

group-list.user-list

Specification
Type list
Block object keys

user

Description: Users in the group

Type: string

user-list

Specification
Type list
Block object keys

name

Description: Name of a user account

Type: string

partition-list

Description: partition-list is a JSON List . Please see below for l323_partition-list

Type: List

Reference Object: /axapi/v3/rba/user/{name}/partition/{partition-name}

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

user-list.partition-list

Specification
Type list
Block object keys

partition-name

Description: partition name

Type: string

Reference Object: /axapi/v3/partition

role-list

Description: role-list is a JSON List . Please see below for role-list

Type: List

rule-list

Description: rule-list is a JSON List . Please see below for l323_rule-list

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

user-list.partition-list.role-list

Specification
Type list
Block object keys

role

Description: Role in a given partition

Type: string

Reference Object: /axapi/v3/rba/role

user-list.partition-list.rule-list

Specification
Type list
Block object keys

object

Description: Lineage of object class for permitted operation

Type: string

Format: string-rlx

operation

Description: ‘no-access’: no-access; ‘read’: read; ‘write’: write;

Type: string

Supported Values: no-access, read, write

role-list

Specification
Type list
Block object keys

name

Description: Name for the RBA role

Type: string

rule-list

Description: rule-list is a JSON List . Please see below for l323_rule-list

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

role-list.rule-list

Specification
Type list
Block object keys

object

Description: Lineage of object class for permitted operation

Type: string

Format: string-rlx

operation

Description: ‘no-access’: no-access; ‘read’: read; ‘write’: write;

Type: string

Supported Values: no-access, read, write