> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API Access

> Manage service accounts and API keys for external integrations, with an optional API activity audit tab.

The API Access screen manages service accounts and API credentials at the route `/settings/api-access`.

## Overview

The screen has two tabs: Service Accounts (always visible) and API Activity (shown only with `pf.api_credentials.audit` permission). The Service Accounts tab lists all service accounts for the organization with options to view detail, suspend, or archive each account. Users with `pf.api_credentials.manage` see a "Create Service Account" button that opens a creation dialog. Suspension sets the account status to `suspended`; archiving triggers a confirmation dialog and uses the archive mutation. Clicking a service account navigates to its detail page at `/settings/api-access/:serviceAccountId`.

## Who it's for

Required permission: `pf.api_credentials.view` (access); `pf.api_credentials.manage` (create/suspend/archive); `pf.api_credentials.audit` (API Activity tab)

## Before you start

* You must hold the `pf.api_credentials.view` permission.
* Management and archiving require `pf.api_credentials.manage`.

## Steps

<Steps>
  <Step title="Open API Access">Navigate to Settings → API Access.</Step>
  <Step title="Review service accounts">Browse the list of service accounts and their status.</Step>
  <Step title="Create a service account">If you have manage permission, click "Create Service Account" and complete the dialog.</Step>
  <Step title="Suspend an account">Use the suspend action on a card to set the account status to `suspended`.</Step>
  <Step title="Archive an account">Use the archive action and confirm in the dialog to deactivate the account and its keys.</Step>
  <Step title="View API activity">Switch to the API Activity tab (requires audit permission) to review recent API calls.</Step>
</Steps>

## Key concepts

* Service account — non-human identity used by external integrations to authenticate to the API
* Status values: `active`, `suspended`, `archived`
* `pf.api_credentials.audit` — grants access to the API Activity tab

## Related

<Columns cols={2}>
  <Card title="Platform Foundation" icon="layer-group" href="/pf/overview">
    Platform Foundation overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index">
    Documentation coverage and governance.
  </Card>
</Columns>

<Note>
  This page documents shipped product behavior. It is not medical, legal, or
  billing advice. Verify against your organization's policies and applicable
  regulations before using it for clinical, compliance, or billing decisions.
  Protected health information (PHI) shown in the product is governed by your
  tenant's access controls and is never exposed in this documentation.
</Note>

<Accordion title="Documentation sources">
  * src/routes/platform.tsx
  * src/platform/api-access/pages/ApiAccessPage.tsx
</Accordion>