Invite

class labelbox.schema.invite.Invite(client, invite_response)[source]

Bases: DbObject

An object representing a user invite

cancel() → bool[source]

Cancels this invite.

This will prevent the invited user from accepting the invitation.

Returns:: True if the invite was successfully canceled, False otherwise.
Return type:: bool

static get_invites(client: Client) → PaginatedCollection[source]

Retrieves all invites for the organization.

Parameters:: client (Client) – The Labelbox client instance.
Returns:: A collection of Invite objects for the organization.
Return type:: PaginatedCollection

static get_project_invites(client: Client, project_id: str) → PaginatedCollection[source]

Retrieves all invites for a specific project.

Parameters:

client (Client) – The Labelbox client instance.
project_id (str) – The ID of the project to get invites for.

Returns:

A collection of Invite objects for the specified project.

Return type:

PaginatedCollection

class labelbox.schema.invite.InviteLimit(remaining: int, used: int, limit: int)[source]

Bases: object

remaining (int): Number of invites remaining in the org used (int): Number of invites used in the org limit (int): Maximum number of invites available to the org

class labelbox.schema.invite.InviteMemberStatus(value)[source]

Bases: str, Enum

Outcome of one address in Organization.invite_users.

class labelbox.schema.invite.InviteResult(email: str, status: InviteMemberStatus | str, reason: str | None, invite_id: str | None)[source]

Bases: object

email (str): The address as the server checked it: trimmed and lowercased when valid, trimmed when invalid status (InviteMemberStatus | str): The outcome; an unknown future value stays a string reason (Optional[str]): Why the address is not allowed or already a member, for example GROUP_ACCESS invite_id (Optional[str]): The invite id when an invite was created