Users, tokens & admin

Data types for users, tokens, integrations, tenants, uploads, and health checks.

info

All data types support standard serialization methods (to_json, from_json, to_dict, from_dict, to_str) which are omitted from the tables below.

User

User Dataclass that combines info from UserEntity and UserInfo.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
provider_name	str
provider_user_id	str
user_type	UserType
personal_access_tokens	List[PersonalAccessToken]
provider_user_state	Optional[UserState]
user_name	Optional[str]
display_name	Optional[str]
first_name	Optional[str]
last_name	Optional[str]
email	Optional[str]
machine_name	Optional[str]
machine_description	Optional[str]
control_tags	Optional[List[ControlTag]]
provider_tenant_id	Optional[str]
tenant_id	Optional[str]

UserType

Attributes:

Name	Type	Description
HUMAN	—
AGENT	—
ALL	—

UserState

Enum of all the possible states of a user account (from Zitadel).

Attributes:

Name	Type	Description
USER_STATE_ACTIVE	—
USER_STATE_INACTIVE	—
USER_STATE_DELETED	—
USER_STATE_LOCKED	—
USER_STATE_SUSPEND	—
USER_STATE_INITIAL	—
USER_STATE_UNSPECIFIED	—

UserStateOption

Enum for user state options.

Attributes:

Name	Type	Description
ACTIVE	—
ALL	—

ZitadelUserState

Enum of all the possible states of a user account (from Zitadel).

Attributes:

Name	Type	Description
USER_STATE_ACTIVE	—
USER_STATE_INACTIVE	—
USER_STATE_DELETED	—
USER_STATE_LOCKED	—
USER_STATE_SUSPEND	—
USER_STATE_INITIAL	—
USER_STATE_UNSPECIFIED	—

PersonalAccessToken

Class representing a personal access token object. This class is used to store information about personal access tokens, such as the token ID and the token name. Attributes ———- machine_user_id (str): The machine user ID. token (str): The token. token_id (str): The token ID. name (str): The token name. user_type (enum): The type of the user whose permissions the token grants. created_by_id (UUID): The user mapping ID of the user who created the token.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
machine_user_id	str
token	str
token_id	str
name	str
user_type	PersonalAccessTokenUserType
created_by_id	str

PersonalAccessTokenUserType

Attributes:

Name	Type	Description
HUMAN	—
AGENT	—

Token

Represents a cryptographic token used for verifying the integrity of binary content.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
sha	str
salt	str
created_by_id	Optional[str]

Methods:

Name	Description
from_storage_token	Create a Token instance from a core istari_digital_core.Token.
compare_token	Verify the integrity of a token against a given binary payload.
from_bytes	Create a token from a byte string and an optional salt.

TokenWithProperties

Token is a subclass of Base and represents a token used to store file information.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
sha	str
salt	str
name	str
extension	str
size	int
description	Optional[str]
mime	Optional[str]
version_name	Optional[str]
external_identifier	Optional[str]
display_name	Optional[str]
object_store_sha	Optional[ObjectStoreSha]

AppIntegration

A class representing a Foreign Data Host.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
integration_type	IntegrationType
tenant_id	Optional[str]
description	Optional[str]
auth_integrations	Optional[List[AuthIntegration]]

AuthIntegration

A class representing an Auth Integration.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
file	File
comments	List[Comment]
archive_status_history	List[ResourceArchiveStatus]
created_by_id	str
auth_integration_type	AuthIntegrationType
auth_type	FunctionAuthType
app_integration_id	Optional[str]

AuthIntegrationType

Attributes:

Name	Type	Description
GOOGLE_ACCOUNTS	—
WINDCHILL	—
TEAMWORK_CLOUD	—
DASSAULT_3D_PASSPORT	—
PING_ID	—
MICROSOFT_ENTRA	—

AuthIntegrationUpdate

A class representing a New Auth Integration.

Attributes:

Name	Type	Description
auth_integration_type	Optional[AuthIntegrationType]
auth_type	Optional[FunctionAuthType]
revision	Optional[FileRevision]

DataIntegration

A class representing a Foreign Data Host.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
name	str
integration_type	IntegrationType
tenant_id	Optional[str]
auth_integration_ids	Optional[List[AuthIntegration]]

IntegrationType

Attributes:

Name	Type	Description
GOOGLE_DRIVE	—
TEAMWORK_CLOUD	—
WINDCHILL	—
DASSAULT_3D_EXPERIENCE	—
MICROSOFT_365	—

NewAppIntegration

Attributes:

Name	Type	Description
description	str
integration_type	IntegrationType

NewAuthIntegration

A class representing a New Auth Integration.

Attributes:

Name	Type	Description
auth_integration_type	AuthIntegrationType
auth_type	FunctionAuthType
revision	FileRevision
app_integration_id	Optional[str]

NewDataIntegration

Attributes:

Name	Type	Description
name	str
integration_type	IntegrationType

TenantPublicKey

Class representing a tenant public key object. This class is used to store information about tenant public keys. Attributes ———- tenant_id (UUID): The tenant id. public_key (str): The public key.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
tenant_id	str
public_key	str

Tenant

Class representing a tenant object. This class is used to store information about tenants, combining what’s stored in the registry and what’s stored in the authn provider. Attributes ———- provider_tenant_id (str): The provider’s tenant id. provider_name (str): The provider’s name/type (e.g. Zitadel or Okta). name (str): The tenant name (comes from ProviderTenant object). state (str): The tenant state (comes from ProviderTenant object). primary_domain (str): The primary domain used by the tenant (comes from ProviderTenant object). object_store_id (UUID): The object store id associated with the tenant. If None the default object store is used.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
provider_tenant_id	str
provider_name	str
state	Optional[str]
primary_domain	Optional[str]
object_store_id	Optional[str]
name	Optional[str]
label	Optional[str]

Product

Represents a derived output (Product) generated from a file revision.

Attributes:

Name	Type	Description
revision_id	str
file_id	Optional[str]
resource_type	Optional[str]
resource_id	Optional[str]
relationship_identifier	Optional[str]

CreateMultipartUploadRequest

Attributes:

Name	Type	Description
sha	str
num_parts	int

CreateMultipartUploadResponse

Attributes:

Name	Type	Description
upload_id	str
upload_urls	Dict[str, TemporaryURL]

FinalizeMultipartUploadRequest

Attributes:

Name	Type	Description
action	FinalizeMultipartUploadAction
sha	str
upload_id	str
completed_parts	Optional[List[CompletedPartTypeDef]]

FinalizeMultipartUploadAction

Attributes:

Name	Type	Description
CANCEL	—
COMPLETE	—

CompletedPartTypeDef

Attributes:

Name	Type	Description
e_tag	Optional[str]
checksum_crc32	Optional[str]
checksum_crc32_c	Optional[str]
checksum_crc64_nvme	Optional[str]
checksum_sha1	Optional[str]
checksum_sha256	Optional[str]
part_number	Optional[int]

HealthcheckReport

Attributes:

Name	Type	Description
healthy	bool
checks	List[CheckResult]

CheckResult

Attributes:

Name	Type	Description
name	str
passed	bool
details	Optional[str]

PagePersonalAccessToken

Attributes:

Name	Type	Description
items	List[PersonalAccessToken]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageAppIntegration

Attributes:

Name	Type	Description
items	List[AppIntegration]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageAuthIntegration

Attributes:

Name	Type	Description
items	List[AuthIntegration]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageDataIntegration

Attributes:

Name	Type	Description
items	List[DataIntegration]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageTenant

Attributes:

Name	Type	Description
items	List[Tenant]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]