본문으로 건너뛰기

콘솔 세션 사용자의 전체 이름과 호칭 수정

PATCH/v1/me

콘솔 세션 전용입니다, 조직 역할 owner, admin, developer만 부를 수 있고 API 키로 부르면 403 console_only입니다

Headers

  • Cookie: string
    콘솔 로그인 세션 쿠키, 콘솔 전용 엔드포인트라 API 키로 부르면 403 console_only입니다
  • Origin: string
    콘솔 세션으로 상태를 바꿀 때 같은 출처(https://xenoci.com)여야 합니다, API 키 요청에는 필요 없습니다

Body

  • name: optional string
    전체 이름, 제어 문자 없이 1~80자
    80자 이하, 형식 ^[^\u0000-\u001f\u007f-\u009f]+$
  • preferred_name: optional string
    호칭, 제어 문자 없이 최대 80자, 빈 문자열이면 null로 지우고 생략하면 기존 값 유지
    80자 이하, 형식 ^[^\u0000-\u001f\u007f-\u009f]*$

Returns

200 application/json

  • 응답 본문: object
    • id: string
      사용자 ID
    • email: string
      이메일
    • name: string or null
      전체 이름
    • preferred_name: string or null
      호칭, 없으면 null

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • invalid_api_key: HTTP 401
    모르는 키이거나 폐기, 만료, 체크섬 불일치입니다(종료된 xeno_ 접두사 포함)
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • console_only: HTTP 403
    콘솔 세션 전용 엔드포인트입니다, API 키로는 결제, 키, 멤버 관리를 할 수 없습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요