콘텐츠로 건너뛰기

관리 API

범위가 지정된 API 키로 백엔드에서 조직 리소스를 관리합니다.

Markdown으로 보기

인증

관리 API 호출은 Authorization: Bearer sk_live_* 또는 Authorization: Bearer sk_test_*를 사용합니다. 키는 조직별로 범위가 제한되며 각 리소스 작업 전에 검사됩니다.

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

리소스

리소스 기능 상태
/v1/users 사용자를 생성, 조회, 업데이트, 차단, 차단 해제, 내보내기, 제거합니다. 구현됨
/v1/organizations 조직, 도메인, 브랜딩, 설정을 관리합니다. 구현됨
/v1/organizations/:orgId/memberships 멤버를 조회, 추가, 역할 업데이트, 제거합니다. 구현됨
/v1/organizations/:orgId/invitations 초대를 생성(bulk 제한 있음), 폐기, 조회합니다. 구현됨
/v1/sessions 사용자 세션을 조회, 가져오기, 폐기합니다. 구현됨
/v1/applications OAuth 클라이언트, 리디렉션 URI, 권한 부여, 토큰 정책, 비밀값을 등록합니다. 구현됨
/v1/connections Upstream 엔터프라이즈 SSO 연결을 관리합니다. 구현됨
/v1/directories SCIM 디렉터리를 만들고 디렉터리 토큰을 순환합니다. 구현됨
/v1/roles 사용자 정의 역할을 생성, 조회, 업데이트, 삭제합니다. 구현됨
/v1/permissions 권한을 생성, 조회, 업데이트, 삭제합니다. 구현됨
/v1/users/:userId/emailAddresses 기본 이메일 주소를 추가, 제거, 설정합니다. 구현됨
/v1/users/:userId/phoneNumbers 기본 전화번호를 추가, 제거, 설정합니다. 구현됨
/v1/allowlist-identifiers 허용된 이메일 또는 도메인 식별자를 생성, 삭제, 조회합니다. 구현됨
/v1/oauth-applications XID가 ID 공급자로 동작하는 OAuth 애플리케이션을 관리합니다. 구현됨
/v1/redirect-urls 허용된 리디렉션 URL 값을 등록 및 제거합니다. 구현됨
/v1/webhooks Webhook 엔드포인트를 생성, 조회, 업데이트, 삭제합니다. 구현됨
/v1/api-keys 조직 API 키를 생성, 조회, 폐기합니다. 구현됨
/v1/billing 플랜 조회, 구독 관리, 결제 내역 확인. 계획됨

페이지네이션 및 오류

목록 엔드포인트는 데이터 배열과 커서 메타데이터를 반환합니다. 오류는 안정적인 코드, 읽기 쉬운 메시지, 필드 검증용 선택적 메타데이터를 포함한 구조화된 JSON을 사용합니다.

탐색

입력하여 검색...

화살표 키로 이동Enter 키로 선택Escape 키로 닫기