service-accounts

Mint a credential on this identity

Mints one more credential — a secret or an api_key — on an existing identity's OIDC client and returns it once. An identity holds at most one live credential of each kind, so minting a kind it already holds live at the provider is 409; revoke it first, or rotate it.

The credential is created at the provider first, then recorded here with a created audit event. An api_key records the credential_ttl_seconds it was minted with (also accepted as expires_in_seconds), and every later rotation re-applies it. If this identity's record still shows a live credential of the kind that the provider no longer has (it expired, or was revoked out of band), the provider accepts the mint and the stale record is retired beside the new one — the kind never wedges.

Manageable by the identity's owner or an account admin. The member who provisioned the identity may mint on it; an account admin (organization#clients_manage) may mint on anyone's. A platform identity (action, registry) and an artifact's identity are unreachable by anyone and answer 404. Runs as the calling operator — the caller's bearer is forwarded to the provider.

post/registry/v1/service-accounts/{principal_id}/credentials

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/service-accounts/{principal_id}/credentials
  • Auth: HTTP bearer

Path parameters

principal_idstring required

The durable principal id

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Request body

credential_ttl_secondsinteger nullable

The api_key's lifetime in seconds, 3600 (1 hour) to 31536000 (365 days). Defaults to 7776000 (90 days). 400 with kind: secret. expires_in_seconds is accepted as an alias, as on the create.

kindstring required

The credential kind to mint: secret or api_key. Required, never defaulted. The identity must not already hold one of this kind.

Response

The new credential, returned once.

expires_atstring nullable

RFC 3339, when the provider set an expiry.

kindstring required

The credential kind the provider issued.

principal_idstring required

The identity this credential belongs to.

secretstring required

The secret. Record it now; it is not retrievable.

Changes

No recorded changes to this operation across all 1 revision of this API.