Skip to navigation
API referenceOrganizationsService tokens

Edit service-token configuration

Required scopes: token.create.

Serializes with other organization credential changes. Preserves omitted fields and expiry. Resulting scopes must not exceed the current issuer scopes, including when scopes are omitted. Expired credentials can be explicitly renewed under the existing active-token cap. Editing does not issue a secret.

Response headers:

  • ETag (200): Configuration validator. Excludes volatile last-use metadata, which is available in the token list only. Rotation invalidates this validator.

Authentication

AuthorizationBearer

Organization-owned service token. Issue the initial token in organization credential settings. Scopes are documented per operation via x-required-scopes; they are not OAuth scopes.

Path parameters

organization_idstringRequiredformat: "uuid"
Immutable organization UUID bound to the service token.
credential_idstringRequired

Headers

If-MatchstringRequiredformat: "^"token-[a-f0-9]{64}"$"

Use the latest service-token configuration ETag unchanged. Missing: 428; stale: 412. Wildcards, lists and weak validators are rejected.

Request

This endpoint expects an object.
labelstringOptional1-128 characters

At most 128 UTF-8 bytes.

scopeslist of enumsOptional

Every scope must be held by the issuer; duplicate entries are normalized.

expires_atinteger or nullOptional

Future Unix seconds, at most 90 days ahead. Omit to preserve the exact existing expiry; null explicitly selects no expiration.

Response headers

X-Request-IdstringOptional
ETagstringOptionalformat: "^"token-[a-f0-9]{64}"$"

Configuration validator. Excludes volatile last-use metadata, which is available in the token list only. Rotation invalidates this validator.

Response

Successful operation
idstring
organization_idstringformat: "uuid"
labelstring
scopeslist of enums
issued_atinteger
expires_atinteger or null

Unix timestamp in seconds; null means no deadline or no recorded use.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error