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