---
title: "管理 API"
description: "使用带 scope 的 API 密钥在后端管理组织资源。"
locale: "zh-Hans"
---

> Documentation Index
> Fetch the locale documentation index at: https://xid.dev/zh-hans/llms.txt
> Use this file to discover all available pages before exploring further.

# 管理 API

## 认证

管理 API 调用使用 `Authorization: Bearer sk_live_*` 或 `Authorization: Bearer sk_test_*`。密钥按组织限定范围，并在每次资源操作前检查。

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

## 资源

| 资源 | 能力 | 状态 |
| --- | --- | --- |
| `/v1/users` | 创建、读取、更新、封禁、解除封禁、导出和移除用户。 | 已实现 |
| `/v1/organizations` | 管理组织、域名、品牌和设置。 | 已实现 |
| `/v1/organizations/:orgId/memberships` | 列出、创建、更新角色和移除成员。 | 已实现 |
| `/v1/organizations/:orgId/invitations` | 创建（有批量上限）、吊销和列出邀请。 | 已实现 |
| `/v1/sessions` | 列出、获取和吊销用户会话。 | 已实现 |
| `/v1/applications` | 注册 OAuth 客户端、重定向 URI、授权类型、令牌策略和密钥。 | 已实现 |
| `/v1/connections` | 管理上游企业 SSO 连接。 | 已实现 |
| `/v1/directories` | 创建 SCIM 目录并轮换目录令牌。 | 已实现 |
| `/v1/roles` | 创建、读取、更新和删除自定义角色。 | 已实现 |
| `/v1/permissions` | 创建、读取、更新和删除权限。 | 已实现 |
| `/v1/users/:userId/emailAddresses` | 添加、移除和设置主邮箱地址。 | 已实现 |
| `/v1/users/:userId/phoneNumbers` | 添加、移除和设置主手机号。 | 已实现 |
| `/v1/allowlist-identifiers` | 创建、删除和列出允许的邮箱或域名标识符。 | 已实现 |
| `/v1/oauth-applications` | 管理以 XID 作为身份提供商的 OAuth 应用。 | 已实现 |
| `/v1/redirect-urls` | 注册和移除允许的重定向 URL。 | 已实现 |
| `/v1/webhooks` | 创建、列出、更新和删除 webhook 端点。 | 已实现 |
| `/v1/api-keys` | 创建、列出和吊销组织 API 密钥。 | 已实现 |
| `/v1/billing` | 查看套餐、管理订阅和查看付款历史。 | 计划中 |

## 分页和错误

列表端点返回数据数组和游标元数据。错误使用结构化 JSON，包含稳定代码、易读消息，以及可选的字段校验元数据。

Source: https://xid.dev/zh-hans/management-api/index.mdx