---
id: "api_key"
kind: "datatype"
status: "draft"
is_pii: false
categories: ["secrets"]
langs: ["common"]
quality: 55
url: "http://registry.apicrafter.io/datatype/api_key"
---

# API key or client secret (`api_key`)

> **Draft.** Draft records have not been reviewed yet and may be incomplete or wrong; do not treat them as authoritative for legal or compliance decisions.

Secret string that an application presents to an API or an identity provider to authenticate itself, such as an API key, a subscription key or an OAuth client secret. Formats differ by service.

- Personal data (PII): no
- Categories: Secrets and credentials (passwords, keys, tokens) (secrets)
- Countries: global
- Languages: Common to most languages (common)

## Mappings

- purview: `Microsoft Entra client secret`, `Azure AD client secret`, `Azure Bot Framework secret key`, `Azure Bot service app secret`, `Azure Cognitive Search API key`, `Azure Cognitive Service key`, `Azure DevOps app secret`, `Azure Function Master / API key`, `Azure Machine Learning web service API key`, `Azure Maps subscription key`, `Client secret / API key`, `Microsoft Bing maps key`, `All Credential Types`, `All credentials`

## Supported by tools

- `microsoftpurview`
- `nightfall`

## Sources

- doc: <https://learn.microsoft.com/en-us/purview/sit-defn-client-secret-api-key>
- wikipedia: <https://en.wikipedia.org/wiki/API_key>

## Quality

Score 55/100. Missing: regexp, examples, negative example, translation.

JSON: <http://registry.apicrafter.io/api/v1/datatypes/api_key.json> · Edit: <https://github.com/apicrafter/metacrafter-registry/edit/main/data/datatypes/any/secrets/api_key.yaml>