사용자

사용자 정보 수정

put

사용자의 이름 또는 역할을 수정합니다.

사용처

사용자 이름 변경
사용자 역할 변경

제약 조건

name과 role 중 하나 이상 필수
name: 1~100자 (null이면 변경하지 않음)
role: USER, DESIGNER, MANAGER, ADMIN 중 선택 (null이면 변경하지 않음)

Authorizations

x-api-keystringRequired

Path parameters

idstringRequired

사용자 ID

Body

namestringOptional

변경할 이름 (null이면 변경하지 않음)

Example: 홍길동

rolestring · enumOptional

변경할 역할 (null이면 변경하지 않음)

Example: DESIGNERPossible values:

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

dataanyOptional

응답 데이터

put/api/v1/users/{id}

PUT /api/v1/users/{id} HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "name": "홍길동",
  "role": "DESIGNER"
}

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": null,
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

사용자 상태 변경

patch

사용자의 활성화 상태를 변경합니다.

사용처

사용자 계정 활성화 (ACTIVE)
사용자 계정 비활성화 (DELETE)

상태 값

ACTIVE: 사용자를 활성화합니다.
DELETE: 사용자를 비활성화합니다.

Authorizations

x-api-keystringRequired

Path parameters

idstringRequired

사용자 ID

Body

statusstring · enumRequired

변경할 상태 (ACTIVE: 활성화, DELETE: 비활성화)

Possible values:

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

dataanyOptional

응답 데이터

patch/api/v1/users/{id}

PATCH /api/v1/users/{id} HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "ACTIVE"
}

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": null,
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

사용자 목록 조회

get

사용자 목록을 조회합니다.

사용처

기업 소속 사용자 목록 조회
역할별, 카테고리별 사용자 필터링
사용자 검색 및 관리

페이지네이션

offset 기반 페이징 (0부터 시작)
limit: 페이지 크기 (최소 1, 최대 100)
응답의 hasNext로 다음 페이지 존재 여부 확인

필터 조건

email: 이메일 필터
name: 이름 필터
roles: 역할 필터 (USER, DESIGNER, MANAGER, ADMIN)
categoryId: 카테고리 ID 필터
sortType: 정렬 기준 (기본값: ID_DESC)

Authorizations

x-api-keystringRequired

Query parameters

emailstringOptional

이메일

namestringOptional

이름

categoryIdstringOptional

카테고리 ID

sortTypestring · enumOptional

정렬 타입

Default: ID_DESCPossible values:

offsetinteger · int32Required

페이지 번호 (0부터 시작, offset 페이징)

limitinteger · int32Required

페이지 크기 (최소: 1, 최대: 100)

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

get/api/v1/users

GET /api/v1/users?offset=1&limit=1 HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Accept: */*

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": {
    "content": [
      {
        "id": "text",
        "name": "text",
        "imageUrl": "text",
        "email": "text",
        "role": "USER",
        "categoryId": "text",
        "activated": true,
        "lastActiveAt": "2026-01-01T00:00:00.000Z",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "hasNext": true,
    "totalCount": 1
  },
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

사용자 생성

post

사용자를 생성합니다.

사용처

새로운 기업 사용자 등록
관리자가 사용자 계정 생성

제약 조건

비밀번호: 8~128자
이름: 1~100자
역할: USER, DESIGNER, MANAGER, ADMIN 중 선택
카테고리 ID: 선택 사항

Authorizations

x-api-keystringRequired

Body

namestringRequired

사용자 이름

Example: 홍길동

emailstringRequired

이메일

Example: hong@archisketch.com

passwordstringRequired

비밀번호

Example: password123

rolestring · enumRequired

역할

Example: DESIGNERPossible values:

categoryIdstringOptional

카테고리 ID (선택)

Example: category-id

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

dataanyOptional

응답 데이터

post/api/v1/users

POST /api/v1/users HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "홍길동",
  "email": "hong@archisketch.com",
  "password": "password123",
  "role": "DESIGNER",
  "categoryId": "category-id"
}

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": null,
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

사용자 비밀번호 변경

patch

사용자의 비밀번호를 변경합니다.

제약 조건

비밀번호: 8~128자
비활성화된 사용자도 변경 가능

Authorizations

x-api-keystringRequired

Path parameters

idstringRequired

사용자 ID

Body

passwordstringRequired

변경할 비밀번호

Responses

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json

resultstring · enumRequired

응답 결과 타입

Possible values:

dataanyOptional

응답 데이터

patch/api/v1/users/{id}/password

PATCH /api/v1/users/{id}/password HTTP/1.1
Host: openapi.archisketch.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}

200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

{
  "result": "SUCCESS",
  "data": null,
  "error": {
    "errorCode": "INTERNAL_ERROR",
    "message": "text"
  }
}

이전인증

다음카테고리

마지막 업데이트 4개월 전

도움이 되었나요?