Create API token

Creates a new token object for the specific account.

Create API token

post

Create API token. Available for all account types (Operations account, Client account, Vendor account). Accepts account reference, name, optional description, and at least one module. Returns the created API token object with revision 1 and token value (returned only on create).

Body

application/jsontext/jsonapplication/*+json

namestringOptional

iconstring · nullableOptional

descriptionstring · nullableOptional

Responses

201

Created

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

statusstringOptional

descriptionstring · nullableOptional

lastAccessAtstring · date-time · nullableOptional

tokenstringOptional

400

Bad Request

application/json

post/public/v1/accounts/api-tokens

HTTPcURLJavaScriptPython

POST /public/v1/accounts/api-tokens HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "account": {
    "id": "ACC-1234-5678"
  },
  "name": "Robot",
  "description": "Token for ERP integration",
  "modules": [
    {
      "id": "MOD-1756-1452"
    },
    {
      "id": "MOD-9042-8216"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "TKN-4134-7330",
  "revision": 1,
  "name": "Robot",
  "description": "Token for ERP integration",
  "status": "Active",
  "token": "idt:TKN-4134-7330:z24kA...328f",
  "account": {
    "id": "ACC-1234-5678",
    "name": "Microsoft"
  },
  "modules": [
    {
      "id": "MOD-1756-1452"
    },
    {
      "id": "MOD-9042-8216"
    }
  ],
  "audit": {
    "created": {
      "at": "2024-02-01T09:12:23+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    },
    "updated": {
      "at": "2024-02-01T09:12:23+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    }
  }
}