Claude Platform Docs
AdministraçãoOrganização

Gerenciamento de usuários

Gerencie as pessoas na sua organização Claude Enterprise com a Admin API: liste membros e altere funções, envie e retire convites, gerencie grupos e leia funções personalizadas.

Esta página aborda o gerenciamento programático das pessoas na sua organização Claude Enterprise (claude.ai), usando a Admin API: listar membros e procurá-los por endereço de e-mail, alterar a função de um membro, remover membros, enviar e retirar convites, gerenciar os grupos da sua empresa e seus membros, e ler as funções personalizadas da sua organização. Para organizações do Claude Console (Claude Platform), consulte o guia da Admin API para o Claude Console.

Quais endpoints sua organização pode usar?

A Admin API é um único conjunto de endpoints em https://api.anthropic.com/v1/organizations/. Organizações do Claude Console e do Claude Enterprise se autenticam com chaves diferentes e cada uma tem acesso a um subconjunto diferente dos endpoints:

EndpointsClaude Console (Claude Platform)Claude Enterprise (claude.ai)
Membros e convitesDisponível; consulte o guia da Admin APIDisponível (esta página)
GruposNão disponívelDisponível (esta página)
Funções personalizadasNão disponívelDisponível, somente leitura (esta página)
Limites de gastosNão disponívelDisponível
Workspaces, chaves de API, relatórios de uso e custo, limites de taxa e os demais endpoints no guia da Admin APIDisponívelNão disponível

Membros e convites são os mesmos endpoints para ambos os tipos de organização; esta página documenta seu comportamento no Claude Enterprise, incluindo as funções de organização do Claude Enterprise. Os endpoints de grupos e funções personalizadas existem apenas para o Claude Enterprise.

Visão geral

Esta página aborda cinco recursos:

RecursoEndpointsUse para
MembrosGET /v1/organizations/users
GET /v1/organizations/users/{user_id}
POST /v1/organizations/users/{user_id}
DELETE /v1/organizations/users/{user_id}
Listar os membros da organização ou procurar um por e-mail; alterar a função de um membro; remover um membro.
ConvitesPOST /v1/organizations/invites
GET /v1/organizations/invites
GET /v1/organizations/invites/{invite_id}
DELETE /v1/organizations/invites/{invite_id}
Convidar uma pessoa para a organização, acompanhar o status do convite e retirá-lo antes que seja aceito.
GruposGET /v1/organizations/rbac_groups
GET /v1/organizations/rbac_groups/{group_id}
POST /v1/organizations/rbac_groups
POST /v1/organizations/rbac_groups/{group_id}
DELETE /v1/organizations/rbac_groups/{group_id}
Ler os grupos da sua empresa e as funções personalizadas anexadas a cada um; criar, renomear e excluir grupos.
Membros de gruposGET /v1/organizations/rbac_groups/{group_id}/members
POST /v1/organizations/rbac_groups/{group_id}/members
DELETE /v1/organizations/rbac_groups/{group_id}/members/{user_id}
Ler os membros de um grupo; adicionar e remover membros.
Funções personalizadasGET /v1/organizations/rbac_roles
GET /v1/organizations/rbac_roles/{role_id}
GET /v1/organizations/rbac_roles/{role_id}/permissions
Ler as funções personalizadas da sua organização e as permissões que cada função concede.

As funções personalizadas e suas associações a grupos são gerenciadas nas configurações da organização no claude.ai; a API as lê, mas não pode alterá-las.

Início rápido

Liste os membros da organização, os mais recentes primeiro:

cURL
curl "https://api.anthropic.com/v1/organizations/users?limit=20" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01"
{
  "data": [
    {
      "type": "user",
      "id": "user_01AbCdEfGhIjKlMnOpQrSt",
      "email": "jane@example.com",
      "name": "Jane Smith",
      "role": "user",
      "added_at": "2026-06-12T09:14:03Z"
    }
  ],
  "has_more": false,
  "first_id": "user_01AbCdEfGhIjKlMnOpQrSt",
  "last_id": "user_01AbCdEfGhIjKlMnOpQrSt"
}

Conceitos principais

Funções de organização

Cada membro tem exatamente uma função de organização. As leituras retornam a função do membro como um de cinco valores:

FunçãoSignificado
userUm membro padrão.
managedUm membro cujas permissões são concedidas por meio das funções personalizadas anexadas aos seus grupos.
ownerUm proprietário da organização.
membership_adminUm membro que pode gerenciar os membros da organização.
primary_ownerO proprietário principal da organização. Há exatamente um.

A API pode atribuir apenas as funções user e managed, na criação de convites e nas atualizações de função. As funções administrativas (owner, membership_admin e primary_owner) são atribuídas nas configurações da organização no claude.ai, e os membros que as possuem não podem ser modificados ou removidos por meio desta API.

Membros e convites

Uma pessoa se torna membro ao aceitar um convite (ou por meio do "single sign-on" (login único) da sua organização, quando configurado). Criar um convite envia um e-mail de convite; o convite então aparece como pending até que o destinatário aceite (accepted) ou seu expires_at atribuído pelo servidor passe (expired). Apenas um convite pending pode ser retirado. Para alterar o endereço de e-mail ou a função de um convite pendente, retire-o e crie um novo.

Se o plano da sua organização obtém membros de um conjunto finito de assentos adquiridos, um convite pendente consome um assento. O endpoint de criação de convite não aceita um parâmetro de assento ou nível: o assento é atribuído automaticamente a partir do nível mais baixo que tenha disponibilidade. Criar um convite quando não há assento livre falha com um erro 400 em vez de adquirir um assento. Retirar o convite, deixá-lo expirar ou remover o membro posteriormente devolve o assento ao conjunto.

Grupos e funções

Os grupos conectam membros a funções personalizadas ("role-based access control" (controle de acesso baseado em funções), ou RBAC, o rbac nos caminhos dos endpoints e nos nomes dos escopos). Os grupos pertencem à sua empresa como um todo (a organização pai junto com todas as organizações sob ela) e não a uma única organização, portanto os escopos de grupo (read:rbac_groups e write:rbac_groups) exigem uma chave criada para todas as organizações vinculadas. Cada grupo possui um source_type: direct para grupos criados no claude.ai, scim para grupos provisionados pelo seu provedor de identidade. O campo roles de um grupo lista os IDs das funções personalizadas anexadas a ele; resolva-os para nomes e permissões com os endpoints de funções personalizadas, observando que o catálogo de funções é por organização enquanto os grupos abrangem toda a empresa, portanto buscar uma função que pertence a uma organização diferente da sua empresa retorna 404 para a sua chave. O campo é null (em vez de []) quando os dados de função estavam temporariamente indisponíveis, então tente novamente para distinguir uma leitura degradada de um grupo sem funções.

Limites de taxa

Os endpoints da Admin API compartilham um "rate limit" (limite de taxa) por organização de 100 requisições por minuto; a criação de convites tem seu próprio limite de 1.200 requisições por hora. Requisições acima de um limite retornam 429 Too Many Requests.

Paginação

As listas de membros e convites usam paginação baseada em ID: passe limit (padrão 20, máximo 1000) mais no máximo um entre before_id ou after_id, e pagine usando os campos first_id e last_id de cada resposta até que has_more seja false. As listas de grupos e funções personalizadas usam um cursor opaco: o valor next_page da resposta é passado sem alteração como o parâmetro page na próxima requisição, até que next_page seja null.

Respostas de erro

As respostas de erro seguem o formato padrão documentado em Erros.

Membros

Listar membros

GET /v1/organizations/users retorna os membros da organização, os adicionados mais recentemente primeiro. Filtre por email para procurar um membro específico; a correspondência não diferencia maiúsculas de minúsculas e tolera variantes comuns do mesmo endereço (por exemplo, jane+hiring@example.com corresponde a jane@example.com). Requer o escopo read:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Listar usuários na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/users?email=jane@example.com" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01"

Obter um membro

GET /v1/organizations/users/{user_id} retorna um membro por ID. Requer o escopo read:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Obter usuário na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/users/user_01AbCdEfGhIjKlMnOpQrSt" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01"

Alterar a função de um membro

POST /v1/organizations/users/{user_id} define a função do membro como user ou managed. Membros que possuem uma função administrativa (owner, membership_admin ou primary_owner) não podem ser alterados por meio deste endpoint, e funções administrativas não podem ser atribuídas; ambos retornam 400 e são gerenciados nas configurações da organização no claude.ai. Se o provedor de identidade da sua organização gerencia funções (SSO avançado ou provisionamento SCIM avançado), as atualizações de função retornam 400. Requer o escopo write:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Atualizar usuário na referência da API.

cURL
curl -X POST "https://api.anthropic.com/v1/organizations/users/user_01AbCdEfGhIjKlMnOpQrSt" \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{"role": "managed"}'

Remover um membro

DELETE /v1/organizations/users/{user_id} remove o membro da organização, devolvendo qualquer assento adquirido que ele ocupava ao conjunto da organização. Membros que possuem uma função administrativa não podem ser removidos por meio deste endpoint, e se o seu provedor de identidade gerencia a associação de membros (SCIM), as remoções retornam 400. Requer o escopo write:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Remover usuário na referência da API.

cURL
curl -X DELETE "https://api.anthropic.com/v1/organizations/users/user_01AbCdEfGhIjKlMnOpQrSt" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01"
{
  "type": "user_deleted",
  "id": "user_01AbCdEfGhIjKlMnOpQrSt"
}

Convites

Criar um convite

POST /v1/organizations/invites envia um e-mail de convite e retorna o convite com um expires_at atribuído pelo servidor. role deve ser user ou managed. Se já existir um convite pendente para o endereço de e-mail, ou se o endereço já pertencer a um membro, a requisição retorna 400 indicando o recurso existente. Organizações cujo provedor de identidade provisiona usuários automaticamente (JIT ou SCIM) não podem criar convites por meio da API. Requer o escopo write:members.

Em planos que obtêm membros de um conjunto finito de assentos, o convite ocupa automaticamente um assento do nível mais baixo que tenha disponibilidade; a API não aceita um parâmetro de nível. Se não houver assento livre, a requisição falha com um erro 400 em vez de adquirir um assento. Adicione assentos por meio do gerenciamento de plano da organização e tente novamente.

O campo opcional rbac_group_ids lista grupos (por ID com prefixo rbac_group_) a serem atribuídos ao membro quando ele aceitar. Passar um rbac_group_ids não vazio exige adicionalmente que a chave possua o escopo write:rbac_groups, porque a atribuição de grupos pode conceder as permissões anexadas às funções do grupo.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Criar convite na referência da API.

cURL
curl -X POST "https://api.anthropic.com/v1/organizations/invites" \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "email": "newhire@example.com",
    "role": "managed",
    "rbac_group_ids": ["rbac_group_01UvWxYzAbCdEfGhIjKlMn"]
  }'
{
  "type": "invite",
  "id": "invite_01QrStUvWxYzAbCdEfGhIj",
  "email": "newhire@example.com",
  "role": "managed",
  "invited_at": "2026-07-06T16:20:11Z",
  "expires_at": "2026-07-27T16:20:11Z",
  "accepted_at": null,
  "status": "pending",
  "rbac_group_ids": ["rbac_group_01UvWxYzAbCdEfGhIjKlMn"]
}

Listar convites

GET /v1/organizations/invites retorna os convites da organização, os mais recentes primeiro, nos estados pending, accepted e expired; não há filtro de status. Requer o escopo read:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Listar convites na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/invites?limit=20" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01"

Obter um convite

GET /v1/organizations/invites/{invite_id} retorna um convite por ID. Requer o escopo read:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Obter convite na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/invites/invite_01QrStUvWxYzAbCdEfGhIj" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01"

Retirar um convite

DELETE /v1/organizations/invites/{invite_id} retira um convite pending, desativando o link no e-mail de convite. Retirar um convite accepted retorna 400 (remova o membro em vez disso); retirar um convite expired retorna 400. Requer o escopo write:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Excluir convite na referência da API.

cURL
curl -X DELETE "https://api.anthropic.com/v1/organizations/invites/invite_01QrStUvWxYzAbCdEfGhIj" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -H "anthropic-version: 2023-06-01"

Grupos

Os grupos que sua empresa cria diretamente, nas configurações da organização no claude.ai ou por meio desta API (source_type: "direct"), suportam todos os endpoints desta seção. Grupos provisionados pelo seu provedor de identidade (source_type: "scim") podem ser lidos, mas não modificados: renomear ou excluir um grupo SCIM, ou alterar seus membros, retorna 400, porque seu provedor de identidade é o proprietário dele. Diferentemente das requisições de membros e convites, as requisições de grupos não exigem o cabeçalho anthropic-version.

Listar grupos

GET /v1/organizations/rbac_groups retorna os grupos da sua empresa, incluindo grupos gerenciados pelo provedor de identidade (scim). Requer o escopo read:rbac_groups.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Listar grupos na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/rbac_groups?limit=20" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY"
{
  "data": [
    {
      "type": "rbac_group",
      "id": "rbac_group_01UvWxYzAbCdEfGhIjKlMn",
      "name": "Engineering",
      "source_type": "direct",
      "roles": ["rbac_role_01CdEfGhIjKlMnOpQrStUv"],
      "created_at": "2026-03-18T10:01:42Z",
      "updated_at": "2026-05-02T08:55:09Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Obter um grupo

GET /v1/organizations/rbac_groups/{group_id} retorna um grupo por ID. Requer o escopo read:rbac_groups.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Obter grupo na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/rbac_groups/rbac_group_01UvWxYzAbCdEfGhIjKlMn" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY"

Criar um grupo

POST /v1/organizations/rbac_groups cria um grupo com o name fornecido (1 a 255 caracteres) e sem funções ou membros. Requer o escopo write:rbac_groups.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Criar grupo na referência da API.

cURL
curl -X POST "https://api.anthropic.com/v1/organizations/rbac_groups" \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -d '{"name": "Engineering"}'
{
  "type": "rbac_group",
  "id": "rbac_group_01UvWxYzAbCdEfGhIjKlMn",
  "name": "Engineering",
  "source_type": "direct",
  "roles": [],
  "created_at": "2026-07-09T18:00:00Z",
  "updated_at": "2026-07-09T18:00:00Z"
}

Renomear um grupo

POST /v1/organizations/rbac_groups/{group_id} atualiza o grupo. name é o único campo que este endpoint pode alterar. Requer o escopo write:rbac_groups.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Atualizar grupo na referência da API.

cURL
curl -X POST "https://api.anthropic.com/v1/organizations/rbac_groups/rbac_group_01UvWxYzAbCdEfGhIjKlMn" \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -d '{"name": "Platform Engineering"}'

Excluir um grupo

DELETE /v1/organizations/rbac_groups/{group_id} exclui o grupo. Seus membros continuam sendo membros de suas organizações, mas perdem as permissões das funções anexadas a ele, e um limite de gastos de grupo, se existia, deixa de se aplicar a eles. Requer o escopo write:rbac_groups.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Excluir grupo na referência da API.

cURL
curl -X DELETE "https://api.anthropic.com/v1/organizations/rbac_groups/rbac_group_01UvWxYzAbCdEfGhIjKlMn" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY"
{
  "id": "rbac_group_01UvWxYzAbCdEfGhIjKlMn",
  "type": "rbac_group_deleted"
}

Listar os membros de um grupo

GET /v1/organizations/rbac_groups/{group_id}/members retorna os membros do grupo (cada um com seu user_id e e-mail), os mais antigos primeiro. Apenas membros atuais das organizações da sua empresa são retornados, portanto uma página pode conter menos de limit entradas enquanto has_more é true. Requer o escopo read:rbac_groups.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Listar membros do grupo na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/rbac_groups/rbac_group_01UvWxYzAbCdEfGhIjKlMn/members?limit=100" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY"
{
  "data": [
    {
      "type": "rbac_group_member",
      "group_id": "rbac_group_01UvWxYzAbCdEfGhIjKlMn",
      "user_id": "user_01AbCdEfGhIjKlMnOpQrSt",
      "email": "jane@example.com",
      "created_at": "2026-04-07T12:30:00Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Adicionar um membro a um grupo

POST /v1/organizations/rbac_groups/{group_id}/members adiciona um membro da organização ao grupo por user_id. O usuário já deve ser membro de uma das organizações da sua empresa (caso contrário, a requisição retorna 404), e adicionar alguém que já está no grupo retorna 400. Para grupos scim, a associação de membros é gerenciada no seu provedor de identidade e esta requisição retorna 400. Para atribuir grupos a uma pessoa que ainda não ingressou, use rbac_group_ids na criação de convite. Requer o escopo write:rbac_groups.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Adicionar membro ao grupo na referência da API.

cURL
curl -X POST "https://api.anthropic.com/v1/organizations/rbac_groups/rbac_group_01UvWxYzAbCdEfGhIjKlMn/members" \
  -H "content-type: application/json" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  -d '{"user_id": "user_01AbCdEfGhIjKlMnOpQrSt"}'
{
  "type": "rbac_group_member",
  "group_id": "rbac_group_01UvWxYzAbCdEfGhIjKlMn",
  "user_id": "user_01AbCdEfGhIjKlMnOpQrSt",
  "email": "jane@example.com",
  "created_at": "2026-07-09T18:00:00Z"
}

Remover um membro de um grupo

DELETE /v1/organizations/rbac_groups/{group_id}/members/{user_id} remove o membro do grupo; ele continua sendo membro de sua organização. A requisição retorna 404 se o usuário não for membro do grupo, e 400 para grupos scim, cuja associação de membros é gerenciada no seu provedor de identidade. Requer o escopo write:rbac_groups.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Remover membro do grupo na referência da API.

cURL
curl -X DELETE "https://api.anthropic.com/v1/organizations/rbac_groups/rbac_group_01UvWxYzAbCdEfGhIjKlMn/members/user_01AbCdEfGhIjKlMnOpQrSt" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY"
{
  "group_id": "rbac_group_01UvWxYzAbCdEfGhIjKlMn",
  "user_id": "user_01AbCdEfGhIjKlMnOpQrSt",
  "type": "rbac_group_member_deleted"
}

Funções personalizadas

As funções personalizadas são somente leitura por meio da API: esses endpoints catalogam as funções personalizadas da sua organização (definidas nas configurações da organização no claude.ai ou provisionadas pela Anthropic) e as permissões que cada função concede. As leituras de funções personalizadas usam o escopo read:members (não há um escopo de função separado) e funcionam com uma chave de nível de organização: diferentemente dos endpoints de grupos, elas não exigem uma chave criada para todas as organizações vinculadas, e o catálogo retornado é o da sua própria organização.

Listar funções

GET /v1/organizations/rbac_roles retorna as funções personalizadas da sua organização. Requer o escopo read:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Listar funções na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/rbac_roles?limit=20" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY"
{
  "data": [
    {
      "type": "rbac_role",
      "id": "rbac_role_01CdEfGhIjKlMnOpQrStUv",
      "name": "Engineering base",
      "created_at": "2026-03-18T10:01:42Z",
      "updated_at": "2026-05-02T08:55:09Z"
    }
  ],
  "has_more": false,
  "next_page": null
}

Obter uma função

GET /v1/organizations/rbac_roles/{role_id} retorna uma função por ID. Requer o escopo read:members.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Obter função na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/rbac_roles/rbac_role_01CdEfGhIjKlMnOpQrStUv" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY"

Listar as permissões de uma função

GET /v1/organizations/rbac_roles/{role_id}/permissions retorna as permissões da função. Cada permissão combina um resource (a que ela se aplica: os recursos de produto da organização, uma ferramenta de conector, um escopo OAuth de conector, um conector ou todos os conectores) com uma action (o que ela concede sobre esse recurso). Linhas de recursos não habilitados para sua organização são omitidas, portanto uma página pode conter menos de limit linhas enquanto has_more é true. Requer o escopo read:members.

Dois valores de action exigem cuidado especial: uma permissão organization cuja ação é capability_access_all (todos os recursos de produto) ou capability_access_all_ga (todos os recursos de produto estáveis, ou seja, todos os recursos não rotulados como beta ou prévia de pesquisa) é uma concessão abrangente (que não cobre nem o acesso a modelos nem as permissões do painel de administração com prefixo permission_) e é listada como essa única linha em vez de expandida. Ao contabilizar o que uma função concede, trate uma linha abrangente como cobrindo tudo o que sua variante descreve, não apenas os recursos nomeados em outras linhas.

Para detalhes completos dos parâmetros e esquemas de resposta, consulte Listar permissões da função na referência da API.

cURL
curl "https://api.anthropic.com/v1/organizations/rbac_roles/rbac_role_01CdEfGhIjKlMnOpQrStUv/permissions?limit=20" \
  -H "x-api-key: $ANTHROPIC_ADMIN_KEY"
{
  "data": [
    {
      "type": "rbac_role_permission",
      "resource": {
        "type": "organization",
        "organization_id": "12345678-1234-5678-1234-567812345678"
      },
      "action": "capability_access_all_ga"
    },
    {
      "type": "rbac_role_permission",
      "resource": {
        "type": "connector_tool",
        "connector_id": "mcpsrv_01WxYzAbCdEfGhIjKlMnOp",
        "tool_name": "search_tickets"
      },
      "action": "use"
    }
  ],
  "has_more": false,
  "next_page": null
}

Exemplos de fluxos de trabalho

Desligar um funcionário que está saindo

  1. Procure o membro por e-mail:

    cURL
    curl "https://api.anthropic.com/v1/organizations/users?email=departing@example.com" \
      -H "x-api-key: $ANTHROPIC_ADMIN_KEY" \
      -H "anthropic-version: 2023-06-01"
  2. Remova-o com DELETE /v1/organizations/users/{user_id}, usando o id da resposta. Seu assento, se houver, retorna ao conjunto.

  3. Se a pessoa ainda não havia ingressado, a busca não retorna nenhum membro; liste os convites e retire o convite pending dela.

Auditar a associação a grupos

  1. Liste os grupos e registre o id, name e roles de cada grupo.

  2. Para cada grupo que possui funções sensíveis, pagine por GET /v1/organizations/rbac_groups/{group_id}/members e compare os e-mails dos membros com a lista do seu provedor de identidade.

  3. Remova os membros que não deveriam mais estar no grupo com DELETE /v1/organizations/rbac_groups/{group_id}/members/{user_id}. Para grupos scim, faça a alteração no seu provedor de identidade.

Para um fluxo de trabalho que combina associação a grupos com um aumento temporário do limite de gastos, consulte Aumentar temporariamente o limite de gastos de um membro durante um incidente na página da Spend Limits API.

Perguntas frequentes

Esta é uma API diferente da Admin API?

Não. Os endpoints de membros e convites são os mesmos endpoints /v1/organizations/ que as organizações do Claude Console usam; esta página documenta seu comportamento no Claude Enterprise. Os endpoints de grupos e funções personalizadas fazem parte da mesma API e existem apenas para organizações Claude Enterprise. A tabela de disponibilidade mostra quais endpoints cada tipo de organização pode chamar.

Posso atribuir a função de proprietário ou administrador de membros por meio da API?

Não. A API atribui apenas user e managed, na criação de convites e nas atualizações de função. As funções administrativas são atribuídas nas configurações da organização no claude.ai, e os membros que as possuem não podem ser modificados ou removidos por meio da API.

Posso criar ou modificar grupos por meio da API?

Sim, com o escopo write:rbac_groups: criar, renomear e excluir grupos, e adicionar ou remover seus membros. Duas coisas a API não pode alterar: grupos provisionados pelo seu provedor de identidade (source_type: "scim"), cujo nome e membros pertencem ao provedor de identidade, e funções personalizadas, que são gerenciadas nas configurações da organização no claude.ai (a API as lê).

Um convite não aceito consome um assento?

Em planos com um conjunto finito de assentos, sim: um convite pending ocupa um assento. Retirar o convite ou deixá-lo expirar libera o assento. Em planos sem conjunto de assentos, os convites não consomem nada.

Minha organização usa single sign-on. Quais operações funcionam?

Se o seu provedor de identidade provisiona usuários automaticamente (JIT ou SCIM), a criação de convites retorna 400. Se ele gerencia funções (SSO avançado ou provisionamento SCIM avançado), as atualizações de função retornam 400. Se ele gerencia a associação de membros (provisionamento SCIM), as remoções de membros retornam 400. As leituras funcionam independentemente disso.

O que acontece com uma chave de Admin API quando a pessoa que a criou sai?

A chave continua funcionando. As chaves de Admin API têm escopo na organização, não em usuários individuais, e uma chave criada no claude.ai não expira. Remover o criador da organização ou desprovisioná-lo por meio do seu provedor de identidade encerra o acesso dele, mas não as chaves que ele criou. Rebaixar a função dele também não altera as chaves: cada chave permanece ativa com seus escopos originais. Ao desligar alguém que criou chaves de Admin API, exclua essas chaves na seção Keys de claude.ai > Configurações da organização > API e crie substitutas.

Veja também

Onde seu proprietário principal cria uma chave com escopo e quais escopos selecionar.

Audite atividades e recupere ou exclua conteúdo de usuários em toda a sua organização.

Relatórios de uso e custo por usuário e por intervalo de tempo para o Claude Enterprise.

Defina limites de gastos por membro e revise solicitações de aumento.

Was this page helpful?