กำหนดตัวจัดการกลุ่มผู้ใช้เพื่อช่วยจัดการการดำเนินการที่เกี่ยวข้องกับผู้เช่า ดังนี้
- ความสามารถในการสร้าง อัปเดต แสดงรายการ รับ และลบกลุ่มผู้ใช้สำหรับโปรเจ็กต์ที่สำคัญ
- รับอินสแตนซ์
TenantAwareAuthสำหรับเรียกใช้การดำเนินการที่เกี่ยวข้องกับการตรวจสอบสิทธิ์ (การจัดการผู้ใช้ การจัดการการกำหนดค่าผู้ให้บริการ การยืนยันโทเค็น การสร้างลิงก์อีเมล ฯลฯ) ในบริบทของกลุ่มผู้ใช้ที่ระบุ
ลายเซ็น:
export declare class TenantManager
เมธอด
| วิธีการ | คีย์ตัวปรับแต่ง | คำอธิบาย |
|---|---|---|
| authForTenant(รหัสกลุ่มผู้ใช้) | แสดงผลอินสแตนซ์ TenantAwareAuth ที่เชื่อมโยงกับรหัสกลุ่มผู้ใช้ที่ระบุ |
|
| createTenant(tenantOptions) | สร้างกลุ่มผู้ใช้ใหม่ เมื่อสร้างกลุ่มผู้ใช้ใหม่ กลุ่มผู้ใช้ที่ใช้การเรียกเก็บเงินและโควต้าแยกต่างหากจะต้องมีโปรเจ็กต์ของตนเองและต้องกำหนดเป็น full_service |
|
| deleteTenant(tenantId) | ลบกลุ่มผู้ใช้ที่มีอยู่ | |
| getTenant(tenantId) | รับการกำหนดค่ากลุ่มผู้ใช้สำหรับกลุ่มผู้ใช้ที่สอดคล้องกับ tenantId ที่กำหนด |
|
| listTenants(maxผลลัพธ์, pageToken) | เรียกข้อมูลรายการกลุ่มผู้ใช้ (กลุ่มเดียวเท่านั้น) ที่มีขนาด maxResults เริ่มต้นจากออฟเซ็ตที่ระบุโดย pageToken ใช้เพื่อเรียกข้อมูลกลุ่มผู้ใช้ทั้งหมดของโปรเจ็กต์ที่ระบุเป็นกลุ่ม |
|
| updateTenant(tenantId, tenantOptions) | อัปเดตการกำหนดค่ากลุ่มผู้ใช้ที่มีอยู่ |
TenantManager.authForTenant()
แสดงผลอินสแตนซ์ TenantAwareAuth ที่เชื่อมโยงกับรหัสกลุ่มผู้ใช้ที่ระบุ
ลายเซ็น:
authForTenant(tenantId: string): TenantAwareAuth;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| รหัสกลุ่มผู้ใช้ | สตริง | รหัสกลุ่มผู้ใช้ที่จะส่งคืนอินสแตนซ์ TenantAwareAuth |
การคืนสินค้า:
อินสแตนซ์ TenantAwareAuth ที่สอดคล้องกับตัวระบุกลุ่มผู้ใช้นี้
TenantManager.createTenant()
สร้างกลุ่มผู้ใช้ใหม่ เมื่อสร้างกลุ่มผู้ใช้ใหม่ กลุ่มผู้ใช้ที่ใช้การเรียกเก็บเงินและโควต้าแยกต่างหากจะต้องมีโปรเจ็กต์ของตนเองและต้องกำหนดเป็น full_service
ลายเซ็น:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| ตัวเลือกกลุ่มผู้ใช้ | CreateTenantRequest | พร็อพเพอร์ตี้ที่จะตั้งค่าในการกำหนดค่ากลุ่มผู้ใช้ใหม่ที่จะสร้าง |
การคืนสินค้า:
สัญญา<Tenant>
สัญญาจะตอบสนองด้วยการกำหนดค่ากลุ่มผู้ใช้ที่สอดคล้องกับกลุ่มผู้ใช้ที่สร้างขึ้นใหม่
TenantManager.deleteTenant()
ลบกลุ่มผู้ใช้ที่มีอยู่
ลายเซ็น:
deleteTenant(tenantId: string): Promise<void>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| รหัสกลุ่มผู้ใช้ | สตริง | tenantId ที่เกี่ยวข้องกับกลุ่มผู้ใช้ที่จะลบ |
การคืนสินค้า:
คำมั่นสัญญา<โมฆะ>
มีการดำเนินการตามสัญญาที่ว่างเปล่าเมื่อลบกลุ่มผู้ใช้แล้ว
TenantManager.getTenant()
รับการกำหนดค่ากลุ่มผู้ใช้สำหรับกลุ่มผู้ใช้ที่สอดคล้องกับ tenantId ที่ระบุ
ลายเซ็น:
getTenant(tenantId: string): Promise<Tenant>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| รหัสกลุ่มผู้ใช้ | สตริง | ตัวระบุกลุ่มผู้ใช้ที่สอดคล้องกับกลุ่มผู้ใช้ที่มีข้อมูลที่จะดึงข้อมูล |
การคืนสินค้า:
สัญญา<Tenant>
คำมั่นสัญญาที่ได้ดำเนินการกำหนดค่ากลุ่มผู้ใช้สำหรับ tenantId ที่ให้ไว้
TenantManager.listTenants()
เรียกข้อมูลรายการกลุ่มผู้ใช้ (กลุ่มเดียวเท่านั้น) ที่มีขนาด maxResults เริ่มต้นจากออฟเซ็ตที่ระบุโดย pageToken ใช้เพื่อเรียกข้อมูลกลุ่มผู้ใช้ทั้งหมดของโปรเจ็กต์ที่ระบุเป็นกลุ่ม
ลายเซ็น:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| ผลลัพธ์สูงสุด | ตัวเลข | ขนาดหน้า 1, 000 ถ้าไม่ระบุ ซึ่งเป็นจำนวนสูงสุดที่อนุญาตด้วย |
| PageToken | สตริง | โทเค็นหน้าถัดไป หากไม่ได้ระบุ ระบบจะแสดงผลกลุ่มผู้ใช้ที่เริ่มต้นโดยไม่มีออฟเซ็ต |
การคืนสินค้า:
คำมั่นสัญญา<ListTenantsผลลัพธ์>
คำมั่นสัญญาที่จะแก้ไขปัญหาด้วยกลุ่มผู้ใช้ที่ดาวน์โหลดเป็นกลุ่มและโทเค็นหน้าถัดไป
TenantManager.updateTenant()
อัปเดตการกำหนดค่ากลุ่มผู้ใช้ที่มีอยู่
ลายเซ็น:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| รหัสกลุ่มผู้ใช้ | สตริง | tenantId ที่เกี่ยวข้องกับกลุ่มผู้ใช้ที่จะลบ |
| ตัวเลือกกลุ่มผู้ใช้ | UpdateTenantRequest | พร็อพเพอร์ตี้ที่จะอัปเดตเกี่ยวกับกลุ่มผู้ใช้ที่ระบุ |
การคืนสินค้า:
สัญญา<Tenant>
สัญญาที่ให้ไว้ด้วยข้อมูลกลุ่มผู้ใช้ที่อัปเดต