HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/user_groups

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Reference Resource: User_Group
Provides the ability to inherit RBAC rules from another user group when performing local authorization. RBAC rules will be prepended to the rules configured for the current user group.

string
required
length between 1 and 32

Reference Resource: User_Group
Name of the user group. Built-in user groups are as follows: administrators: System-defined group with associated privilege level of 15. Members have access to: All the CLI commands and bash shell. All the REST Methods through REST APIs. operators: System-defined group with associated privilege level of 1. Members have access to: All "show" CLI commands (except those that display sensitive information). All "GET" requests through REST APIs. auditors: System-defined group with associated privilege level of 19. Members have access to: All "show" CLI commands to display and copy security logs. All "GET" requests for security logs through REST APIs. Only users belonging to the above three default groups will be allowed access to REST APIs.

string
enum

Indicator of whether the user group is built-in (system-defined) or configured. Unlike user configured user groups, built-in user groups cannot be modified or deleted. Users belonging to configured user groups won't have access to REST APIs.

Allowed:
rbac_rules
object

Reference Resource: RBAC_Rule_Entry
Role Based Access Control rules applicable to a user group. When local authorization is added to AAA authorization list, these rules will be traversed in an ascending order of the sequence number to find a rule that matches the user operation on the switch. The matching rule determines whether the user operation is allowed or denied. If no rule matches, user operation will be denied.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!