User

Update User Information

put

Updates the user's name or role.

Use Cases

• Change user name

• Change user role

Constraints

• At least one of name or role is required

• name: 1 to 100 characters (if null, it will not be changed)

• role: choose from USER, DESIGNER, MANAGER, ADMIN (if null, it will not be changed)

Authorizations

open-api-key

Path parameters

idstringRequired

User ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

put/api/v1/users/{id}

HTTPcURLJavaScriptPython

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

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Change User Status

patch

Changes the user's activation status.

Use Cases

• Activate user account (ACTIVE)

• Deactivate user account (DELETE)

Status Values

• ACTIVE: Activates the user.

• DELETE: Deactivates the user.

Authorizations

open-api-key

Path parameters

idstringRequired

User ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

patch/api/v1/users/{id}

HTTPcURLJavaScriptPython

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

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Get User List

get

Retrieves the user list.

Use Cases

• Retrieve list of users belonging to the enterprise

• Filter users by role and category

• User search and management

Pagination

• Offset-based paging (starts from 0)

• limit: page size (min 1, max 100)

• Check existence of the next page using hasNext in the response

Filter Conditions

• email: Email filter

• name: Name filter

• roles: Role filter (USER, DESIGNER, MANAGER, ADMIN)

• categoryId: Category ID filter

• sortType: Sort criteria (default: ID_DESC)

Authorizations

open-api-key

Query parameters

emailstringOptional

Email

namestringOptional

Name

categoryIdstringOptional

Category ID

sortTypestring · enumOptional

Sort Type

Default: ID_DESCPossible values:

offsetinteger · int32Required

Page number (starts from 0, offset paging)

limitinteger · int32Required

Page size (min: 1, max: 100)

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

get/api/v1/users

HTTPcURLJavaScriptPython

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

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Create User

post

Creates a user.

Use Cases

• Register a new enterprise user

• Administrator creates a user account

Constraints

• Password: 8~128 characters

• Name: 1~100 characters

• Role: choose from USER, DESIGNER, MANAGER, ADMIN

• Category ID: Optional

Authorizations

open-api-key

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

post/api/v1/users

HTTPcURLJavaScriptPython

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

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Change User Password

patch

Changes the user's password.

Constraints

• Password: 8~128 characters

• Changeable even for deactivated users

Authorizations

open-api-key

Path parameters

idstringRequired

User ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

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

HTTPcURLJavaScriptPython

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

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content