TenantManager class

Kiracıyla ilgili işlemleri yönetmeye yardımcı olması için kullanılan kiracı yöneticisini tanımlar. Bunlardan bazıları:

  • Temel proje için kiracı oluşturma, güncelleme, listeleme, alma ve silme özelliği.
  • Belirli bir kiracı bağlamında Auth ile ilgili işlemleri (kullanıcı yönetimi, sağlayıcı yapılandırma yönetimi, jeton doğrulama, e-posta bağlantısı oluşturma vb.) çalıştırmak için bir TenantAwareAuth örneği alma.

İmza:

export declare class TenantManager

Yöntemler

Yöntem Değiştiriciler Açıklama
authForTenant(kiracıKimliği) Belirtilen kiracı kimliğine bağlı bir TenantAwareAuth örneğini döndürür.
createTenant(tenantOptions) Yeni bir kiracı oluşturur. Ayrı faturalandırma ve kota kullanan kiracılar, yeni kiracı oluştururken kendi projelerine ihtiyaç duyar ve full_service olarak tanımlanmalıdır.
deleteTenant(kiracıNo) Mevcut bir kiracıyı siler.
getTenant(kiracıId) Belirli bir tenantId öğesine karşılık gelen kiracı için kiracı yapılandırmasını alır.
listTenants(maxResults, pageToken) pageToken tarafından belirtilen ofsetten başlayarak maxResults boyutunda kiracı listesini (yalnızca tek grup) alır. Bu, belirtilen bir projenin tüm kiracılarını toplu olarak almak için kullanılır.
updateTenant(tenantId, tenantOptions) Mevcut bir kiracı yapılandırmasını günceller.

TenantManager.authForTenant()

Belirtilen kiracı kimliğine bağlı bir TenantAwareAuth örneğini döndürür.

İmza:

authForTenant(tenantId: string): TenantAwareAuth;

Parametreler

Parametre Tür Açıklama
kiracı kimliği dize TenantAwareAuth örneği döndürülecek kiracı kimliği.

Şunu döndürür:

TenantAwareAuth

Bu kiracı tanımlayıcısına karşılık gelen TenantAwareAuth örneği.

TenantManager.createTenant()

Yeni bir kiracı oluşturur. Yeni kiracı oluştururken ayrı faturalandırma ve kota kullanan kiracılar için kendi projeleri gerekir. Bu kiracılar full_service olarak tanımlanmalıdır.

İmza:

createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;

Parametreler

Parametre Tür Açıklama
kiracıSeçenekleri CreateTenantRequest Oluşturulacak yeni kiracı yapılandırmasında ayarlanacak özellikler.

Şunu döndürür:

Söz veriyorum<Kiracı>

Yeni oluşturulan kiracıya karşılık gelen kiracı yapılandırmasında yerine getirilen bir taahhüt.

TenantManager.deleteTenant()

Mevcut bir kiracıyı siler.

İmza:

deleteTenant(tenantId: string): Promise<void>;

Parametreler

Parametre Tür Açıklama
kiracı kimliği dize Silinecek kiracıya karşılık gelen tenantId.

Şunu döndürür:

Taahhüt<void>

Kiracı silindikten sonra boş taahhüt yerine getirildi.

TenantManager.getTenant()

Belirli bir tenantId öğesine karşılık gelen kiracı için kiracı yapılandırmasını alır.

İmza:

getTenant(tenantId: string): Promise<Tenant>;

Parametreler

Parametre Tür Açıklama
kiracı kimliği dize Verileri getirilecek kiracıya karşılık gelen kiracı tanımlayıcısı.

Şunu döndürür:

Söz veriyorum<Kiracı>

Sağlanan tenantId için kiracı yapılandırmasıyla ilgili bir taahhüt gerçekleştirildi.

TenantManager.listTenants()

pageToken tarafından belirtilen ofsetten başlayarak maxResults boyutunda kiracı listesini (yalnızca tek grup) alır. Bu, belirtilen bir projenin tüm kiracılarını toplu olarak almak için kullanılır.

İmza:

listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;

Parametreler

Parametre Tür Açıklama
maxResults sayı Sayfa boyutu, tanımlanmamışsa 1000. Bu aynı zamanda izin verilen maksimum sınırdır.
pageToken dize Sonraki sayfa jetonu. Belirtilmezse herhangi bir ofset olmadan başlayan kiracıları döndürür.

Şunu döndürür:

Promise<ListTenantsResult>

Bir grup indirilen kiracı ve sonraki sayfa jetonuyla çözülecek bir vaat.

TenantManager.updateTenant()

Mevcut bir kiracı yapılandırmasını günceller.

İmza:

updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;

Parametreler

Parametre Tür Açıklama
kiracı kimliği dize Silinecek kiracıya karşılık gelen tenantId.
kiracıSeçenekleri UpdateTenantRequest Sağlanan kiracıda güncellenecek özellikler.

Şunu döndürür:

Söz veriyorum<Kiracı>

Güncelleme kiracı verileriyle ilgili söz yerine getirildi.