listOrgs

GET

/api/v1/orgs

const url = 'https://dev.api.endueos.com/api/v1/orgs';
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/orgs \
  --header 'Authorization: Bearer <token>'

내가 속한 조직들. Default Organization 이 맨 앞, 나머지는 이름순. 하나도 없으면 Default Organization 을 만들어 돌려준다.

인증

파라미터

쿼리 파라미터

page

integer format: int32

1 부터. 기본 1.

limit

integer format: int32

기본 20, 최대 200 (넘으면 200 으로 줄인다).

응답

200

성공.

application/json

object

data

필수

Array<object>

조직. 사용자마다 Default Organization(personal: true) 이 하나 있다 — 지울 수 없다.

object

org_id

필수

조직 — 크레딧·결제·멤버의 주인 (D-46 · D-60).

string

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

name

필수

string

description

필수

Any of:

string
null

string

personal

필수

Default Organization — 사용자마다 하나, 처음 쓸 때 생긴다. 지울 수 없다.

boolean

role

필수

부른 사람의 역할.

string

허용 값: owner admin member

owner

필수

Any of:

object
null

사람 — 이름·이메일은 그 사람이 endue OS 에 마지막으로 로그인했을 때의 토큰에서 온다. 한 번도 로그인하지 않았으면 null.

object

user_id

필수

usr_{Keycloak sub} — ULID 가 아니다.

string

/^usr_.+$/

name

필수

Any of:

string
null

string

email

필수

Any of:

string
null

string

project_count

필수

지우지 않은 프로젝트 수.

integer format: int32

member_count

필수

integer format: int32

created_at

필수

string format: date-time

updated_at

필수

string format: date-time

meta

필수

object

request_id

필수

string

timestamp

필수

string format: date-time

duration

서버 처리 시간(ms).

integer format: int32

pagination

필수

object

page

필수

integer format: int32

limit

필수

integer format: int32

total

필수

integer format: int32

has_next_page

필수

boolean

예시

{
  "data": [
    {
      "org_id": "org_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
      "role": "owner"
    }
  ]
}

401

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

403

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

429

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

500

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

503

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