rba group¶
RBA configuration for a group
group Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name group-list Collection URI /axapi/v3/rba/group Element Name group Element URI /axapi/v3/rba/group/{name} Element Attributes group_attributes Partition Visibility shared Schema group schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/rba/group | ||
Create List | POST | /axapi/v3/rba/group | ||
Get Object | GET | /axapi/v3/rba/group/{name} | ||
Get List | GET | /axapi/v3/rba/group | ||
Modify Object | POST | /axapi/v3/rba/group/{name} | ||
Replace Object | PUT | /axapi/v3/rba/group/{name} | ||
Replace List | PUT | /axapi/v3/rba/group | ||
Delete Object | DELETE | /axapi/v3/rba/group/{name} | ||
group-list¶
group-list is JSON List of group attributes
group-list : [
]
group attributes¶
name
Description Name of a RBA group
Type: string
Maximum Length: 32 characters
Maximum Length: 1 characters
partition-list
Type: List
Reference Object: /axapi/v3/rba/group/{name}/partition/{partition-name}
user-list
Type: Listuser-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
partition-list¶
Specification Value Type list Block object keys partition-name
Description partition name
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/partition
role-list
Type: Listrule-list
Type: Listuser-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
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
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
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