Saltar al contenido

API de administración

Usa claves API con alcance para gestionar recursos de la organización desde tu backend.desde tu servidor.

Ver como Markdown

Autenticación

Las llamadas a la API de administración usan Authorization: Bearer sk_live_* o Authorization: Bearer sk_test_*. Las claves tienen alcance por organización y se verifican antes de cada acción sobre recursos.

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

Recursos

Recurso Capacidades Estado
/v1/users Crear, leer, actualizar, suspender, reactivar, exportar y eliminar usuarios. Implementado
/v1/organizations Gestiona organizaciones, dominios, marca y configuración. Implementado
/v1/organizations/:orgId/memberships Listar, crear, actualizar rol y eliminar miembros. Implementado
/v1/organizations/:orgId/invitations Crear (con límite masivo), revocar y listar invitaciones. Implementado
/v1/sessions Listar, obtener y revocar sesiones de usuario. Implementado
/v1/applications Registrar clientes OAuth, URI de redirección, concesiones, política de tokens y secretos. Implementado
/v1/connections Gestionar conexiones SSO empresariales upstream. Implementado
/v1/directories Crear directorios SCIM y rotar tokens de directorio. Implementado
/v1/roles Crear, leer, actualizar y eliminar roles personalizados. Implementado
/v1/permissions Crear, leer, actualizar y eliminar permisos. Implementado
/v1/users/:userId/emailAddresses Añadir, eliminar y establecer direcciones de correo principales. Implementado
/v1/users/:userId/phoneNumbers Añadir, eliminar y establecer números de teléfono principales. Implementado
/v1/allowlist-identifiers Crear, eliminar y listar identificadores de correo o dominio permitidos. Implementado
/v1/oauth-applications Gestiona aplicaciones OAuth donde XID actúa como proveedor de identidad. Implementado
/v1/redirect-urls Registrar y eliminar valores de URL de redirección permitidos. Implementado
/v1/webhooks Crear, listar, actualizar y eliminar endpoints de webhook. Implementado
/v1/api-keys Crear, listar y revocar claves API de organización. Implementado
/v1/billing Consultar planes, gestionar suscripciones y ver historial de pagos. Planificado

Paginación y errores

Los puntos de conexión de lista devuelven un arreglo data y metadatos de cursor. Los errores usan JSON estructurado con un código estable, un mensaje legible y metadatos opcionales para validación de campos.

Navegación

Escribe para buscar...

Usa las flechas para navegarPulsa Intro para seleccionarPulsa Escape para cerrar