Create API key for service account

Mint a new API key bound to a service account. The full identifier is only returned on this response. Team admin only.

post/service-accounts/{idOrName}/api-keys

Request

Base URL
https://api.tower.dev/v1
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/tower/apis/tower-api/docs/service-accounts/:idOrName/api-keys/post.ts
A function with typed inputs. Its response is checked against the schema.

idOrNamestring required

The ID or name of the service account this key authenticates as.

$schemastring uri

A URL to the JSON Schema for this object.

expires_atstring date-time

When the API key expires.

namestring required

Human-readable name for the API key.

scopesstring

Space-separated scopes for the key. Defaults to the SA's role scopes when omitted.

{
  "$schema": "https://api.tower.dev/v1/schemas/CreateServiceAccountAPIKeyParams.json"
}

Created

$schemastring uri

A URL to the JSON Schema for this object.

{
  "$schema": "https://api.tower.dev/v1/schemas/CreateServiceAccountAPIKeyResponse.json"
}

No recorded changes to this operation across all 12 revisions of this API.