v1

latestOpenAPI 3.0.02026-08-0645003.8 MB

Organizations

Create User

Create a new user and link it to the creator's organization (the organization ID from the personal token attached to the API call). If the role is a viewer, the user is also linked to the default account for the organization.

post/setup/user

Query parameters

generateTokenboolean

If true, then the response will include personalAccessToken string

Request body

firstNamestring

The first name of the user. Note: names cannot include these characters: + = @

lastNamestring

The last name of the user. Note: names cannot include these characters: + = @

emailstring

passwordstring

Password

rolestring

User's role

Example request

{
  "firstName": "Test",
  "lastName": "Test",
  "email": "test@spot.io",
  "password": "password1234",
  "role": "viewer"
}

Response

Create User Response

Example response

{
  "request": {
    "id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
    "url": "/setup/user/?generateToken=true",
    "method": "POST",
    "timestamp": "2018-11-19T13:49:11.911Z"
  },
  "response": {
    "status": {
      "code": 200,
      "message": "OK"
    },
    "kind": "spotinst:setup:user",
    "items": [
      {
        "id": 9056,
        "firstName": "Test",
        "lastName": "Test",
        "displayName": "Test Test",
        "email": "test@gmail.com",
        "organizationId": 606079860000,
        "userId": "u-1a2b3c4d"
      }
    ],
    "count": 1
  }
}