System Admin

Collect metrics

get

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/dashboard/collect-metrics

Collects dashboard metrics. Requires authentication.

Header parameters

Client-IDstringRequiredExample: id_5f9b3c4d-e8a1-4b2f-9e7d-12a34b56c789

Client-SecretstringRequiredExample: sk_x7k9p2m4q8r5t1y3w6u0v9z2b4c6n8m

Responses

200

Metrics collected successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

get

/clients/v1/admin/dashboard/collect-metrics

HTTPcURLJavaScriptPython

GET /clients/v1/admin/dashboard/collect-metrics HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Update limit

put

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/users/{userId}/limits/update

Updates the storage limit for a specific user. Requires authentication.

Path parameters

userIdstringRequired

The ID of the user whose limit is to be updated.

Example: user123

Header parameters

Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj

Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81

Body

application/json

bytes_limitintegerRequired

The new storage limit in bytes.

Example: 5368709120

Responses

200

Limit updated successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

put

/clients/v1/admin/users/{userId}/limits/update

HTTPcURLJavaScriptPython

PUT /clients/v1/admin/users/{userId}/limits/update HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "bytes_limit": 5368709120
}

No content

List users

get

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/users/list

Retrieves a list of all users. Requires authentication.

Query parameters

pageintegerOptional

Maximum number of page to return.

Example: 1

limitintegerOptional

Maximum number of users to return

Example: 10

Header parameters

Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj

Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81

Responses

200

List of users retrieved successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

get

/clients/v1/admin/users/list

HTTPcURLJavaScriptPython

GET /clients/v1/admin/users/list HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Create user

post

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/users/create

Creates a new user. Requires authentication.

Header parameters

Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj

Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81

Body

application/json

first_namestringRequired

The first name of the user.

Example: John

middle_namestring · nullableOptional

The middle name of the user (optional).

last_namestringRequired

The last name of the user.

Example: Doe

suffixstring · nullableOptional

The suffix of the user (e.g., Jr., Sr.) (optional).

emailstringRequired

User email address.

Example: [e-mail]

passwordstringRequired

User password (must meet complexity requirements).

Example: StrongPass123!

confirm_passwordstringRequired

Confirmation of the user password.

Example: StrongPass123!

rolestring · enumRequired

User role (system_user or system_admin).

Example: system_userPossible values:

is_verifiedbooleanRequired

Indicates if the user is verified.

Example: false

Responses

201

User created successfully.

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

post

/clients/v1/admin/users/create

HTTPcURLJavaScriptPython

POST /clients/v1/admin/users/create HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "first_name": "John",
  "middle_name": null,
  "last_name": "Doe",
  "suffix": null,
  "email": "[e-mail]",
  "password": "StrongPass123!",
  "confirm_password": "StrongPass123!",
  "role": "system_user",
  "is_verified": false
}

No content

Read user

get

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/users/{userId}/read

Retrieves details of a specific user. Requires authentication.

Path parameters

userIdstringRequired

The ID of the user to retrieve.

Example: user123

Header parameters

Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj

Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81

Responses

200

User details retrieved successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

404

User not found.

500

Server error. An error occurred while processing the request.

get

/clients/v1/admin/users/{userId}/read

HTTPcURLJavaScriptPython

GET /clients/v1/admin/users/{userId}/read HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Search users

get

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/users/search

Searches for users by email. Requires authentication.

Query parameters

emailstringRequired

Search term for user email.

Example: [e-mail]

Header parameters

Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj

Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81

Responses

200

Users found successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

get

/clients/v1/admin/users/search

HTTPcURLJavaScriptPython

GET /clients/v1/admin/users/search?email=text HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Update user

put

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/users/{userId}/update

Updates details of a specific user. Requires authentication.

Path parameters

userIdstringRequired

The ID of the user to update.

Example: user123

Header parameters

Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj

Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81

Body

application/json

first_namestringOptional

Updated first name of the user.

Example: John

middle_namestring · nullableOptional

Updated middle name of the user (optional).

last_namestringOptional

Updated last name of the user.

Example: Doe

suffixstring · nullableOptional

Updated suffix of the user (e.g., Jr., Sr.) (optional).

emailstringOptional

Updated user email address.

Example: [e-mail]

passwordstringOptional

Updated user password (must meet complexity requirements).

Example: StrongPass123!

rolestring · enumOptional

Updated user role (system_user or system_admin).

Example: system_userPossible values:

is_verifiedbooleanOptional

Updated verification status of the user.

Example: true

is_lockedbooleanOptional

Updated lock status of the user.

Example: true

is_deletedbooleanOptional

Updated deleted status of the user.

Example: true

Responses

200

User updated successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

404

User not found.

500

Server error. An error occurred while processing the request.

put

/clients/v1/admin/users/{userId}/update

HTTPcURLJavaScriptPython

PUT /clients/v1/admin/users/{userId}/update HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "first_name": "John",
  "middle_name": null,
  "last_name": "Doe",
  "suffix": null,
  "email": "[e-mail]",
  "password": "StrongPass123!",
  "role": "system_user",
  "is_verified": true,
  "is_locked": true,
  "is_deleted": true
}

No content

Add member to organization

post

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/organizations/{orgID}/members/add

Adds a member to an organization with a specified role. Requires authentication.

Path parameters

orgIDstringRequired

The ID of the organization.

Example: 68724f127d0d567ae10f58bd

Header parameters

Client-IDstringRequiredExample: id_0RA3jR4NthjbME6MVg7r4EQ0DXlepaIj

Client-SecretstringRequiredExample: sk_ZfKAFeZ6pGb2YJ5Hq1smRLyjGUeo0V81

Body

application/json

user_idstringRequired

The ID of the user to add as a member.

Example: 6873e39d485ac74c10176138

role_idstringRequired

The ID of the role to assign to the member.

Example: 68724d6c7d0d567ae10f5867

Responses

201

Member added successfully.

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

post

/clients/v1/admin/organizations/{orgID}/members/add

HTTPcURLJavaScriptPython

POST /clients/v1/admin/organizations/{orgID}/members/add HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "user_id": "6873e39d485ac74c10176138",
  "role_id": "68724d6c7d0d567ae10f5867"
}

No content

Update member role

put

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/organizations/{orgID}/members/{userID}/update-role

Updates the role of a member in an organization. Requires authentication.

Path parameters

orgIDstringRequired

The ID of the organization.

Example: 681ca78cdac6270218139852

userIDstringRequired

The ID of the member.

Example: 681ca7a4dac6270218139853

Header parameters

Client-IDstringRequiredExample: id_5f9b3c4d-e8a1-4b2f-9e7d-12a34b56c789

Client-SecretstringRequiredExample: sk_x7k9p2m4q8r5t1y3w6u0v9z2b4c6n8m

Body

application/json

role_idstringRequired

The new role ID to assign to the member.

Example: 681ca736dac627021813982b

Responses

200

Member role updated successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

404

Member or organization not found.

500

Server error. An error occurred while processing the request.

put

/clients/v1/admin/organizations/{orgID}/members/{userID}/update-role

HTTPcURLJavaScriptPython

PUT /clients/v1/admin/organizations/{orgID}/members/{userID}/update-role HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "role_id": "681ca736dac627021813982b"
}

No content

Remove member from organization

delete

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/organizations/{orgID}/members/{userID}/remove

Removes a member from an organization. Requires authentication.

Path parameters

orgIDstringRequired

The ID of the organization.

Example: 681ca78cdac6270218139852

userIDstringRequired

The ID of the member to remove.

Example: 681ca7a4dac6270218139853

Header parameters

Client-IDstringRequiredExample: id_5f9b3c4d-e8a1-4b2f-9e7d-12a34b56c789

Client-SecretstringRequiredExample: sk_x7k9p2m4q8r5t1y3w6u0v9z2b4c6n8m

Responses

200

Member removed successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

404

Member or organization not found.

500

Server error. An error occurred while processing the request.

delete

/clients/v1/admin/organizations/{orgID}/members/{userID}/remove

HTTPcURLJavaScriptPython

DELETE /clients/v1/admin/organizations/{orgID}/members/{userID}/remove HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

List organizations

get

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/organizations/list

Retrieves a list of organizations with pagination. Requires authentication.

Query parameters

pageintegerOptional

Page number for pagination.

Example: 1

limitintegerOptional

Maximum number of organizations per page.

Example: 10

Header parameters

Client-IDstringRequiredExample: id_5f9b3c4d-e8a1-4b2f-9e7d-12a34b56c789

Client-SecretstringRequiredExample: sk_x7k9p2m4q8r5t1y3w6u0v9z2b4c6n8m

Responses

200

List of organizations retrieved successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

get

/clients/v1/admin/organizations/list

HTTPcURLJavaScriptPython

GET /clients/v1/admin/organizations/list HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Create organization

post

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/organizations/create

Creates a new organization. Requires authentication.

Header parameters

Client-IDstringRequiredExample: id_5f9b3c4d-e8a1-4b2f-9e7d-12a34b56c789

Client-SecretstringRequiredExample: sk_x7k9p2m4q8r5t1y3w6u0v9z2b4c6n8m

Body

application/json

namestringRequired

Name of the organization.

Example: AR Data Technologies

domainstringRequired

Domain associated with the organization.

Example: ardata.tech

contactstringRequired

Contact email for the organization.

Example: [e-mail]

policy_idstringRequired

ID of the policy to apply to the organization.

Example: 681c6f783305ec1ab0dc0b28

parent_idstring · nullableOptional

ID of the parent organization (optional).

Responses

201

Organization created successfully.

401

Unauthorized. Valid Client-ID and Client-Secret required.

500

Server error. An error occurred while processing the request.

post

/clients/v1/admin/organizations/create

HTTPcURLJavaScriptPython

POST /clients/v1/admin/organizations/create HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "AR Data Technologies",
  "domain": "ardata.tech",
  "contact": "[e-mail]",
  "policy_id": "681c6f783305ec1ab0dc0b28",
  "parent_id": null
}

No content

Read organization

get

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/organizations/{orgID}/read

Retrieves details of a specific organization. Requires authentication.

Path parameters

orgIDstringRequired

The ID of the organization.

Example: 681ca78cdac6270218139852

Header parameters

Client-IDstringRequiredExample: id_5f5b3c4d-e8a1-4b2f-9e7d-12a34b56c789

Client-SecretstringRequiredExample: sk_x7k9p2m4q8r5t1y3w6u0v9z2b4c6n8m

Responses

200

Organization details retrieved successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

404

Organization not found.

500

Server error. An error occurred while processing the request.

get

/clients/v1/admin/organizations/{orgID}/read

HTTPcURLJavaScriptPython

GET /clients/v1/admin/organizations/{orgID}/read HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Accept: */*

No content

Update organization

put

https://uat.koneksi.co.krhttps://staging.koneksi.co.kr

/clients/v1/admin/organizations/{orgID}/update

Updates details of a specific organization. Requires authentication.

Path parameters

orgIDstringRequired

The ID of the organization.

Example: 681c84fa688a3eee0a35e594

Header parameters

Client-IDstringRequiredExample: id_5f9b3c4d-e8a1-4b2f-9e7d-12a34b56c789

Client-SecretstringRequiredExample: sk_x7k9p2m4q8r5t1y3w6u0v9z2b4c6n8m

Body

application/json

namestringOptional

Updated name of the organization.

Example: AR Data Technologies

domainstringOptional

Updated domain associated with the organization.

Example: ardata.tech

contactstringOptional

Updated contact email for the organization.

Example: [e-mail]

policy_idstringOptional

Updated ID of the policy to apply.

Example: 681c6f783305ec1ab0dc0b28

parent_idstring · nullableOptional

Updated ID of the parent organization (optional).

Responses

200

Organization updated successfully.

No content

401

Unauthorized. Valid Client-ID and Client-Secret required.

404

Organization not found.

500

Server error. An error occurred while processing the request.

put

/clients/v1/admin/organizations/{orgID}/update

HTTPcURLJavaScriptPython

PUT /clients/v1/admin/organizations/{orgID}/update HTTP/1.1
Host: uat.koneksi.co.kr
Client-ID: text
Client-Secret: text
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "AR Data Technologies",
  "domain": "ardata.tech",
  "contact": "[e-mail]",
  "policy_id": "681c6f783305ec1ab0dc0b28",
  "parent_id": null
}

No content