API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create user group with given name.

Management user group configurations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Management user group name. For CX, up to 32 local user-groups are supported, 3 of which are built-in groups and their names cannot be reused,
which are administrators, operators and auditors.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

user-groupbody object

System management user groups configuration.
RBAC (Role Based Access Control) allows a user to create user-defined groups with configurable rules.
Users trying to execute operations on the switch will be restricted based on the rules configured under the user-defined group.
In other words, RBAC allows a network administrator to configure local authorization.

string
length between 1 and 256

Description for the management user group.

string
length between 1 and 32

Inherit RBAC rules from another user group.
Only one user-group can be inherited. If needed, cascading/hierarchical
inheritance of rules can be achieved. RBAC rules will be prepended
to the rules configured for the current user group.

string
length between 1 and 32

Management user group name. For CX, up to 32 local user-groups are supported, 3 of which are built-in groups and their names cannot be reused,
which are administrators, operators and auditors.

rest-rule
array of objects
length ≤ 2147483647

User group REST RBAC rules

rest-rule
rule
array of objects
length ≤ 2147483647

User group RBAC rules, rbac-action and rbac-match-command must also be configured.

rule
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json