Skip to main content
REST API reference

Retrieve a group entry

PDFs

GET /security/groups/{owner.uuid}/{name}/{type}

Introduced In: 9.16

Retrieves a group entry.

  • security login group show

Parameters

Name Type In Required Description

owner.uuid

string

path

True

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

name

string

path

True

Group name.

type

string

path

True

Group type.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.
Example response 
{
  "_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

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.

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.