abacusai.app_user_group

Classes

AbstractApiClass
User	An Abacus.AI User
AppUserGroup	An app user group. This is used to determine which users have permissions for external chatbots.

Module Contents

class abacusai.app_user_group.AbstractApiClass(client, id)

__eq__(other)

Return self==value.

_get_attribute_as_dict(attribute)

class abacusai.app_user_group.User(client, name=None, email=None, createdAt=None, status=None, organizationGroups={})

Bases: abacusai.return_class.AbstractApiClass

An Abacus.AI User

Parameters:

• client (ApiClient) – An authenticated API Client instance

• name (str) – The User’s name.

• email (str) – The User’s primary email address.

• createdAt (str) – The date and time when the user joined Abacus.AI.

• status (str) – ACTIVE when the user has accepted an invite to join the organization, else INVITED.

• organizationGroups (OrganizationGroup) – List of Organization Groups this user belongs to.

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict

class abacusai.app_user_group.AppUserGroup(client, name=None, userGroupId=None, externalApplicationIds=None, invitedUserEmails=None, publicUserGroup=None, hasExternalApplicationReporting=None, isExternalServiceGroup=None, externalServiceGroupId=None, users={})

Bases: abacusai.return_class.AbstractApiClass

An app user group. This is used to determine which users have permissions for external chatbots.

Parameters:

• client (ApiClient) – An authenticated API Client instance

• name (str) – The name of the user group.

• userGroupId (str) – The unique identifier of the user group.

• externalApplicationIds (list[str]) – The ids of the external applications the group has access to.

• invitedUserEmails (list[str]) – The emails of the users invited to the user group who have not yet accepted the invite.

• publicUserGroup (bool) – Boolean flag whether the app user group is the public user group of the org or not.

• hasExternalApplicationReporting (bool) – Whether users in the App User Group have permission to view all reports in their organization.

• isExternalServiceGroup (bool) – Whether the App User Group corresponds to a user group that’s defined in an external service (i.e Microsft Active Directory or Okta) or not

• externalServiceGroupId (str) – The identifier that corresponds to the app user group’s external service group representation

• users (User) – The users in the user group.

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict