Show / Hide Table of Contents

Class GroupsApi

Inheritance
System.Object
GroupsApi
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
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class GroupsApi

Constructors

GroupsApi(IBitmovinApiClientFactory)

Declaration
public GroupsApi(IBitmovinApiClientFactory apiClientFactory)
Parameters
Type Name Description
IBitmovinApiClientFactory apiClientFactory

Properties

Builder

Fluent builder for creating an instance of GroupsApi

Declaration
public static BitmovinApiBuilder<GroupsApi> Builder { get; }
Property Value
Type Description
BitmovinApiBuilder<GroupsApi>

Invitations

Declaration
public InvitationsApi Invitations { get; }
Property Value
Type Description
InvitationsApi

Permissions

Declaration
public PermissionsApi Permissions { get; }
Property Value
Type Description
PermissionsApi

Tenants

Declaration
public TenantsApi Tenants { get; }
Property Value
Type Description
TenantsApi

Methods

CreateAsync(String, Group)

Add Group

Declaration
public Task<Group> CreateAsync(string organizationId, Group group)
Parameters
Type Name Description
System.String organizationId

Id of the organization (required)

Group group

Tenant Group details

Returns
Type Description
System.Threading.Tasks.Task<Group>

DeleteAsync(String, String)

Delete Group

Declaration
public Task<BitmovinResponse> DeleteAsync(string organizationId, string groupId)
Parameters
Type Name Description
System.String organizationId

Id of the organization (required)

System.String groupId

Id of the group (required)

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

GetAsync(String, String)

Group Details

Declaration
public Task<Group> GetAsync(string organizationId, string groupId)
Parameters
Type Name Description
System.String organizationId

Id of the organization (required)

System.String groupId

Id of the group. (required)

Returns
Type Description
System.Threading.Tasks.Task<Group>

ListAsync(String)

List Groups

Declaration
public Task<PaginationResponse<Group>> ListAsync(string organizationId)
Parameters
Type Name Description
System.String organizationId

Id of the organization (required)

Returns
Type Description
System.Threading.Tasks.Task<PaginationResponse<Group>>
Back to top Generated by DocFX