All pages
Powered by GitBook
1 of 1

Loading...

Update API token

Updates the specific token object.

Update API token

put

Update API token. Available for all account types (Operations account, Client account, Vendor account). Accepts a delta payload with fields to update (e.g. name, description, icon, modules). Returns the updated API token object.

Path parameters
idstringRequired

API token identifier.

Body
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
statusstringOptional
descriptionstring · nullableOptional
lastAccessAtstring · date-time · nullableOptional
tokenstringOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
statusstring · enumOptionalPossible values:
Responses
200

OK

application/json
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
statusstringOptional
descriptionstring · nullableOptional
lastAccessAtstring · date-time · nullableOptional
tokenstringOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
statusstring · enumOptionalPossible values:
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
put/public/v1/accounts/api-tokens/{id}
PUT /public/v1/accounts/api-tokens/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "name": "Robot Updated",
  "description": "Updated description",
  "modules": [
    {
      "id": "MOD-1756-1452"
    }
  ]
}
{
  "id": "TKN-4134-7330",
  "revision": 2,
  "name": "Robot Updated",
  "description": "Updated description",
  "status": "Active",
  "account": {
    "id": "ACC-1234-5678",
    "name": "Microsoft"
  },
  "modules": [
    {
      "id": "MOD-1756-1452"
    }
  ],
  "audit": {
    "created": {
      "at": "2024-02-01T09:12:23+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    },
    "updated": {
      "at": "2024-02-02T10:00:00+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    }
  }
}