INinfluxdata
organizations
users

Update existing user

Updates a Chronograf user in the store

patch/users/{id}

Request

  • Base URL
    /chronograf/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /chronograf/v1/users/{id}
  • Auth
    none declared

Path parameters

idstring required

ID of the user

Request body

idstring required

Unique identifier representing a user resource

namestring required

Username (as taken from principal given by auth provider)

providerstring required

OAuth provider used to authenticate

schemestring required

Scheme used to authenticate (only OAuth2 currently supported)

superAdminboolean

If user has the ability to perform CRUD operations on Organizations, across Organizations, and on other SuperAdmin users

Example request

{
  "id": "1",
  "links": {
    "self": "/chronograf/v1/users/1"
  },
  "name": "pineapple@cubeoctohedron.flux",
  "provider": "github",
  "roles": {
    "name": "editor",
    "organization": "SpaceTeam"
  },
  "scheme": "oauth2",
  "superAdmin": false
}

Response

User successfully updated

idstring required

Unique identifier representing a user resource

namestring required

Username (as taken from principal given by auth provider)

providerstring required

OAuth provider used to authenticate

schemestring required

Scheme used to authenticate (only OAuth2 currently supported)

superAdminboolean

If user has the ability to perform CRUD operations on Organizations, across Organizations, and on other SuperAdmin users

Example response

{
  "id": "1",
  "links": {
    "self": "/chronograf/v1/users/1"
  },
  "name": "pineapple@cubeoctohedron.flux",
  "provider": "github",
  "roles": {
    "name": "editor",
    "organization": "SpaceTeam"
  },
  "scheme": "oauth2",
  "superAdmin": false
}

Changes

No recorded changes to this operation across all 71 revisions of this API.