Class OrgAPI

OrgAPI contains organization level operations.

Inheritance

System.Object

OrgAPI

Implements

IOrgAPI

Inherited Members

System.Object.Equals(System.Object)

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

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

System.Object.ToString()

Namespace: ZohoAnalytics

Assembly: ZohoAnalytics.dll

Syntax

public class OrgAPI : IOrgAPI

Methods

ActivateUsers(List<String>, Dictionary<String, Object>)

Activate users in the specified organization.

Declaration

public void ActivateUsers(List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds	The email address of the users to be activated.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

AddUsers(List<String>, Dictionary<String, Object>)

Add users to the specified organization.

Declaration

public void AddUsers(List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds	The email address of the users to be added.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

ChangeUserRole(List<String>, String, Dictionary<String, Object>)

Change role for the specified users.

Declaration

public void ChangeUserRole(List<string> emailIds, string role, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds	The email address of the users.
System.String	role	Name of the role to be updated. Can be one of "USER"/"VIEWER"/"ORGADMIN".
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

CreateWorkspace(String, Dictionary<String, Object>)

Create a blank workspace in the specified organization.

Declaration

public long CreateWorkspace(string workspaceName, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	workspaceName	Name of the workspace.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Int64	New workspace id.

DeactivateUsers(List<String>, Dictionary<String, Object>)

Deactivate users in the specified organization.

Declaration

public void DeactivateUsers(List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds	The email address of the users to be deactivated.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

GetAdmins()

Returns list of admins for a specified organization.

Declaration

public JsonElement GetAdmins()

Returns

Type	Description
System.Text.Json.JsonElement	Organization admins list.

GetMetaDetails(String, String)

Returns details of the specified workspace/view.

Declaration

public JsonElement GetMetaDetails(string workspaceName, string viewName)

Parameters

Type	Name	Description
System.String	workspaceName	The name of the workspace.
System.String	viewName	The name of the view.

Returns

Type	Description
System.Text.Json.JsonElement	Workspace/view details.

GetResourceDetails()

Returns resource usage details of the specified organization.

Declaration

public JsonElement GetResourceDetails()

Returns

Type	Description
System.Text.Json.JsonElement	Resource details.

GetSubscriptionDetails()

Returns subscription details of the specified organization.

Declaration

public JsonElement GetSubscriptionDetails()

Returns

Type	Description
System.Text.Json.JsonElement	Subscription details.

GetUsers()

Returns list of users for the specified organization.

Declaration

public JsonElement GetUsers()

Returns

Type	Description
System.Text.Json.JsonElement	List of users.

RemoveUsers(List<String>, Dictionary<String, Object>)

Remove users from the specified organization.

Declaration

public void RemoveUsers(List<string> emailIds, Dictionary<string, object> config)

Parameters

Type	Name	Description
List<System.String>	emailIds	The email address of the users to be removed.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Implements

IOrgAPI