getOAuthAuthorization

GET

/api/v1/oauth/authorizations/{authorization_id}

const url = 'https://dev.api.endueos.com/api/v1/oauth/authorizations/oaz_01J9ZK3Q8M4XW7D2N5R6T0V1BC';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dev.api.endueos.com/api/v1/oauth/authorizations/oaz_01J9ZK3Q8M4XW7D2N5R6T0V1BC \
  --header 'Authorization: Bearer <token>'

인증

Bearer 토큰 — 사용자 JWT 또는 osk_ 키

파라미터

경로 파라미터

authorization_id

필수

인가 요청 하나 — /oauth/authorize 가 만들고 console 동의 화면이 읽는다. 수명 10분.

string

/^oaz_[0-9A-HJKMNP-TV-Z]{26}$/

예시

oaz_01J9ZK3Q8M4XW7D2N5R6T0V1BC

응답

200

성공.

application/json

object

data

필수

동의 화면에 그릴 것.

object

authorization_id

필수

인가 요청 하나 — /oauth/authorize 가 만들고 console 동의 화면이 읽는다. 수명 10분.

string

/^oaz_[0-9A-HJKMNP-TV-Z]{26}$/

client

필수

object

client_id

필수

OAuth 클라이언트 (등록된 외부 앱).

string

/^oac_[0-9A-HJKMNP-TV-Z]{26}$/

name

필수

동의 화면·연결된 앱 목록에 보이는 이름. 예: endue AI

string

redirect_host

필수

돌아갈 곳의 호스트 (redirect_uri 의 host[:port]). 예: dev.endue.ai

string

scopes

필수

요청된 스코프 (클라이언트에 허용된 것만 남는다).

Array<string>

허용 값: stations:read devices:read devices:control workspaces:read workspaces:write offline_access

expires_at

필수

string format: date-time

status

필수

pending — 동의를 기다린다
approved — 허용됨, 인가 코드가 나갔다 (아직 교환 전)
denied — 거부됨
redeemed — 인가 코드가 토큰으로 교환됐다
expired — 수명(10분)이 지났다

string

허용 값: pending approved denied redeemed expired

meta

필수

object

request_id

필수

string

timestamp

필수

string format: date-time

duration

서버 처리 시간(ms).

integer format: int32

예시

{
  "data": {
    "authorization_id": "oaz_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "client": {
      "client_id": "oac_01J9ZK3Q8M4XW7D2N5R6T0V1BC"
    },
    "scopes": [
      "stations:read"
    ],
    "status": "pending"
  }
}

401

인증이 없거나 무효다 — UNAUTHORIZED. 본문은 오류 봉투.

403

이 인증 수단으로는 못 하는 일이다 — FORBIDDEN (예: API 키로 클라우드 기기 만들기). 본문은 오류 봉투.

404

없거나 내 것이 아니다 — *_NOT_FOUND. 본문은 오류 봉투.

410

보관 기간이 지났다 — OUTPUT_EXPIRED. 본문은 오류 봉투.

429

한도를 넘었다 — Retry-After 초 뒤에 다시. 본문은 오류 봉투.

500

서버 오류 — INTERNAL_ERROR. 본문은 오류 봉투.

503

의존 서비스에 닿지 못했다 — 잠시 뒤 다시. 본문은 오류 봉투.