Skip to main content
REST API reference

Retrieve all group-to-role mapping entries

Retrieves all group-to-role mapping entries to review the current associations between groups and their roles in the system. This helps ensure that access permissions are correctly configured according to organizational policies.

HTTP method and endpoint

GET /security/group/role-mappings

Introduced in

ONTAP 9.16

Usage notes

Retrieves all the group to role mapping entries.

  • security login group role-mapping show

Parameters

Name Type In Required Description

scope

string

query

False

Filter by scope

group_id

integer

query

False

Filter by group_id

  • Max value: 4294967295

  • Min value: 1

ontap_role.name

string

query

False

Filter by ontap_role.name

comment

string

query

False

Filter by comment

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Max value: 120

  • Min value: 0

  • Default value: 15

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records.

records

array[group_role_mappings]

Example response
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "next": {
          "href": "/api/resourcelink"
        },
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "group_id": 1,
      "ontap_role": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "admin"
      },
      "scope": "string"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_error

Example error
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

Name Type Description

next

href

self

href

Name Type Description

self

href

ontap_role

Role name.

Name Type Description

_links

_links

name

string

Role name

group_role_mappings

Name Type Description

_links

_links

comment

string

Any comment regarding this group entry.

group_id

integer

Group ID.

ontap_role

ontap_role

Role name.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.