Skip to main content
REST API reference

Update configured group information

PDFs

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

Introduced In: 9.16

Updates configured group information.

  • security login group modify

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.

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.

scope

string

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

uuid

string

Group UUID from external Active Directory.
Example request 
{
  "comment": "Azure Group",
  "create_time": "string",
  "id": 0,
  "scope": "string",
  "uuid": "string"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5636235

Duplicate UUID.

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.

scope

string

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

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.