Users

List users

get

Responses

200

OK

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/users

HTTPcURLJavaScriptPython

GET /v1/users HTTP/1.1
Accept: */*

{
  "users": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "dateModified": "text",
        "deprecated": true,
        "description": "string",
        "displayName": "string",
        "hash": "text",
        "icon": "string",
        "id": "string",
        "labels": {},
        "name": "string",
        "resourceDocLink": "string",
        "stability": "string",
        "version": 1,
        "warning": "string"
      },
      "spec": {
        "activeAccount": "text",
        "email": "text",
        "nextLoginAccount": "text",
        "requestedMFA": true
      },
      "status": {}
    }
  ]
}

Add User to Current Project

post

The /users route will add a new user to an existing project. If the create flag is set, and the user doesn't already exist, it will create the user and add a new login in addition to the the project binding.

Body

application/json

Body of the request to add a user to an account

createbooleanOptional

Create should be true if the user should be created if they do not exist

emailstringOptional

Email address of the user to add

namestringOptional

Name of the user to add

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

422

Tried to update a non-existing user, use the create flag to create a new user

application/json

500

Internal Server Error

application/json

post

/users

HTTPcURLJavaScriptPython

POST /v1/users HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "create": true,
  "email": "text",
  "name": "text"
}

{
  "updates": [
    {
      "before": null,
      "reason": "string",
      "resource": null,
      "status": "error"
    }
  ]
}

Get user by id

get

Path parameters

idstringRequired

the id of the user

Responses

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/users/{id}

HTTPcURLJavaScriptPython

GET /v1/users/{id} HTTP/1.1
Accept: */*

{
  "user": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "activeAccount": "text",
      "email": "text",
      "nextLoginAccount": "text",
      "requestedMFA": true
    },
    "status": {}
  }
}

Remove User from Current Project

delete

Path parameters

idstringRequired

the id of the user to remove from the current project

Responses

204

Successful removal, no content

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/users/{id}

HTTPcURLJavaScriptPython

DELETE /v1/users/{id} HTTP/1.1
Accept: */*

No content

Demote a user from organization admin

post

Path parameters

idstringRequired

the id of the user

Responses

200

OK

No content

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/users/{id}/demote-org-admin

HTTPcURLJavaScriptPython

POST /v1/users/{id}/demote-org-admin HTTP/1.1
Accept: */*

No content

Set a user's project role

put

Sets the role of a user within the current project

Path parameters

idstringRequired

the id of the user

Body

application/json

Body of the request to set a user's project role

roleall ofOptional

Role is the new project role for the user (admin, user, or viewer)

string · enumOptionalPossible values:

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

put

/users/{id}/project-role

HTTPcURLJavaScriptPython

PUT /v1/users/{id}/project-role HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "admin"
}

{
  "updates": [
    {
      "before": null,
      "reason": "string",
      "resource": null,
      "status": "error"
    }
  ]
}

Promote a user to organization admin

post

Path parameters

idstringRequired

the id of the user

Responses

200

OK

No content

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/users/{id}/promote-org-admin

HTTPcURLJavaScriptPython

POST /v1/users/{id}/promote-org-admin HTTP/1.1
Accept: */*

No content

Remove a user from the current organization

post

Removes the user from all organization projects and deletes the organization binding

Path parameters

idstringRequired

the id of the user

Responses

200

OK

No content

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/users/{id}/remove-from-org

HTTPcURLJavaScriptPython

POST /v1/users/{id}/remove-from-org HTTP/1.1
Accept: */*

No content