API 레퍼런스
로그인
본문으로 건너뛰기

호출자 확인

GET/v1/me

지금 호출하는 주체(사용자 세션 또는 API 키)와 그 조직, 워크스페이스, 키 권한을 돌려줍니다

API 키 권한 read 또는 콘솔 세션으로 부릅니다, 콘솔 세션은 조직 역할 owner, admin, developer만 됩니다

Headers

  • Authorization: optional string
    Bearer xci_live_… 워크스페이스 API 키, 키 권한 read(run 키도 가능), 콘솔 세션 쿠키로 대신할 수 있습니다

Returns

200 application/json

  • Me: object
    • auth: "api_key" or "console_session"
      api_key 또는 console_session
    • user: optional object { id, email, name } or null
      세션 호출이면 사용자, 키 호출이면 null
      • id: optional string
        ID
      • email: optional string
        이메일
      • name: optional string
        이름
    • api_key: optional object { id, name, permission } or null
      키 호출이면 키 정보, 세션이면 null
      • id: optional string
        ID
      • name: optional string
        이름
      • permission: optional "run" or "read"
        권한(run 또는 read)
    • organization: optional object { id, name, role } or null
      조직과 호출자의 역할(키 호출이면 role은 null)
      • id: optional string
        ID
      • name: optional string
        이름
      • role: optional "owner" or "admin" or "developer" or null
        역할(owner, admin, developer)
    • workspace: optional object { id, name } or null
      키가 묶인 워크스페이스, 세션이면 null
      • id: optional string
        ID
      • name: optional string
        이름

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • api_key_required: HTTP 401
    API 키 엔드포인트에 Authorization: Bearer 헤더가 없습니다
  • api_key_revoked_leaked: HTTP 401
    공개 유출 신고로 자동 폐기된 키입니다, 새 키를 발급하세요
  • invalid_api_key: HTTP 401
    모르는 키이거나 폐기, 만료, 체크섬 불일치입니다(종료된 xeno_ 접두사 포함)
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • ip_not_allowed: HTTP 403
    요청 IP가 조직 또는 API 키의 IP 허용 목록 밖입니다, details.ip와 details.list(organization 또는 api_key)에 있습니다
  • organization_suspended: HTTP 403
    운영자가 조직을 정지했습니다, 키는 거부되고 실행 중인 잡은 멈춥니다
  • rate_limited: HTTP 429, 다시 시도 가능
    이 키 또는 조직의 요청이 너무 많습니다, retry_after_s만큼 기다리세요
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다