Sign in

v1

latestSwagger 2.02026-07-178567199.3 KB
organizations
users

Update existing organization

Updates a Chronograf organization in the store

patch/organizations/{id}

Path parameters

idstring required

ID of the organization

Request body

defaultRole'member' | 'viewer' | 'editor' | 'admin'

The default role that new users in this organization will have.

idstring

Unique identifier representing an organization resource. The Default organization will have the id 'default', and any further will start at '1' and increment.

namestring required

User-facing name of the organization resource.

Example request

{
  "defaultRole": "viewer",
  "id": "1",
  "links": {
    "self": "/chronograf/v1/organizations/1"
  },
  "name": "Chronogiraffes"
}

Response

Organization successfully updated

defaultRole'member' | 'viewer' | 'editor' | 'admin'

The default role that new users in this organization will have.

idstring

Unique identifier representing an organization resource. The Default organization will have the id 'default', and any further will start at '1' and increment.

namestring required

User-facing name of the organization resource.

Example response

{
  "defaultRole": "viewer",
  "id": "1",
  "links": {
    "self": "/chronograf/v1/organizations/1"
  },
  "name": "Chronogiraffes"
}