Skip to main content
REST API reference

Create a group entry

PDFs

POST /security/groups

Introduced In: 9.16

Creates a group entry.

Required properties

  • name

Optional properties

  • owner

  • type

  • uuid

  • comment

  • security login group create

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

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 request 
{
  "comment": "Azure Group",
  "create_time": "string",
  "id": 0,
  "name": "AzureGroup1",
  "owner": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "scope": "string",
  "type": "entra",
  "uuid": "string"
}

Response

Status: 201, Created
Name Type Description

num_records

integer

Number of records.

records

array[security_group]
Example response 
{
  "num_records": 1,
  "records": [
    {
      "comment": "Azure Group",
      "create_time": "string",
      "id": 0,
      "name": "AzureGroup1",
      "owner": {
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "scope": "string",
      "type": "entra",
      "uuid": "string"
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5636231

Failed to create the group because the maximum number of allowed group IDs has been reached.

5636232

The group name does not satisfy the length requirement.

5636235

Duplicate UUID.

5636244

Failed to delete the group because it is part of the group role mapping configuration.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

_links

owner

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

Name Type Description

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

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.