v1

latestOpenAPI 3.0.02026-08-0645003.8 MB

Organizations

Create Programmatic User

This API creates a new programmatic user (not a human user). Use this API to provide privileges to an application that needs to interface with Spot. Spot returns a token that the programmatic user can use to perform actions with. requires accounts or policies.

post/setup/user/programmatic

Request body

descriptionstring

Brief description of the user.

namestring required

Name of the programmatic user. Note: names cannot include these characters: + = @

Example request

{
  "description": "test programmatic",
  "name": "testProgrammaticApi",
  "accounts": [
    {
      "id": "act-123",
      "role": "viewer"
    }
  ],
  "policies": [
    {
      "policyId": "pol-12345678",
      "accountIds": [
        "*"
      ]
    },
    {
      "policyId": "pol-87654321",
      "accountIds": [
        "act-12345678",
        "act-87654321"
      ]
    }
  ]
}

Response

Create Programmatic User Response

Example response

{
  "response": {
    "status": {
      "code": 200,
      "message": "OK"
    },
    "kind": "spotinst:setup:programmaticUser",
    "items": [
      {
        "token": "f872e7b157866a36229d915aa21cf430f661234568703fd",
        "name": "TestApi1",
        "id": "pu-6a6976ab"
      }
    ],
    "count": 1
  }
}