Tallyfy

Attributes

Date module-attribute

Date = str

RequestDate module-attribute

RequestDate = str

Classes

GetUserTasksResponse dataclass

GetUserTasksResponse(*, data: Optional[List[Dict[str, Any]]] = None, meta: Optional[Dict[str, Any]] = None)

Response for Get a member's tasks

Attributes

data class-attribute instance-attribute

data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

data

meta class-attribute instance-attribute

meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

meta

InviteUserToOrganizationInput dataclass

InviteUserToOrganizationInput(first_name: str, last_name: str, email: str, message: str, role: str)

Invite a new member to your organization

Attributes

first_name instance-attribute

first_name: str

Invitee's first name

last_name instance-attribute

last_name: str

invitee's last name

email instance-attribute

email: str

invitee's work email address

message instance-attribute

message: str

Message to add

role instance-attribute

role: str

Role

InviteUserToOrganizationResponse dataclass

InviteUserToOrganizationResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Invite a new member to your organization

Attributes

data class-attribute instance-attribute

data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

data

CreateRunInput dataclass

CreateRunInput(name: str, checklist_id: str, *, summary: Optional[str] = None)

Launch a Process

Attributes

name instance-attribute

name: str

Name to give the new Process

checklist_id instance-attribute

checklist_id: str

ID of the Blueprint to start the process

summary class-attribute instance-attribute

summary: Optional[str] = dataclass_field(default=None, kw_only=True)

Summary notes to include with the Process

CreateRunResponse dataclass

CreateRunResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Launch a Process

Attributes

data class-attribute instance-attribute

data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

data

CompletedOneOffTaskInput dataclass

CompletedOneOffTaskInput(task_id: str, *, is_approved: Optional[bool] = None)

Complete One Off Task

Attributes

task_id instance-attribute

task_id: str

Task ID

is_approved class-attribute instance-attribute

is_approved: Optional[bool] = dataclass_field(default=None, kw_only=True)

starred

CompletedOneOffTaskResponse dataclass

CompletedOneOffTaskResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Complete One Off Task

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ReopenOneOffTaskResponse dataclass

ReopenOneOffTaskResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Reopen One Off Task

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CompletedProcessTaskInput dataclass

CompletedProcessTaskInput(task_id: str, *, is_approved: Optional[bool] = None)

Complete process task

Attributes

task_id instance-attribute

task_id: str

Task ID

is_approved class-attribute instance-attribute

is_approved: Optional[bool] = dataclass_field(default=None, kw_only=True)

starred

CompletedProcessTaskResponse dataclass

CompletedProcessTaskResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Complete process task

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ReopenProcessTaskResponse dataclass

ReopenProcessTaskResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Reopen process Task

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CommentTaskInput dataclass

CommentTaskInput(content: str, label: str)

Add comment, report issue, resolve issue on a task

Attributes

content instance-attribute

content: str

Comment content

label instance-attribute

label: str

Comment label

CommentTaskResponse dataclass

CommentTaskResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Add comment, report issue, resolve issue on a task

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateTaskInput dataclass

CreateTaskInput(task_type: str, deadline: str, name: str, *, owners: Optional[Dict[str, Any]] = None, description: Optional[str] = None)

Create a task

Attributes

owners class-attribute instance-attribute

owners: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

owners

task_type instance-attribute

task_type: str

Task type

deadline instance-attribute

deadline: str

task deadline, in date-time format

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Task's description

name instance-attribute

name: str

task name

CreateTaskResponse dataclass

CreateTaskResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create a task

Attributes

data class-attribute instance-attribute

data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

data

EditTaskDeadlineInput dataclass

EditTaskDeadlineInput(*, deadline: Optional[str] = None)

Edit task deadline

Attributes

deadline class-attribute instance-attribute

deadline: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Deadline'})

New task deadline

EditTaskDeadlineResponse dataclass

EditTaskDeadlineResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Edit task deadline

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

RemoveGuestResponse dataclass

RemoveGuestResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Remove guest assigned

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

RemoveAssigneeResponse dataclass

RemoveAssigneeResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Remove assignee

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

EditStepTypeInput dataclass

EditStepTypeInput(*, step_type: Optional[str] = None)

Edit step type

Attributes

step_type class-attribute instance-attribute

step_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'stepType'})

New step type

EditStepTypeResponse dataclass

EditStepTypeResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Edit step type

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetUserOrganizationsResponse dataclass

GetUserOrganizationsResponse(*, data: Optional[List[Dict[str, Any]]] = None, meta: Optional[Dict[str, Any]] = None)

Response for Get user's organizations

Attributes

data class-attribute instance-attribute

data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

data

meta class-attribute instance-attribute

meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

meta

GetOrganizationUsersResponse dataclass

GetOrganizationUsersResponse(*, data: Optional[List[Dict[str, Any]]] = None)

Response for Get organization's users

Attributes

data class-attribute instance-attribute

data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

data

Error dataclass

Error(message: str, *, error: Optional[bool] = None)

Definition: error

Address dataclass

Address(*, address1: Optional[str] = None, address2: Optional[str] = None, city: Optional[str] = None, state: Optional[str] = None, zip: Optional[str] = None, country: Optional[str] = None, phone: Optional[str] = None)

Definition: Address

LoginInput dataclass

LoginInput(email: str, password: str)

Definition: loginInput

File dataclass

File(*, name: Optional[str] = None, url: Optional[str] = None, extension: Optional[str] = None, size: Optional[int] = None, last_modified: Optional[str] = None)

Definition: File

RegisterInput dataclass

RegisterInput(first_name: str, last_name: str, email: str, password: str, company_name: str, plan_code: str, *, timezone: Optional[str] = None, coupon_code: Optional[str] = None)

Definition: registerInput

ResetPasswordInput dataclass

ResetPasswordInput(*, password: Optional[str] = None, password_confirmation: Optional[str] = None, code: Optional[str] = None)

Definition: resetPasswordInput

OrganizationInput dataclass

OrganizationInput(*, name: Optional[str] = None, address1: Optional[str] = None, address2: Optional[str] = None, address3: Optional[str] = None, slug: Optional[str] = None, welcome_title: Optional[str] = None, welcome_description: Optional[str] = None, industry: Optional[str] = None, country: Optional[str] = None, state: Optional[str] = None, city: Optional[str] = None, zipcode: Optional[str] = None, settings: Optional[OrganizationSettings | Mapping[str, Any]] = None)

Definition: organizationInput

OrganizationSettings dataclass

OrganizationSettings(*, determine_deadline: Optional[GenericObject | Mapping[str, Any]] = None, workdays: Optional[List[str]] = None, holidays: Optional[List[str]] = None)

Definition: organizationSettings

BillInput dataclass

BillInput(token_id: str)

Definition: billInput

SubcriptionInput dataclass

SubcriptionInput(*, plan_code: Optional[str] = None, coupon_code: Optional[str] = None)

Definition: subcriptionInput

AccountInput dataclass

AccountInput(*, email: Optional[str] = None, cc_emails: Optional[str] = None, address: Optional[Address | Mapping[str, Any]] = None)

Definition: accountInput

RunView dataclass

RunView(*, name: Optional[str] = None, is_active: Optional[int] = None, filter_type: Optional[str] = None, criteria: Optional[List[str]] = None)

Definition: RunView

RunViewInput dataclass

RunViewInput(*, name: Optional[str] = None, filter_type: Optional[str] = None, is_active: Optional[int] = None, criteria: Optional[List[Dict[str, Any]]] = None)

Definition: runViewInput

PreferenceInput dataclass

PreferenceInput(*, slug: Optional[str] = None, value: Optional[str] = None, metadata: Optional[GenericObject | Mapping[str, Any]] = None)

Definition: preferenceInput

AccountsInput dataclass

AccountsInput(*, email: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, username: Optional[str] = None, phone: Optional[str] = None, job_title: Optional[str] = None, job_description: Optional[str] = None, timezone: Optional[str] = None, country_id: Optional[int] = None)

Definition: accountsInput

InviteInput dataclass

InviteInput(*, first_name: Optional[str] = None, last_name: Optional[str] = None, email: Optional[str] = None)

Definition: inviteInput

Passwordreset dataclass

Passwordreset(*, new_password: Optional[str] = None)

Definition: passwordreset

Passwordreseterro dataclass

Passwordreseterro(*, error: Optional[bool] = None, message: Optional[str] = None, code: Optional[str] = None)

Definition: passwordreseterro

CheckUrlInput dataclass

CheckUrlInput(url: str)

Definition: checkUrlInput

AssetSubject dataclass

AssetSubject(*, id: Optional[int] = None, type_: Optional[str] = None)

Definition: AssetSubject

Asset dataclass

Asset(*, id: Optional[str] = None, filename: Optional[str] = None, version: Optional[int] = None, step_id: Optional[str] = None, uploaded_from: Optional[str] = None, subject: Optional[AssetSubject | Mapping[str, Any]] = None)

Definition: Asset

CaptureInput dataclass

CaptureInput(*, alias: Optional[str] = None, field_type: Optional[str] = None, guidance: Optional[str] = None, label: Optional[str] = None, position: Optional[int] = None, required: Optional[bool] = None, options: Optional[List[GenericObject | Mapping[str, Any]]] = None)

Definition: CaptureInput

Capture dataclass

Capture(*, id: Optional[int] = None, step_id: Optional[int] = None, alias: Optional[str] = None, field_type: Optional[str] = None, guidance: Optional[str] = None, label: Optional[str] = None, position: Optional[int] = None, required: Optional[bool] = None, options: Optional[str] = None, created_at: Optional[RequestDate] = None, last_updated: Optional[RequestDate] = None, archived_at: Optional[RequestDate] = None)

Definition: Capture

BrandingInput dataclass

BrandingInput(*, bg_color: Optional[str] = None, text_color: Optional[str] = None, alternate_color: Optional[str] = None, bright_shade: Optional[str] = None, dark_shade: Optional[str] = None)

Definition: brandingInput

Branding dataclass

Branding(*, bg_color: Optional[str] = None, text_color: Optional[str] = None, alternate_color: Optional[str] = None, bright_shade: Optional[str] = None, dark_shade: Optional[str] = None, updated_at: Optional[Date] = None)

Definition: Branding

ChecklistInput dataclass

ChecklistInput(*, checklist: Optional[Checklist | Mapping[str, Any]] = None)

Definition: checklistInput

PowerbuilderInput dataclass

PowerbuilderInput(*, id: Optional[str] = None, steps: Optional[str] = None)

Definition: powerbuilderInput

CreateChecklistInput dataclass

CreateChecklistInput(*, title: Optional[str] = None, summary: Optional[str] = None, privacy: Optional[str] = None, settings: Optional[GenericObject | Mapping[str, Any]] = None, contributors: Optional[List[int]] = None, tags: Optional[List[str]] = None, start_run_permissions: Optional[GenericObject | Mapping[str, Any]] = None, prerun: Optional[GenericObject | Mapping[str, Any]] = None, user_id: Optional[int] = None, owner_id: Optional[int] = None)

Definition: createChecklistInput

Attributes

contributors class-attribute instance-attribute

contributors: Optional[List[int]] = dataclass_field(default=None, kw_only=True)

The list of users who can update the checklist.

start_run_permissions class-attribute instance-attribute

start_run_permissions: Optional[GenericObject | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

The list of groups and users who can access the run.

user_id class-attribute instance-attribute

user_id: Optional[int] = dataclass_field(default=None, kw_only=True)

Template creator ID

owner_id class-attribute instance-attribute

owner_id: Optional[int] = dataclass_field(default=None, kw_only=True)

Template Owner ID

Checklist dataclass

Checklist(*, id: Optional[str] = None, title: Optional[str] = None, summary: Optional[str] = None, privacy: Optional[str] = None, starred: Optional[int] = None, settings: Optional[GenericObject | Mapping[str, Any]] = None, contributors: Optional[List[int]] = None, statistics: Optional[GenericObject | Mapping[str, Any]] = None, created_by: Optional[int] = None, owner_id: Optional[int] = None, created_at: Optional[Date] = None, last_updated: Optional[Date] = None, archived_at: Optional[Date] = None, created_ago: Optional[str] = None, steps: Optional[List[Step | Mapping[str, Any]]] = None)

Definition: Checklist

Attributes

contributors class-attribute instance-attribute

contributors: Optional[List[int]] = dataclass_field(default=None, kw_only=True)

The list of users who can update the Blueprint.

owner_id class-attribute instance-attribute

owner_id: Optional[int] = dataclass_field(default=None, kw_only=True)

Template Owner ID

CommentOn dataclass

CommentOn(*, id: Optional[int] = None, type_: Optional[str] = None)

Definition: comment_on

CreateCommentInput dataclass

CreateCommentInput(*, comment_on: Optional[CommentOn | Mapping[str, Any]] = None, content: Optional[str] = None)

Definition: createCommentInput

Comment dataclass

Comment(*, id: Optional[int] = None, comment_on: Optional[CommentOn | Mapping[str, Any]] = None, content: Optional[str] = None, replies_count: Optional[int] = None, author_id: Optional[int] = None, metadata: Optional[str] = None, archived_at: Optional[str] = None)

Definition: Comment

CreateGroupInput dataclass

CreateGroupInput(*, name: Optional[str] = None, users: Optional[List[int]] = None)

Definition: createGroupInput

Group dataclass

Group(*, id: Optional[int] = None, name: Optional[str] = None, created_at: Optional[Date] = None, updated_at: Optional[Date] = None)

Definition: Group

IntegrationS3Input dataclass

IntegrationS3Input(*, aws_key: Optional[str] = None, aws_secret: Optional[str] = None, aws_region: Optional[str] = None, aws_bucket: Optional[str] = None, aws_account_id: Optional[str] = None)

Definition: integrationS3Input

Message dataclass

Message(*, id: Optional[int] = None, thread_id: Optional[str] = None, label: Optional[str] = None, thread_last_updated_at: Optional[str] = None, updated_at: Optional[Date] = None, content: Optional[str] = None, sent_by: Optional[int] = None, sent_at: Optional[Date] = None, created_ago: Optional[str] = None, sent_to: Optional[List[int]] = None, author_name: Optional[str] = None, author: Optional[GenericObject | Mapping[str, Any]] = None, subject: Optional[GenericObject | Mapping[str, Any]] = None)

Definition: Message

Organization dataclass

Organization(*, id: Optional[int] = None, name: Optional[str] = None, address1: Optional[str] = None, address2: Optional[str] = None, address3: Optional[str] = None, slug: Optional[str] = None, welcome_title: Optional[str] = None, welcome_description: Optional[str] = None, created_on: Optional[Date] = None, last_updated: Optional[Date] = None, user_status: Optional[str] = None, joined_on: Optional[Date] = None, disabled_on: Optional[Date] = None, last_accessed: Optional[Date] = None)

Definition: Organization

Preference dataclass

Preference(*, slug: Optional[str] = None, value: Optional[str] = None, metadata: Optional[GenericObject | Mapping[str, Any]] = None, last_updated: Optional[Date] = None)

Definition: Preference

RunRatingsInput dataclass

RunRatingsInput(*, rating: Optional[float] = None, comment: Optional[str] = None)

Definition: runRatingsInput

CreateRoleInput dataclass

CreateRoleInput(*, name: Optional[str] = None, permissions: Optional[List[str]] = None)

Definition: createRoleInput

Role dataclass

Role(*, id: Optional[int] = None, name: Optional[str] = None, permissions: Optional[GenericObject | Mapping[str, Any]] = None, created_at: Optional[Date] = None, updated_at: Optional[Date] = None)

Definition: Role

RunCollaborators dataclass

RunCollaborators(*, members: Optional[List[int]] = None, guests: Optional[List[str]] = None)

Definition: runCollaborators

OwnerInput dataclass

OwnerInput(*, owners: Optional[Any] = None)

Definition: ownerInput

DueDateInput dataclass

DueDateInput(*, deadline: Optional[str] = None)

Definition: dueDateInput

PrerunData dataclass

PrerunData(*, id: Optional[str] = None, alias: Optional[str] = None, created_at: Optional[Date] = None, field_type: Optional[str] = None, field_value: Optional[str] = None, label: Optional[str] = None, updated_at: Optional[Date] = None, options: Optional[str] = None, position: Optional[int] = None, required: Optional[bool] = None, value: Optional[str] = None)

Definition: PrerunData

AlertIssues dataclass

AlertIssues(*, id: Optional[str] = None, task_id: Optional[str] = None, label: Optional[str] = None, content: Optional[str] = None, sent_to: Optional[GenericObject | Mapping[str, Any]] = None, sent_by: Optional[int] = None, created_at: Optional[Date] = None, created_ago: Optional[str] = None, recent_updated_at: Optional[Date] = None, author: Optional[GenericObject | Mapping[str, Any]] = None, resolve_id: Optional[int] = None)

Definition: AlertIssues

RunAlerts dataclass

RunAlerts(*, issues: Optional[List[AlertIssues | Mapping[str, Any]]] = None)

Definition: RunAlerts

Run dataclass

Run(*, id: Optional[str] = None, checklist_id: Optional[str] = None, name: Optional[str] = None, summary: Optional[str] = None, status: Optional[str] = None, progress: Optional[GenericObject | Mapping[str, Any]] = None, started_by: Optional[int] = None, owner_id: Optional[int] = None, prerun: Optional[List[PrerunData | Mapping[str, Any]]] = None, alerts: Optional[RunAlerts | Mapping[str, Any]] = None, starred: Optional[bool] = None, created_at: Optional[Date] = None, started_at: Optional[Date] = None, last_updated: Optional[Date] = None, last_synced: Optional[Date] = None, completed_at: Optional[Date] = None, archived_at: Optional[Date] = None, due_date_passed: Optional[bool] = None, collaborators: Optional[List[int]] = None, due_soon: Optional[bool] = None, max_task_deadline: Optional[Date] = None)

Definition: Run

RunMetaInput dataclass

RunMetaInput(*, run_id: Optional[str] = None, category: Optional[str] = None, slug: Optional[str] = None, value: Optional[str] = None)

Definition: runMetaInput

Section dataclass

Section(*, id: Optional[str] = None, checklist_id: Optional[str] = None, name: Optional[str] = None, position: Optional[int] = None, condition: Optional[GenericObject | Mapping[str, Any]] = None)

Definition: Section

SectionInput dataclass

SectionInput(*, name: Optional[str] = None, position: Optional[int] = None, condition: Optional[StepCondition | Mapping[str, Any]] = None)

Definition: SectionInput

SectionCreateInput dataclass

SectionCreateInput(*, name: Optional[str] = None, position: Optional[int] = None)

Definition: SectionCreateInput

StandaloneTask dataclass

StandaloneTask(*, id: Optional[str] = None, title: Optional[str] = None, run_id: Optional[str] = None, step_id: Optional[str] = None, alias: Optional[str] = None, taskdata: Optional[GenericObject | Mapping[str, Any]] = None, owners: Optional[StepOwner | Mapping[str, Any]] = None, is_completable: Optional[int] = None, status: Optional[str] = None, position: Optional[int] = None, deadline: Optional[Date] = None, created_at: Optional[Date] = None, last_updated: Optional[Date] = None, archived_at: Optional[Date] = None, completed_at: Optional[Date] = None, starter_id: Optional[int] = None, completer_id: Optional[int] = None, name: Optional[str] = None, description: Optional[str] = None, owner_id: Optional[int] = None, task_type: Optional[str] = None, is_accepted: Optional[int] = None)

Definition: StandaloneTask

CreateStandaloneTaskInput dataclass

CreateStandaloneTaskInput(*, owners: Optional[StepOwner | Mapping[str, Any]] = None, task_type: Optional[str] = None, deadline: Optional[RequestDate] = None, description: Optional[str] = None, name: Optional[str] = None)

Definition: createStandaloneTaskInput

UpdateStandaloneTaskInput dataclass

UpdateStandaloneTaskInput(*, taskdata: Optional[GenericObject | Mapping[str, Any]] = None, owners: Optional[StepOwner | Mapping[str, Any]] = None, name: Optional[str] = None, description: Optional[str] = None, task_type: Optional[str] = None, status: Optional[str] = None, deadline: Optional[RequestDate] = None)

Definition: updateStandaloneTaskInput

StepOwner dataclass

StepOwner(*, users: Optional[List[int]] = None, guests: Optional[List[str]] = None)

Definition: stepOwner

StepDeadline dataclass

StepDeadline(*, value: Optional[int] = None, unit: Optional[str] = None, option: Optional[str] = None, step: Optional[str] = None)

Definition: stepDeadline

StepConditionTerm dataclass

StepConditionTerm(*, subject_id: Optional[str] = None, subject_type: Optional[str] = None, operation: Optional[str] = None, statement: Optional[str] = None, logic: Optional[str] = None)

Definition: StepConditionTerm

StepCondition dataclass

StepCondition(*, terms: Optional[List[StepConditionTerm | Mapping[str, Any]]] = None, flag: Optional[str] = None)

Definition: StepCondition

CreateStepInput dataclass

CreateStepInput(*, title: Optional[str] = None, checklist_id: Optional[str] = None, summary: Optional[str] = None, rationale: Optional[str] = None, position: Optional[int] = None, owners: Optional[StepOwner | Mapping[str, Any]] = None, invisibility: Optional[GenericObject | Mapping[str, Any]] = None, settings: Optional[GenericObject | Mapping[str, Any]] = None, metadata: Optional[GenericObject | Mapping[str, Any]] = None, condition: Optional[StepCondition | Mapping[str, Any]] = None, captures: Optional[List[CaptureInput | Mapping[str, Any]]] = None)

Definition: createStepInput

Attributes

invisibility class-attribute instance-attribute

invisibility: Optional[GenericObject | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

The list of groups the step is invisible to.

Step dataclass

Step(*, id: Optional[int] = None, checklist_id: Optional[str] = None, summary: Optional[str] = None, title: Optional[str] = None, rationale: Optional[str] = None, position: Optional[int] = None, owners: Optional[StepOwner | Mapping[str, Any]] = None, invisibility: Optional[GenericObject | Mapping[str, Any]] = None, settings: Optional[GenericObject | Mapping[str, Any]] = None, metadata: Optional[GenericObject | Mapping[str, Any]] = None, deadline: Optional[StepDeadline | Mapping[str, Any]] = None, captures: Optional[GenericObject | Mapping[str, Any]] = None, condition: Optional[GenericObject | Mapping[str, Any]] = None, created_at: Optional[RequestDate] = None, last_updated: Optional[RequestDate] = None, archived_at: Optional[RequestDate] = None)

Definition: Step

Attributes

invisibility class-attribute instance-attribute

invisibility: Optional[GenericObject | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

The list of groups the step is invisible to.

StepMeta dataclass

StepMeta(*, step_id: Optional[str] = None, category: Optional[str] = None, slug: Optional[str] = None, value: Optional[str] = None, created_at: Optional[Date] = None, last_updated: Optional[Date] = None, archived_at: Optional[Date] = None)

Definition: StepMeta

Tag dataclass

Tag(*, id: Optional[str] = None, title: Optional[str] = None, items: Optional[int] = None, created_at: Optional[Date] = None, deleted_at: Optional[Date] = None)

Definition: Tag

CreateTagInput dataclass

CreateTagInput(*, title: Optional[str] = None)

Definition: createTagInput

AddTagInput dataclass

AddTagInput(*, tag_id: Optional[str] = None, subject_id: Optional[str] = None, subject_type: Optional[str] = None)

Definition: addTagInput

TaskObject dataclass

TaskObject(*, id: Optional[str] = None, title: Optional[str] = None, run_id: Optional[str] = None, step_id: Optional[str] = None, alias: Optional[str] = None, taskdata: Optional[GenericObject | Mapping[str, Any]] = None, owners: Optional[StepOwner | Mapping[str, Any]] = None, is_completable: Optional[bool] = None, status: Optional[str] = None, position: Optional[int] = None, deadline: Optional[Date] = None, created_at: Optional[Date] = None, last_updated: Optional[Date] = None, archived_at: Optional[Date] = None, completed_at: Optional[Date] = None, starter_id: Optional[int] = None, completer_id: Optional[int] = None, run_status: Optional[str] = None)

Definition: Task

Pagination dataclass

Pagination(*, total: Optional[int] = None, count: Optional[int] = None, per_page: Optional[int] = None, current_page: Optional[int] = None, total_pages: Optional[int] = None, links: Optional[GenericObject | Mapping[str, Any]] = None)

Definition: Pagination

TasksListMeta dataclass

TasksListMeta(*, overdue_tasks: Optional[int] = None, tasks_due_soon: Optional[int] = None, pagination: Optional[Pagination | Mapping[str, Any]] = None)

Definition: TasksListMeta

TasksList dataclass

TasksList(*, data: Optional[List[TaskObject | Mapping[str, Any]]] = None, meta: Optional[TasksListMeta | Mapping[str, Any]] = None)

Definition: TasksList

CompletedProcessTask dataclass

CompletedProcessTask(*, id: Optional[str] = None, title: Optional[str] = None, run_id: Optional[str] = None, step_id: Optional[str] = None, alias: Optional[str] = None, taskdata: Optional[GenericObject | Mapping[str, Any]] = None, owners: Optional[StepOwner | Mapping[str, Any]] = None, is_completable: Optional[bool] = None, status: Optional[str] = None, position: Optional[int] = None, deadline: Optional[Date] = None, created_at: Optional[Date] = None, last_updated: Optional[Date] = None, archived_at: Optional[Date] = None, completed_at: Optional[Date] = None, starter_id: Optional[int] = None, completer_id: Optional[int] = None, run_status: Optional[str] = None, tasks_changed_by_rules: Optional[GenericObject | Mapping[str, Any]] = None)

Definition: CompletedProcessTask

UpdateTaskInput dataclass

UpdateTaskInput(*, taskdata: Optional[GenericObject | Mapping[str, Any]] = None, threads: Optional[Dict[str, Any]] = None, owners: Optional[StepOwner | Mapping[str, Any]] = None, status: Optional[str] = None, position: Optional[int] = None, deadline: Optional[Date] = None)

Definition: updateTaskInput

TaskGuest dataclass

TaskGuest(*, alias: Optional[str] = None, organization: Optional[GenericObject | Mapping[str, Any]] = None, taskdata: Optional[GenericObject | Mapping[str, Any]] = None, threads: Optional[GenericObject | Mapping[str, Any]] = None, status: Optional[str] = None, is_completable: Optional[bool] = None, deadline: Optional[Date] = None, created_at: Optional[Date] = None, last_updated: Optional[Date] = None, completed_at: Optional[Date] = None, step: Optional[Step | Mapping[str, Any]] = None, step_id: Optional[int] = None, guest_email: Optional[str] = None)

Definition: TaskGuest

UpdateGuestsTasksInput dataclass

UpdateGuestsTasksInput(*, taskdata: Optional[GenericObject | Mapping[str, Any]] = None, status: Optional[str] = None)

Definition: updateGuestsTasksInput

CreateGuestsTasksComment dataclass

CreateGuestsTasksComment(*, content: Optional[str] = None)

Definition: createGuestsTasksComment

TaskMetaInput dataclass

TaskMetaInput(*, slug: Optional[str] = None, value: Optional[GenericObject | Mapping[str, Any]] = None)

Definition: TaskMetaInput

TaskMeta dataclass

TaskMeta(*, task_id: Optional[str] = None, slug: Optional[str] = None, value: Optional[str] = None, created_at: Optional[Date] = None, last_updated: Optional[Date] = None, archived_at: Optional[Date] = None)

Definition: TaskMeta

ThreadInput dataclass

ThreadInput(*, content: Optional[str] = None)

Definition: threadInput

ThreadResolveInput dataclass

ThreadResolveInput(*, thread_id: Optional[str] = None, content: Optional[str] = None)

Definition: threadResolveInput

Thread dataclass

Thread(*, id: Optional[int] = None, label: Optional[str] = None, sent_by: Optional[int] = None, content: Optional[str] = None, created_at: Optional[Date] = None, sent_to: Optional[List[int]] = None, last_updated_at: Optional[Date] = None, archived_at: Optional[Date] = None)

Definition: Thread

User dataclass

User(*, id: Optional[int] = None, email: Optional[str] = None, username: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, full_name: Optional[str] = None, phone: Optional[str] = None, job_title: Optional[str] = None, job_description: Optional[str] = None, profile_pic: Optional[str] = None, locale: Optional[str] = None, active: Optional[bool] = None, is_suspended: Optional[bool] = None, country: Optional[str] = None, created_at: Optional[Date] = None, last_updated: Optional[Date] = None, last_login_at: Optional[Date] = None)

Definition: User

AccessToken dataclass

AccessToken(*, access_token: Optional[str] = None, token_type: Optional[str] = None, expire: Optional[int] = None, expires_in: Optional[int] = None)

Definition: AccessToken

GenericObject dataclass

GenericObject(*, additional_properties: Dict[str, Any] = dict())

Definition: GenericObject

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Client dataclass

Client(*, name: Optional[str] = None, redirect: Optional[str] = None)

Definition: Client

TallyfyClient

TallyfyClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for tallyfy connector.

Initialize a TallyfyClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

get_user_tasks async

get_user_tasks(org: str, user_id: int, *, q: Optional[str] = None, status: Optional[str] = None, sort: Optional[str] = None, tag: Optional[str] = None, page: Optional[int] = None, per_page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a member's tasks

Get all tasks that belong to a specific member

Swagger operation ID: Get_User_Tasks.

Parameters:

Name	Type	Description	Default
org	str	Organization Id.	required
user_id	int	Member Id.	required
q	Optional[str]	Search Tasks by their Process name.	None
status	Optional[str]	You can search all Tasks by status.	None
sort	Optional[str]	Add minus sign (-) before sort value if you want to sort records in descending order. Ex: sort=-improvements.	None
tag	Optional[str]	Search Tasks by Tag name.	None
page	Optional[int]	Which results page to retrieve. Default is 1.	None
per_page	Optional[int]	How many Tasks per page. Default is 10.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

invite_user_to_organization async

invite_user_to_organization(input: InviteUserToOrganizationInput | Mapping[str, Any], org: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Invite a new member to your organization

Invite a new member to your organization

Swagger operation ID: Invite_User_To_Organization.

Parameters:

Name	Type	Description	Default
input	InviteUserToOrganizationInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
org	str	Organization Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_run async

create_run(input: CreateRunInput | Mapping[str, Any], org: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Launch a Process

Launch a process using a blueprint

Swagger operation ID: Create_Run.

Parameters:

Name	Type	Description	Default
input	CreateRunInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
org	str	Organization Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

completed_one_off_task async

completed_one_off_task(input: CompletedOneOffTaskInput | Mapping[str, Any], org: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Complete One Off Task

Complete one off task

Swagger operation ID: Completed_One_Off_Task.

Parameters:

Name	Type	Description	Default
input	CompletedOneOffTaskInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
org	str	Organization Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

reopen_one_off_task async

reopen_one_off_task(org: str, task: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Reopen One Off Task

Reopen one off task

Swagger operation ID: Reopen_One_Off_Task.

Parameters:

Name	Type	Description	Default
org	str	Organization Id.	required
task	str	Task Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

completed_process_task async

completed_process_task(input: CompletedProcessTaskInput | Mapping[str, Any], org: str, run: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Complete process task

Complete process task

Swagger operation ID: Completed_Process_Task.

Parameters:

Name	Type	Description	Default
input	CompletedProcessTaskInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
org	str	Organization Id.	required
run	str	Run Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

reopen_process_task async

reopen_process_task(org: str, run: str, task: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Reopen process Task

Reopen process task

Swagger operation ID: Reopen_Process_Task.

Parameters:

Name	Type	Description	Default
org	str	Organization Id.	required
run	str	Run Id.	required
task	str	Task Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

comment_task async

comment_task(input: CommentTaskInput | Mapping[str, Any], org: str, task: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add comment, report issue, resolve issue on a task

task deadline, in date-time format

Swagger operation ID: Comment_Task.

Parameters:

Name	Type	Description	Default
input	CommentTaskInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
org	str	Organization Id.	required
task	str	Task Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_task async

create_task(input: CreateTaskInput | Mapping[str, Any], org: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a task

Create Task

Swagger operation ID: Create_Task.

Parameters:

Name	Type	Description	Default
input	CreateTaskInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
org	str	Organization Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

edit_task_deadline async

edit_task_deadline(input: EditTaskDeadlineInput | Mapping[str, Any], org: str, task: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Edit task deadline

Edit deadline of a task

Swagger operation ID: Edit_Task_Deadline.

Parameters:

Name	Type	Description	Default
input	EditTaskDeadlineInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
org	str	Organization Id.	required
task	str	Task id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

remove_guest async

remove_guest(org: str, task: str, guest: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Remove guest assigned

Remove guest of a task

Swagger operation ID: Remove_Guest.

Parameters:

Name	Type	Description	Default
org	str	Organization Id.	required
task	str	Task id.	required
guest	str	Guest email.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

remove_assignee async

remove_assignee(org: str, task: str, member: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Remove assignee

Remove assignee of a task

Swagger operation ID: Remove_Assignee.

Parameters:

Name	Type	Description	Default
org	str	Organization Id.	required
task	str	Task id.	required
member	str	Member id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

edit_step_type async

edit_step_type(input: EditStepTypeInput | Mapping[str, Any], org: str, blueprint: str, step: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Edit step type

Edit step type

Swagger operation ID: Edit_Step_Type.

Parameters:

Name	Type	Description	Default
input	EditStepTypeInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
org	str	Organization Id.	required
blueprint	str	Blueprint id.	required
step	str	Step id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_user_organizations async

get_user_organizations(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get user's organizations

Get user's organizations

Swagger operation ID: Get_User_Organizations.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_organization_users

list_organization_users(org: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get organization's users

Get all users belonging to an organization

Returns a single-page Azure Core async collection.

Swagger operation ID: Get_Organization_Users.

Parameters:

Name	Type	Description	Default
org	str	Organization Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.