service-accounts

Get a service account

One service account, revoked or not. Any other identity in the account — an agent's, or a platform identity — is 404 here.

Last use. As on the list, each entry in credentials carries last_used_at and is_last_use_known, read from the identity provider on every call. The read is best-effort: when the provider cannot be read in time, or the caller carries no forwardable credential, is_last_use_known is false, last_used_at is absent, and the read still succeeds.

get/registry/v1/service-accounts/{principal_id}

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}
  • Auth: HTTP bearer

Path parameters

principal_idstring required

The durable principal id

Response

OK

client_idstring required

Stable identifier of the related client resource.

created_atstring required

Value of the created_at field.

created_bystring nullable

Value of the created_by field.

display_namestring nullable

Human-readable name.

idstring required

Stable identifier of this resource.

principal_typestring required

Always service_account: this surface lists and serves no other identity.

redirect_urisstring[] required

The client's OAuth redirect URIs; empty for a machine-only client. Non-empty means the client may run the authorization-code flow (authorization_code and refresh_token beside client_credentials). Changed with PATCH.

revoked_atstring nullable

Value of the revoked_at field.

scopesstring[] required

The client's scopes: the ceiling over what its seats allow. A subset of contextplane:read, contextplane:write, contextplane:manage and oauth-clients:manage. Changed with PATCH. A client with redirect_uris additionally holds openid and profile at the identity provider; they are derived, not stored here.

statusstring required

Current lifecycle state.

updated_atstring nullable

RFC 3339, when the identity was last renamed or its redirect URIs or scopes changed. Absent if none of that has happened.

Changes

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