rba

Role Based Access configuration

rba Specification

Parameter Value
Type Configuration Resource
Element Name rba
Element URI /axapi/v3/rba
Element Attributes rba_attributes
Partition Visibility shared
Schema rba schema

Operations Allowed:

OperationMethodURIPayload

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: enable

group-list

Type: List

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

role-list

Type: List

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

user-list

Type: List

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

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

group-list

Specification Value
Type list
Block object keys  

name

Description Name of a RBA group

Type: string

Maximum Length: 32 characters

Maximum Length: 1 characters

partition-list

user-list

Type: List

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

group-list_partition-list

Specification Value
Type list
Block object keys  

partition-name

Description partition name

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

role-list

Type: List

rule-list

Type: List

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

group-list_partition-list_role-list

Specification Value
Type list
Block object keys  

role

Description Role in a given partition

Type: string

Maximum Length: 32 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/rba/role

group-list_partition-list_rule-list

Specification Value
Type list
Block object keys  

object

Description Lineage of object class for permitted operation

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

operation

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

Type: string

Supported Values: no-access, read, oper, write

group-list_user-list

Specification Value
Type list
Block object keys  

user

Description Users in the group

Type: string

Maximum Length: 32 characters

Maximum Length: 1 characters

user-list

Specification Value
Type list
Block object keys  

name

Description Name of a user account

Type: string

Maximum Length: 32 characters

Maximum Length: 1 characters

partition-list

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

user-list_partition-list

Specification Value
Type list
Block object keys  

partition-name

Description partition name

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

role-list

Type: List

rule-list

Type: List

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

user-list_partition-list_role-list

Specification Value
Type list
Block object keys  

role

Description Role in a given partition

Type: string

Maximum Length: 32 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/rba/role

user-list_partition-list_rule-list

Specification Value
Type list
Block object keys  

object

Description Lineage of object class for permitted operation

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

operation

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

Type: string

Supported Values: no-access, read, oper, write

role-list

Specification Value
Type list
Block object keys  

default-privilege

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

Type: string

Supported Values: no-access, read, write

Default: no-access

name

Description Name for the RBA role

Type: string

Maximum Length: 32 characters

Maximum Length: 1 characters

partition-only

Description Partition RBA Role

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rule-list

Type: List

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

role-list_rule-list

Specification Value
Type list
Block object keys  

object

Description Lineage of object class for permitted operation

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

operation

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

Type: string

Supported Values: no-access, read, oper, write