Update Group

put

{protocol}://{server}{basePath}/accounts/{accountId}/groups/{groupId}

This API requires the Account Administrator role.

Updates a group.

The following fields must be unique otherwise a HTTP 409 Conflict will be returned:

name

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

groupId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

The unique 36 character internal id that represents the group.

Body Params

Group with properties which needs to be updated

This model holds the group related data

name

string

length between 1 and 255

^[^=:*,]*$

Name of the group

description

string

length between 0 and 255

^[^<>\^@#]*$

Description of the group

organizationNodeId

string

length between 0 and 6

^[a-zA-Z]{0,6}$

Unique Id for Account or Node where group get created

resources

array of objects

length between 1 and 50

List of group resource

resources

This is container model for group data

type

string

required

length between 1 and 255

^[^<>\^@#]*$

Type of the group

resourceIds

array of strings

length ≤ 500

Unique Id's of resources which are member of this group

resourceIds

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200OK

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

409Conflict

500All other application errors