Organizations

organizations

OrganizationId

Bases: str

Unique ID of an organization

OrganizationInvitationId

Bases: str

Unique ID of an invitation to an organization.

OrganizationApiTokenId

Bases: str

Unique ID of an organization API token.

QueryOrganizationsAction

Bases: BaseModel

Query the organizations of the instance.

QueryOrganizationsOutput

Bases: BaseModel

Output of querying the organizations of the instance.

organizations class-attribute instance-attribute

organizations = Field(description='List of organizations.')

QueryOrganizationsItem

Bases: BaseModel

Organization item.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

name class-attribute instance-attribute

name = Field(description='Name of the organization.')

QueryOrganizationMembersAction

Bases: BaseModel

Query the members of an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

QueryOrganizationMembersOutput

Bases: BaseModel

Output of querying the members of an organization.

members class-attribute instance-attribute

members = Field(description='List of members.')

QueryOrganizationMembersItem

Bases: BaseModel

Member item.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

display_name class-attribute instance-attribute

display_name = Field(
    default=None,
    description="Name of the user.",
    validation_alias="displayName",
    serialization_alias="displayName",
)

email class-attribute instance-attribute

email = Field(description='Email of the user.')

is_admin class-attribute instance-attribute

is_admin = Field(
    description="Whether the user is an administrator of the organization.",
    validation_alias="isAdmin",
    serialization_alias="isAdmin",
)

QueryOrganizationProjectsAction

Bases: BaseModel

Query the projects of an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

QueryOrganizationProjectsOutput

Bases: BaseModel

Output of querying the projects of an organization.

projects class-attribute instance-attribute

projects = Field(description='List of projects.')

QueryOrganizationProjectsItem

Bases: BaseModel

Project item.

project_id class-attribute instance-attribute

project_id = Field(
    description="ID of the project.",
    validation_alias="projectId",
    serialization_alias="projectId",
)

name class-attribute instance-attribute

name = Field(description='Name of the project.')

QueryOrganizationRepositoriesAction

Bases: BaseModel

Query the repositories of an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

QueryOrganizationRepositoriesOutput

Bases: BaseModel

Output of querying the repositories of an organization.

repositories class-attribute instance-attribute

repositories = Field(description='List of repositories.')

QueryOrganizationRepositoriesItem

Bases: BaseModel

Repository item.

repository_id class-attribute instance-attribute

repository_id = Field(
    description="ID of the repository.",
    validation_alias="repositoryId",
    serialization_alias="repositoryId",
)

public_name class-attribute instance-attribute

public_name = Field(
    description="Public name of the repository.",
    validation_alias="publicName",
    serialization_alias="publicName",
)

display_name class-attribute instance-attribute

display_name = Field(
    default=None,
    description="Display name of the repository (if any).",
    validation_alias="displayName",
    serialization_alias="displayName",
)

QueryOrganizationInvitationsAction

Bases: BaseModel

Query the invitations of an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

QueryOrganizationInvitationsOutput

Bases: BaseModel

Output of querying the invitations of an organization.

invitations class-attribute instance-attribute

invitations = Field(
    description="List of outstanding invitations."
)

QueryOrganizationInvitationsItem

Bases: BaseModel

Organization invitation item.

invitation_id class-attribute instance-attribute

invitation_id = Field(
    description="ID of the invitation.",
    validation_alias="invitationId",
    serialization_alias="invitationId",
)

email class-attribute instance-attribute

email = Field(
    description="Email address of the invited user."
)

inviting_user_id class-attribute instance-attribute

inviting_user_id = Field(
    default=None,
    description="ID of the inviting user.",
    validation_alias="invitingUserId",
    serialization_alias="invitingUserId",
)

CreateOrganizationAction

Bases: BaseModel

Create an organization.

name class-attribute instance-attribute

name = Field(description='Name of the organization.')

admins class-attribute instance-attribute

admins = Field(
    default=None, description="Admins of the organization."
)

requires_subscription class-attribute instance-attribute

requires_subscription = Field(
    description="Whether the organization requires a subscription.",
    validation_alias="requiresSubscription",
    serialization_alias="requiresSubscription",
)

CreateOrganizationOutput

Bases: BaseModel

Output of creating an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

DeleteOrganizationAction

Bases: BaseModel

Delete an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

AddOrganizationMemberAction

Bases: BaseModel

Add a user to an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user to add.",
    validation_alias="userId",
    serialization_alias="userId",
)

is_admin class-attribute instance-attribute

is_admin = Field(
    default=None,
    description="Whether the user should be an administrator of the organization.",
    validation_alias="isAdmin",
    serialization_alias="isAdmin",
)

RemoveOrganizationMemberAction

Bases: BaseModel

Remove a user from an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

SetOrganizationMemberIsAdminAction

Bases: BaseModel

Set whether the user is an administrator of the organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

is_admin class-attribute instance-attribute

is_admin = Field(
    description="Whether the user should be an administrator of the organization.",
    validation_alias="isAdmin",
    serialization_alias="isAdmin",
)

InviteOrganizationMemberAction

Bases: BaseModel

Invite a user to an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

email class-attribute instance-attribute

email = Field(
    description="Email address of the user to invite."
)

InviteOrganizationMemberOutput

Bases: BaseModel

Output of inviting a user to an organization.

invitation_id class-attribute instance-attribute

invitation_id = Field(
    description="ID of the invitation.",
    validation_alias="invitationId",
    serialization_alias="invitationId",
)

DeleteOrganizationInvitationAction

Bases: BaseModel

Delete an invitation to an organization.

invitation_id class-attribute instance-attribute

invitation_id = Field(
    description="ID of the invitation.",
    validation_alias="invitationId",
    serialization_alias="invitationId",
)

QueryOrganizationAuditLogAction

Bases: BaseModel

Query the audit log of an organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

QueryOrganizationAuditLogOutput

Bases: BaseModel

Output of querying the audit log of an organization.

events class-attribute instance-attribute

events = Field(description='List of audit log events.')