Skip to main content
A newer release of this product is available.

Update an S3 group configuration for an SVM

Contributors
PDFs

PATCH /protocols/s3/services/{svm.uuid}/groups/{id}

Introduced In: 9.8

Updates the S3 group configuration of an SVM.

Important notes

  • The following fields can be modified for a group:

  • name - Group name that needs to be modified.

  • users - List of users present in the group.

  • policies - List of policies to be attached to this group.

  • comment - Short description about the S3 Group.

  • vserver object-store-server group modify

Learn more

Parameters

Name Type In Required Description

id

integer

path

True

Group identifier that identifies the unique group.

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

comment

string

Can contain any additional information about the group being created or modified.

id

integer

Specifies a unique Group ID used to identify a particular group. This parameter should not be specified in the POST or PATCH method. A Group ID is automatically generated and it is retrieved using the GET method. Group ID is SVM-scoped.

name

string

Specifies the name of the group. A group name length can range from 1 to 128 characters and can only contain the following combination of characters 0-9, A-Z, a-z, "_", "+", "=", ",", ".","@", and "-".

policies

array[policies]

Specifies a list of policies that are attached to the group. The wildcard character "*" is a valid value for specifying all policies.

svm

svm

SVM, applies only to SVM-scoped objects.

users

array[users]

Specifies the list of users who belong to the group.
Example request 
{
  "comment": "Admin group",
  "id": 5,
  "name": "Admin-Group",
  "policies": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "Policy1"
    }
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "users": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "user-1"
    }
  ]
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

92405896

Users list cannot be empty.

92405930

Group name "{group name}" is not valid. Group names must have between 1 and 128 characters.

92405931

Group name "{group name}" contains invalid characters. Valid characters for a group name are 0-9, A-Z, a-z, "_", "+", "=", ",", ".", "@", and "-".

92405934

Users {user name} specified in the user list do not exist for SVM "{vserver name}". Use the "object-store-server user create" command to create a user.

92405936

Query characters such as * are not supported in the user list.

92405937

Policies {policy name} specified in the policy list do not exist for SVM "{vserver name}".

262222

User name is present more than once in the users field.

2621706

The specified "{svm.uuid}" and "{svm.name}" refer to different SVMs.

92406154

Users {user} specified in the user list do not exist for SVM "vs1". Use the "/protocols/s3/services/{svm.uuid}/users" endpoint to create a user.
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

_links

Name Type Description

self

href

policies

Name Type Description

_links

_links

name

string

Specifies the name of the policy. A policy name length can range from 1 to 128 characters and can only contain the following combination of characters 0-9, A-Z, a-z, "_", "+", "=", ",", ".","@", and "-".

svm

SVM, applies only to SVM-scoped objects.

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.

users

Name Type Description

_links

_links

name

string

Specifies the name of the user. A user name length can range from 1 to 64 characters and can only contain the following combination of characters 0-9, A-Z, a-z, "_", "+", "=", ",", ".","@", and "-".

s3_group

This is a container for S3 user groups.

Name Type Description

comment

string

Can contain any additional information about the group being created or modified.

id

integer

Specifies a unique Group ID used to identify a particular group. This parameter should not be specified in the POST or PATCH method. A Group ID is automatically generated and it is retrieved using the GET method. Group ID is SVM-scoped.

name

string

Specifies the name of the group. A group name length can range from 1 to 128 characters and can only contain the following combination of characters 0-9, A-Z, a-z, "_", "+", "=", ",", ".","@", and "-".

policies

array[policies]

Specifies a list of policies that are attached to the group. The wildcard character "*" is a valid value for specifying all policies.

svm

svm

SVM, applies only to SVM-scoped objects.

users

array[users]

Specifies the list of users who belong to the group.

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.