Obtenha acesso à Compliance API

A Compliance API usa dois tipos de chave, e qual delas você cria depende de qual produto Claude sua organização usa. Proprietários principais criam Compliance Access Keys no claude.ai; essas chaves desbloqueiam a Compliance API completa. Administradores da organização criam chaves de Admin API no Claude Console; essas chaves desbloqueiam apenas o Activity Feed.

Qual chave você precisa?

Um tenant Claude Enterprise tem uma organização pai que centraliza identidade, SSO e SCIM para cada organização de carga de trabalho abaixo dela. Essas organizações de carga de trabalho são as organizações vinculadas da organização pai.

Solicitar acesso à Compliance API

Entre em contato com seu representante da Anthropic para solicitar acesso. A habilitação acontece no nível da organização pai e se propaga para todas as organizações vinculadas, tanto do claude.ai quanto do Claude Console. O que muda após a habilitação depende de qual produto Claude sua organização usa.

Após a habilitação: organizações do claude.ai

Depois que a Anthropic habilitar a Compliance API para sua organização pai, o proprietário principal pode criar Compliance Access Keys na seção Keys em claude.ai > Organization settings > API.

Após a habilitação: organizações do Claude Console

Depois que a Anthropic habilitar a Compliance API para sua organização pai, as chaves de Admin API criadas a partir de então carregam o escopo read:compliance_activities. Chaves de Admin API criadas antes da habilitação continuam funcionando com a Admin API, mas chamar o Activity Feed com uma delas retorna 403 Forbidden; crie uma nova chave de Admin API para obter o escopo.

Criar uma Compliance Access Key

Criar uma chave de Admin API

Chaves de Admin API carregam o escopo read:compliance_activities apenas quando a Compliance API foi habilitada para a organização antes de a chave ser criada; consulte Após a habilitação: organizações do Claude Console. Elas não podem receber nenhum outro escopo da Compliance API, portanto chamadas a qualquer endpoint que não seja o Activity Feed retornam 403 Forbidden.

Para o papel dessa mesma chave no gerenciamento de sua organização do Claude Console, consulte Admin API.

Verificar os escopos da sua chave

Para inspecionar os escopos de uma chave que você já possui, use um dos seguintes sinais.

• Prefixo da chave. sk-ant-admin01- é uma chave de Admin API (carrega apenas read:compliance_activities, sujeito ao momento da habilitação descrito na seção anterior). sk-ant-api01- é uma Compliance Access Key; seus escopos são o subconjunto que você selecionou na criação.
• Interface de configurações. Abra a seção Keys em claude.ai > Organization settings > API, ou a seção Admin keys em Claude Console > Settings > Admin keys, e leia a coluna Scopes da chave.
• Respostas de erro. Uma chamada que excede os escopos da chave retorna um 403 com uma mensagem no formato Missing required scopes. Got: [<scopes the key carries>] Needed: [<scopes the endpoint requires>]. Consulte Tratar erros da Compliance API para o catálogo completo de erros.

{
  "error": {
    "type": "permission_error",
    "message": "Missing required scopes. Got: ['read:compliance_activities'] Needed: ['read:compliance_user_data']"
  }
}

Gerenciar e rotacionar chaves

Exclua uma Compliance Access Key na mesma tabela Keys onde você a criou: vá para claude.ai > Organization settings > API. Exclua uma chave de Admin API em Claude Console > Settings > Admin keys.

A exclusão de uma chave entra em vigor na próxima requisição: não há período de carência. Compliance Access Keys não expiram por conta própria.

Para rotacionar uma chave sem interrupção:

1. Crie uma nova chave com os mesmos escopos.
2. Atualize sua integração para usar a nova chave.
3. Verifique se a integração funciona com a nova chave.
4. Exclua a chave antiga.

Cursores de paginação armazenados antes de uma rotação permanecem válidos: cursores têm escopo na organização, não na chave.

Se uma Compliance Access Key vazar, exclua-a imediatamente, audite o Activity Feed em busca de atividades compliance_api_accessed feitas pela chave comprometida e rotacione quaisquer credenciais downstream que a chave vazada poderia alcançar. Passe activity_types[]=compliance_api_accessed para delimitar a consulta e, em seguida, no seu cliente, mantenha as atividades cujo actor.type seja api_actor e cujo actor.api_key_id corresponda à chave comprometida; consulte Entender o objeto Activity para o esquema do actor.

Próximos passos