rba role

Role configuration for RBA support

role Specification

Parameter	Value
Type	Collection
Object Key(s)	name
Collection Name	role-list
Collection URI	/axapi/v3/rba/role
Element Name	role
Element URI	/axapi/v3/rba/role/{name}
Element Attributes	role_attributes
Partition Visibility	shared
Schema	role schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/rba/role	role attributes	example close
POST /axapi/v3/rba/role/ Payload: { "role": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/rba/role	role attributes
Get Object	GET	/axapi/v3/rba/role/{name}	role attributes	example close
GET /axapi/v3/rba/role/a Reponse: { "role": { "name": "a", "default-privilege": "no-access", "partition-only": 0, "uuid": "1313a460-65a5-11f0-b71f-6fe93075fb18", "user-tag": "a", "a10-url": "/axapi/v3/rba/role/a" } }
Get List	GET	/axapi/v3/rba/role	role-list
Modify Object	POST	/axapi/v3/rba/role/{name}	role attributes
Replace Object	PUT	/axapi/v3/rba/role/{name}	role attributes	example close
PUT /axapi/v3/rba/role/a Payload: { "role": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/rba/role	role-list
Delete Object	DELETE	/axapi/v3/rba/role/{name}	role attributes	example close
DELETE /axapi/v3/rba/role/a Reponse: { "response": { "status": "OK" } }

role-list

role-list is JSON List of role attributes

role-list : [

{ role attributes },

{ role attributes },

…

]

role attributes

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

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