Class TenantsApi

Inheritance

System.Object

TenantsApi

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Account.Organizations.Groups.Tenants

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class TenantsApi

Constructors

TenantsApi(IBitmovinApiClientFactory)

Declaration

public TenantsApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of TenantsApi

Declaration

public static BitmovinApiBuilder<TenantsApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<TenantsApi>

Methods

CreateAsync(String, String, Tenant)

Add Tenant to Group

Declaration

public Task<Tenant> CreateAsync(string organizationId, string groupId, Tenant tenant)

Parameters

Type	Name	Description
System.String	organizationId	Id of the organization (required)
System.String	groupId	Id of the group (required)
Tenant	tenant	Tenant details

Returns

Type	Description
System.Threading.Tasks.Task<Tenant>

DeleteAsync(String, String, String)

Delete Tenant

Declaration

public Task<BitmovinResponse> DeleteAsync(string organizationId, string groupId, string tenantId)

Parameters

Type	Name	Description
System.String	organizationId	Id of the organization (required)
System.String	groupId	Id of the group (required)
System.String	tenantId	Id of the tenant. (required)

Returns

Type	Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String, String, String)

Tenant Details

Declaration

public Task<Tenant> GetAsync(string organizationId, string groupId, string tenantId)

Parameters

Type	Name	Description
System.String	organizationId	Id of the organization (required)
System.String	groupId	Id of the group (required)
System.String	tenantId	Id of the tenant. (required)

Returns

Type	Description
System.Threading.Tasks.Task<Tenant>

ListAsync(String, String, Func<TenantsApi.ListQueryParams, TenantsApi.ListQueryParams>[])

List Tenants

Declaration

public Task<PaginationResponse<Tenant>> ListAsync(string organizationId, string groupId, params Func<TenantsApi.ListQueryParams, TenantsApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	organizationId	Id of the organization (required)
System.String	groupId	Id of the group (required)
System.Func<TenantsApi.ListQueryParams, TenantsApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<Tenant>>