가상 사용자 조회

(GET) /v1/organization/user

현재 사용중인 가상 사용자 목록을 조회합니다.


Request

Headers

이름
타입
필수여부

Content-Type

application/json; charset=utf-8

String

O

X-OUTCODE-API-KEY

조직 API 키

String

O

X-OUTCODE-USER-API-KEY

조직 사용자 API 키

String

O

Queries

이름
타입
필수여부

limit

페이지당 조회할 개수를 지정합니다. * 가능범위 : 1 ~ 100 미지정시 기본값 100

Number

X

offset

페이지 범위를 지정합니다. * 미지정시 기본값 0

Number

X


Response

200 (Success)

가상 사용자 목록을 반환합니다.

이름
타입

success

실행 결과 (true: 성공 / false: 실패)

Boolean

code

status code

Number

timestamp

API 호출 일시 (UTC)

Date

message

API 실행 결과

String

data

가상 사용자 정보

Object

data.users[]

가상 사용자 목록

Array

data.users[].org_user_id

조직 구성원 ID

Number

data.users[].organization_id

조직 ID

Number

data.users[].auth

회원의 권한 (기본값 : 2)

Number

data.users[].user_id

회원 ID

Number

data.users[].name

회원명

String

data.users[].api_key

회원의 API KEY

String

data.meta

페이징 정보

Object

data.meta.totalItems

총 유저 수

Number

data.meta.totalPages

총 페이지 개수

Number

data.meta.currentPage

현재 페이지 번호

Number

data.meta.pageSize

페이지당 조회 개수

Number

400 (Failure)

이미 이메일을 등록한 사용자가 존재합니다.

이름
타입

success

실행 결과 (true: 성공 / false: 실패)

Boolean

code

status code

Number

timestamp

API 호출 일시 (UTC)

Date

message

실패 사유 메세지

String

401 (Failure)

유효한 조직 API 키가 아닙니다.

이름
타입

success

실행 결과 (true: 성공 / false: 실패)

Boolean

code

status code

Number

timestamp

API 호출 일시 (UTC)

Date

message

실패 사유 메세지

String

5xx (Failure)

처리중 서버 내에서 오류가 발생한 경우에 발생됩니다.

이름
타입

success

실행 결과 (true: 성공 / false: 실패)

Boolean

code

status code

Number

timestamp

API 호출 일시 (UTC)

Date

message

실패 사유 메세지

String

Last updated