Method
getAppUserGroup GET
Copy GET

Gets an App User Group.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes userGroupId str The ID of the App User Group.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result AppUserGroup
KEY TYPE Description
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.
KEY TYPE Description
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.
KEY TYPE Description
organizationGroupId str The unique identifier of the Organization Group.
permissions List of Enum String The list of permissions (VIEW, MODIFY, ADMIN, BILLING, API_KEY, INVITE_USER) the group has.
groupName str The name of the Organization Group.
defaultGroup bool If true, all new users will be added to this group automatically.
admin bool If true, this group contains all permissions available to the organization and cannot be modified or deleted.
createdAt str When the Organization Group was created.

Exceptions:

TYPE WHEN
DataNotFoundError

userGroupId is not found.
Language:

© Copyright