Skip to main content
REST API reference

Retrieve all group entries

PDFs

GET /security/groups

Introduced In: 9.16

Retrieves all group entries.

  • security login group show

Parameters

Name Type In Required Description

owner.name

string

query

False

Filter by owner.name

owner.uuid

string

query

False

Filter by owner.uuid

comment

string

query

False

Filter by comment

name

string

query

False

Filter by name

uuid

string

query

False

Filter by uuid

type

string

query

False

Filter by type

id

integer

query

False

Filter by id

scope

string

query

False

Filter by scope

create_time

string

query

False

Filter by create_time

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of records.

records

array[security_group]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "Azure Group",
      "create_time": "string",
      "id": 0,
      "name": "AzureGroup1",
      "owner": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "scope": "string",
      "type": "entra",
      "uuid": "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

_links

Name Type Description

self

href

owner

Group owner. Used to identify a cluster or an SVM.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

security_group

Name Type Description

_links

self_link

comment

string

Any comment regarding this group entry.

create_time

string

Date and time indicating when this group entry was created.

id

integer

Group ID which is unique per group across the system. It is a read-only field and it automatically assigns the next available unique number.

name

string

Group name.

owner

owner

Group owner. Used to identify a cluster or an SVM.

scope

string

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

type

string

Group type.

uuid

string

Group UUID from external Active Directory.

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.