Trong trang này

> tai nguyen > tai lieu > api > Tài liệu tham khảo API: Tenant

Tài liệu tham khảo API: Tenant

Xem thông tin tenant

Endpoint: GET /v1/tenant/{tenantId}

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`

Phản hồi (200):

Thông tin tenant

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Có	Định dạng: `uuid`
createdBy	string	Có	Định dạng: `uuid`
createdAt	string	Có	Định dạng: `date-time`
displayName	string	Có	Mặc định: `""` Độ dài tối đa: 128
contactEmail	string	Có	Định dạng: `email`
isActive	boolean	Có	Mặc định: `true`
shortName	string	Có
useOrganizationTheme	boolean	Có	Mặc định: `true`
description	string	Có	Độ dài tối đa: 200
organizationId	string	Có	Định dạng: `uuid`
allowedLogins	object	Có
tenantType	`normal` \| `sandbox` \| `demo`	Có	Giá trị được phép: `normal`, `sandbox`, `demo` Mặc định: `normal`
url	string	Có	Định dạng: `uri`

Lỗi:

401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
404 Không tìm thấy tài nguyên

Cập nhật cài đặt tenant

Endpoint: PUT /v1/tenant/{tenantId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`

Nội dung yêu cầu:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Không	Định dạng: `uuid`
displayName	string	Không
contactEmail	string	Không
shortName	string	Không
description	string	Không

Phản hồi (200):

Tenant đã cập nhật

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Có	Định dạng: `uuid`
createdBy	string	Có	Định dạng: `uuid`
createdAt	string	Có	Định dạng: `date-time`
displayName	string	Có	Mặc định: `""` Độ dài tối đa: 128
contactEmail	string	Có	Định dạng: `email`
isActive	boolean	Có	Mặc định: `true`
shortName	string	Có
useOrganizationTheme	boolean	Có	Mặc định: `true`
description	string	Có	Độ dài tối đa: 200
organizationId	string	Có	Định dạng: `uuid`
allowedLogins	object	Có
tenantType	`normal` \| `sandbox` \| `demo`	Có	Giá trị được phép: `normal`, `sandbox`, `demo` Mặc định: `normal`
url	string	Có	Định dạng: `uri`

Lỗi:

400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ lọc sai, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
403 API key không có phạm vi cần thiết hoặc không có quyền truy cập tổ chức, tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này
406 Không thể chấp nhận giá trị này, chẳng hạn tên ngắn đã được dành riêng hoặc bị trùng

Xem thống kê tenant (dung lượng dữ liệu, mô hình, mô phỏng, người dùng)

Endpoint: GET /v1/tenant/{tenantId}/statistics

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`

Phản hồi (200):

Thống kê tenant

{
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"uploadedDataSize": 0,
	"uploadedDataCount": 0,
	"modelCount": 0,
	"simulationCount": 0,
	"userCount": 0
}

Trường	Kiểu	Bắt buộc	Mô tả
tenantId	string	Có	Định dạng: `uuid`
uploadedDataSize	number	Có
uploadedDataCount	number	Có
modelCount	number	Có
simulationCount	number	Có
userCount	number	Có

Lỗi:

401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
404 Không tìm thấy tài nguyên

Liệt kê người dùng trong tenant

Trả về những người dùng khớp điều kiện dưới dạng mảng JSON thuần, không có tổng số kết quả. Phân trang bằng limit/offset.

Endpoint: GET /v1/tenant/{tenantId}/users

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`
limit	integer	query	Không	Số mục tối đa cần trả về
offset	integer	query	Không	Số mục cần bỏ qua

Phản hồi (200):

Danh sách người dùng

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"isActiveInTenant": true,
		"isAdminInTenant": true,
		"access": "none",
		"isDashboardViewer": true,
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

Lỗi:

401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key

Thêm người dùng vào tenant (không gửi email mời)

Các trường vai trò trong nội dung yêu cầu (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) được áp dụng đúng như đã gửi. Endpoint này cho phép quản trị toàn bộ tenant, vì vậy chỉ cấp API key có quyền ghi cho bên gọi đáng tin cậy. Quyền xem dashboard được xác định bằng giá trị boolean isDashboardViewer; cấp Viewer chỉ đọc trước đây đã bị loại bỏ.

Endpoint: POST /v1/tenant/{tenantId}/users

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`

Nội dung yêu cầu:

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}

Trường	Kiểu	Bắt buộc	Mô tả
email	string	Có	Địa chỉ email của người dùng, đồng thời là thông tin đăng nhập Định dạng: `email`
firstName	string	Không	Tên, không bắt buộc Độ dài tối đa: 64
lastName	string	Không	Họ, không bắt buộc Độ dài tối đa: 64
isActiveInTenant	boolean	Không	Người dùng có đang hoạt động trong Tenant này hay không
isAdminInTenant	boolean	Không	Quyền quản trị trong Tenant này (được áp dụng nguyên trạng, bao gồm toàn bộ quyền quản trị Tenant)
access	`none` \| `portalViewer` \| `designer` \| `architect` \| `intelligence`	Không	Chọn một loại chỗ ngồi người dùng: none \| portalViewer \| designer \| architect \| intelligence Giá trị được phép: `none`, `portalViewer`, `designer`, `architect`, `intelligence`
isDashboardViewer	boolean	Không	Người dùng có quyền chỉ xem dashboard hay không
preferredLocale	`en` \| `zh` \| `es` \| `fr` \| `de` \| `pt` \| `it` \| `nl` \| `ja` \| `tr` \| `pl` \| `cs` \| `hu` \| `id` \| `ko` \| `vi` \| `th`	Không	Ngôn ngữ giao diện ưu tiên của người dùng Giá trị được phép: `en`, `zh`, `es`, `fr`, `de`, `pt`, `it`, `nl`, `ja`, `tr`, `pl`, `cs`, `hu`, `id`, `ko`, `vi`, `th`

Phản hồi (201):

Đã thêm người dùng

{
	"id": "string",
	"message": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Có	ID của người dùng vừa được thêm
message	string	Có

Lỗi:

401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
409 Yêu cầu xung đột với trạng thái hiện tại, chẳng hạn không đủ giấy phép hoặc ID đã được dùng

Cập nhật cài đặt tenant của người dùng

Endpoint: PUT /v1/tenant/{tenantId}/users/{userId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`
userId	string	path	Có	Định dạng: `uuid`

Nội dung yêu cầu:

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}

Trường	Kiểu	Bắt buộc	Mô tả
isActiveInTenant	boolean	Không	Người dùng có đang hoạt động trong tenant này hay không
isAdminInTenant	boolean	Không	Quyền quản trị trong tenant này (được áp dụng đúng như đã gửi: toàn quyền quản trị tenant)
access	`none` \| `portalViewer` \| `designer` \| `architect` \| `intelligence`	Không	Chọn một giấy phép: none \| portalViewer \| designer \| architect \| intelligence. Quyền xem dashboard được xác định bằng giá trị boolean isDashboardViewer. Giá trị được phép: `none`, `portalViewer`, `designer`, `architect`, `intelligence`
isDashboardViewer	boolean	Không	Người dùng có quyền chỉ xem dashboard hay không

Phản hồi (200):

Đã cập nhật

{
	"message": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
message	string	Có

Lỗi:

400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ lọc sai, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
404 Không tìm thấy tài nguyên

Xóa người dùng khỏi tenant

Endpoint: DELETE /v1/tenant/{tenantId}/users/{userId}

Xác thực: API key giới hạn theo tenant · phạm vi write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`
userId	string	path	Có	Định dạng: `uuid`

Phản hồi (200):

Đã xóa người dùng

{
	"message": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
message	string	Có

Lỗi:

400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ lọc sai, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
404 Không tìm thấy tài nguyên

Tạo token chuyển tiếp đăng nhập dùng một lần cho người dùng

Trả về token chỉ dùng một lần (thời hạn 60 giây), gắn với người dùng, tenant và tổ chức, cùng url để chuyển trình duyệt của người dùng đến đó. Mở URL trong trình duyệt của người dùng để họ vào ProcessMind trong trạng thái đã xác thực. Không cần liên kết email hay mạo danh người dùng; họ sẽ có phiên đăng nhập riêng. API key cần có phạm vi sessions chuyên biệt. Key giới hạn theo tổ chức có thể tạo token cho bất kỳ tenant nào trong tổ chức; key giới hạn theo tenant chỉ tạo token cho người dùng thuộc tenant đó. Hãy bảo vệ token như mật khẩu: token chỉ được trả về một lần, không bao giờ được ghi vào nhật ký và sẽ bị thu hồi khi tắt key hoặc người dùng.

Endpoint: POST /v1/tenant/{tenantId}/users/{userId}/login-token

Xác thực: API key giới hạn theo tenant hoặc tổ chức · phạm vi sessions · giới hạn tốc độ 2 yêu cầu/giây (tối đa 4 yêu cầu liên tiếp)

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`
userId	string	path	Có	Định dạng: `uuid`

Nội dung yêu cầu:

Đường dẫn đích tùy chọn (đường dẫn tương đối trong ứng dụng, ví dụ “app” hoặc “app/dashboards”)

{
	"path": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
path	string	Không	Độ dài tối đa: 512

Phản hồi (200):

Token chuyển tiếp đăng nhập

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Trường	Kiểu	Bắt buộc	Mô tả
token	string	Có
url	string	Có
expiresInSeconds	number	Có
expiresAt	string	Có	Định dạng: `date-time`

Lỗi:

400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ lọc sai, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
403 API key không có phạm vi cần thiết hoặc không có quyền truy cập tổ chức, tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này
404 Không tìm thấy tài nguyên
429 Đã vượt giới hạn tốc độ: xem giới hạn tốc độ được ghi trong tài liệu của endpoint

API key dùng để xác thực các tích hợp của bạn. API key giới hạn theo tổ chức có thể cấp và quản lý key cho mọi tenant trong tổ chức.

Liệt kê API key của tenant

Cần API key giới hạn theo tổ chức. API không bao giờ trả về mã bí mật.

Endpoint: GET /v1/tenant/{tenantId}/api-keys

Xác thực: API key giới hạn theo tổ chức · phạm vi read

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`
limit	integer	query	Không	Số mục tối đa cần trả về
offset	integer	query	Không	Số mục cần bỏ qua

Phản hồi (200):

Danh sách API key

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"partialKey": "string",
		"enabled": true,
		"createdAt": "2024-03-15T16:30:00Z",
		"lastUsedAt": "2024-03-15T16:30:00Z",
		"expiresAt": "2024-03-15T16:30:00Z",
		"scope": {
			"read": true,
			"write": true,
			"uploadData": true,
			"sessions": true
		}
	}
]

Lỗi:

401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
403 API key không có phạm vi cần thiết hoặc không có quyền truy cập tổ chức, tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này

Tạo API key giới hạn theo tenant

Cần API key có quyền ghi, giới hạn theo tổ chức. Máy chủ tạo mã bí mật và chỉ trả về một lần trong phản hồi. Hãy lưu mã an toàn. Hệ thống chỉ lưu giá trị băm của mã.

Endpoint: POST /v1/tenant/{tenantId}/api-keys

Xác thực: API key giới hạn theo tổ chức · phạm vi write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`

Nội dung yêu cầu:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Trường	Kiểu	Bắt buộc	Mô tả
displayName	string	Có	Độ dài tối đa: 128
scope	object	Không
enabled	boolean	Không
expiresAt	string	Không	Định dạng: `date-time`

Phản hồi (201):

Đã tạo API key (kèm mã bí mật chỉ dùng một lần)

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"secret": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Có	Định dạng: `uuid`
tenantId	string	Có	Định dạng: `uuid`
organizationId	string	Có	Định dạng: `uuid`
displayName	string	Có	Độ dài tối đa: 128
partialKey	string	Có	Độ dài tối đa: 128
enabled	boolean	Có	Mặc định: `true`
createdAt	string	Có	Định dạng: `date-time`
lastUsedAt	string	Có	Định dạng: `date-time`
expiresAt	string	Có	Định dạng: `date-time`
scope	object	Có
secret	string	Có	Độ dài tối đa: 128

Lỗi:

400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ lọc sai, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
403 API key không có phạm vi cần thiết hoặc không có quyền truy cập tổ chức, tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này

Cập nhật API key giới hạn theo tenant

Cần API key có quyền ghi, giới hạn theo tổ chức. Các trường phạm vi sẽ được gộp với phạm vi đã lưu.

Endpoint: PUT /v1/tenant/{tenantId}/api-keys/{keyId}

Xác thực: API key giới hạn theo tổ chức · phạm vi write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`
keyId	string	path	Có	Định dạng: `uuid`

Nội dung yêu cầu:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Trường	Kiểu	Bắt buộc	Mô tả
displayName	string	Không	Độ dài tối đa: 128
scope	object	Không
enabled	boolean	Không
expiresAt	string	Không	Định dạng: `date-time`

Phản hồi (200):

Đã cập nhật API key

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	}
}

Trường	Kiểu	Bắt buộc	Mô tả
id	string	Có	Định dạng: `uuid`
tenantId	string	Có	Định dạng: `uuid`
organizationId	string	Có	Định dạng: `uuid`
displayName	string	Có	Độ dài tối đa: 128
partialKey	string	Có	Độ dài tối đa: 128
enabled	boolean	Có	Mặc định: `true`
createdAt	string	Có	Định dạng: `date-time`
lastUsedAt	string	Có	Định dạng: `date-time`
expiresAt	string	Có	Định dạng: `date-time`
scope	object	Có

Lỗi:

400 Yêu cầu không hợp lệ, chẳng hạn biểu thức bộ lọc sai, quy trình chưa có mô hình, loại tệp tải lên không được hỗ trợ hoặc thiếu trường bắt buộc
401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
403 API key không có phạm vi cần thiết hoặc không có quyền truy cập tổ chức, tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này
404 Không tìm thấy tài nguyên

Xóa API key giới hạn theo tenant

Cần API key có quyền ghi, giới hạn theo tổ chức. Key được xóa mềm và ngừng xác thực ngay lập tức.

Endpoint: DELETE /v1/tenant/{tenantId}/api-keys/{keyId}

Xác thực: API key giới hạn theo tổ chức · phạm vi write

Tham số:

Tên	Kiểu	Vị trí	Bắt buộc	Mô tả
tenantId	string	path	Có	Định dạng: `uuid`
keyId	string	path	Có	Định dạng: `uuid`

Phản hồi (200):

Đã xóa API key

{
	"message": "string"
}

Trường	Kiểu	Bắt buộc	Mô tả
message	string	Có

Lỗi:

401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
403 API key không có phạm vi cần thiết hoặc không có quyền truy cập tổ chức, tenant không hoạt động hoặc gói dịch vụ không hỗ trợ loại tệp này
404 Không tìm thấy tài nguyên

Tài liệu liên quan

Tài liệu tham khảo API: tổ chức

Tài liệu API cho các điểm cuối quản lý tổ chức và người dùng.

Tài liệu API: Dữ liệu

Tài liệu API cho các endpoint quản lý dataset và datatable.

Tài liệu tham khảo API: quy trình

Tài liệu API cho các điểm cuối quản lý quy trình và ánh xạ dữ liệu.

Tài liệu tham khảo API: Mô phỏng

Tài liệu tham khảo API cho các endpoint quản lý mô phỏng và tạo mô phỏng bằng AI.

Thiết kế quy trình tốt hơn. Kết nối các quy trình. Luôn chủ động kiểm soát.

Truy cập ngay, không cần thẻ tín dụng hay chờ đợi. Biến cách tổ chức của bạn vận hành thành các thiết kế quy trình rõ ràng, liên kết với nhau.

Xây dựng kiến trúc quy trình, xác định quyền sở hữu và cơ chế kiểm soát, đồng thời thống nhất vai trò và trách nhiệm ở mọi cấp.

Bắt đầu dùng thử miễn phí để tạo nền tảng đáng tin cậy cho việc quản trị, quản lý và cải tiến quy trình liên tục.

Dùng thử miễn phí ngay