Overview Use Cases Connectors Authentication Getting Started with the Python SDK API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps model model_monitoring module natural_language_explanation organization addOrganizationGroupPermission addUserToOrganization addUserToOrganizationGroup createOrganizationGroup deleteApiKey deleteOrganizationGroup describeOrganizationGroup describeUser listApiKeys listOrganizationGroups listOrganizationUsers removeOrganizationGroupPermission removeUserFromOrganization removeUserFromOrganizationGroup sendEmail setDefaultOrganizationGroup pipelines predict prediction_operator project python_function refresh secrets streaming streaming_connectors upload webhooks API Classes API Inputs Documentation Chat Bot API Search Video Tutorials ChatLLM

Method

describeOrganizationGroup GET

Copy GET

Returns the specific organization group passed in by the user.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	organizationGroupId	str	The unique identifier of the organization group to be described.

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

OrganizationGroup

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	`organizationGroupId` is not found.

Language: