Ir para o conteúdo

API de gerenciamento

Use chaves de API com escopo para gerenciar recursos da organização no backend.pelo seu servidor.

Ver como Markdown

Autenticação

Chamadas da API de gerenciamento usam Authorization: Bearer sk_live_* ou Authorization: Bearer sk_test_*. As chaves têm escopo por organização e são verificadas antes de cada ação de recurso.

curl https://xid.dev/v1/users \
  -H 'Authorization: Bearer sk_live_xxx'

Recursos

Recurso Recursos Estado
/v1/users Crie, leia, atualize, bana, remova banimento, exporte e remova usuários. Implementado
/v1/organizations Gerencie organizações, domínios, identidade visual e configurações. Implementado
/v1/organizations/:orgId/memberships Liste, crie, atualize o papel e remova membros. Implementado
/v1/organizations/:orgId/invitations Crie (com limite em massa), revogue e liste convites. Implementado
/v1/sessions Liste, obtenha e revogue sessões de usuário. Implementado
/v1/applications Registre clientes OAuth, URIs de redirecionamento, concessões, política de token e segredos. Implementado
/v1/connections Gerenciar conexoes SSO empresariais upstream. Implementado
/v1/directories Crie diretórios SCIM e rotacione tokens de diretório. Implementado
/v1/roles Crie, leia, atualize e exclua papéis personalizados. Implementado
/v1/permissions Crie, leia, atualize e exclua permissões. Implementado
/v1/users/:userId/emailAddresses Adicione, remova e defina endereços de e-mail principais. Implementado
/v1/users/:userId/phoneNumbers Adicione, remova e defina números de telefone principais. Implementado
/v1/allowlist-identifiers Crie, exclua e liste identificadores de e-mail ou domínio permitidos. Implementado
/v1/oauth-applications Gerencie aplicativos OAuth onde o XID atua como provedor de identidade. Implementado
/v1/redirect-urls Registre e remova valores de URL de redirecionamento permitidos. Implementado
/v1/webhooks Crie, liste, atualize e exclua endpoints de webhook. Implementado
/v1/api-keys Crie, liste e revogue chaves de API da organização. Implementado
/v1/billing Leia planos, gerencie assinaturas e visualize o histórico de pagamentos. Planejado

Paginação e erros

Endpoints de lista retornam um array de dados e metadados de cursor. Erros usam JSON estruturado com código estável, mensagem legível por humanos e metadados opcionais para validação de campos.

Navegação

Digite para pesquisar...

Use as teclas de seta para navegarPressione Enter para selecionarPressione Escape para fechar