Skip to main content

security login rest-role show

Show REST access control roles

Availability: This command is available to cluster administrators at the admin privilege level.

Description​

The security login rest-role show command displays the following information about Representational State Transfer (REST) access-control roles:

  • Vserver
  • Role name
  • Application Programming Interface (API) to which the REST role has access
  • Access Level (none, read-only, or all)

Parameters​

{ [-fields <fieldname>, ...]
If you specify the -fields <fieldname>, ... parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ]}
If you specify the -instance parameter, the command displays detailed information about all fields.
[-vserver <Vserver Name>] - Vserver
Selects the REST roles that match this parameter value.
[-role <text>] - Role Name
Selects the REST roles that match this parameter value. If this parameter and the -api parameter are both used, the command displays detailed information about the specified REST access-control role.
[-api <text>] - API Path
Selects the REST roles that match this parameter value. If this parameter and the -role parameter are both used, the command displays detailed information about the specified REST access-control role. This API can be a resource-qualified endpoint. Currently, the only supported resource-qualified endpoints are /api/storage/volumes/{volume.uuid}/snapshots and /api/storage/volumes/*/snapshots. * is a wildcard character denoting all volumes.
[-access {none|readonly|all}] - Access Level
Selects the roles that match this parameter value.

Examples​

The example below displays information about all REST access-control roles:

      cluster1::> security login rest-role show

                        Role                            Access
      Vserver           Name            API             Level
      ----------        -------------   -----------     -----------
      vs                vsadmin         /api            none
      vs                vsadmin         /api/storage/volumes/f8a541b5-b68c-11ea-9581-005056bbabe6/snapshots
                                                        readonly
      cluster1          readonly        /api/storage    none
      cluster1          custom          /api/storage/volumes/*/snapshots
                                                        all

      cluster1::>