Client

Description: Create a new instance of the Istari client

Methods

Name	Description
add_artifact	Add an artifact
update_artifact
add_comment	Add a comment to a resource
update_comment	Update a comment
add_file	Add a file
update_file	Update a file
update_file_properties	Update file properties
add_job	Add a job
update_job	Update a job
add_model	Add a model
update_model	Update a model
add_function_auth_secret	This method creates a new function auth secret from a file.
add_user_control_taggings	Assign one or more control tags to a model. The list resource control taggings returned may be more than the number of control tags assigned,
remove_user_control_taggings	Remove (archive) one or more control tag access assignments from a user. The calling user must be a customer
add_model_control_taggings	Assign one or more control tags to a model. The list resource control taggings returned may be more than the number of control tags assigned,
remove_model_control_taggings	Remove (archive) one or more control tag assignments from a model. Owner or administrator access to the model its parent model is required to modify control tag
add_artifact_control_taggings	Assign one or more control tags to an artifact. Owner or administrator access to the artifacts parent model is required to modify control tag
remove_artifact_control_taggings	Archive one or more control taggings on a model. Owner or administrator access to the artifacts parent model is required to modify control tag
get_model_control_tags	Get list of control tags for the active control taggings on a model.
get_artifact_control_tags	Get list of control tags for the active control taggings on a model.
get_user_control_tags	Get list of control tags a user has been assigned access to.
get_user	Get a user from the registry. This method simply a convenience wrapper for “get_user_by_id” added for
get_resource
create_revision
create_secret_revision
update_revision_content
update_revision_properties
read_contents
read_properties
archive_artifact	This method archives an artifact by updating it’s archive status to Archived.
archive_comment	This method archives a comment by updating it’s archive status to Archived.
archive_configuration	This method archives a configuration by updating it’s archive status to Archived.
archive_file	This method archives a file by updating it’s archive status to Archived.
archive_file_revision	This method archives a FileRevision by updating it’s archive status to Archived.
archive_job	This method archives a job by updating it’s archive status to Archived.
archive_model	This method archives a model by updating it’s archive status to Archived.
archive_system	This method archives a system by updating it’s archive status to Archived.
archive_tag	This method archives a snapshot tag by updating it’s archive status to Archived.
copy_revision_to_existing_file	This method copies a revision to an existing file.
copy_revision_to_new_file	This method copies a revision to a new file.
create_access	This method shares a resource or file with a user by updating the resource or file’s access.
create_access_by_email_for_other_tenants	This method shares a resource or file across tenants by the applicable user’s email.
create_agent_personal_access_token	This method creates an agent personal access token.
create_auth_integration	This method creates a new AuthIntegration. Auth Integration names must be unique per org.
create_author	This method creates a new author.
create_configuration	This method creates a new configuration for a system.
create_control_tag	This method creates a new control tag.
create_app_integration	This method creates an app integration.
create_module	This methods creates a new module.
create_operating_system	This method creates a new operating system.
create_personal_access_token	This method creates a personal access token.
create_snapshot	This methods creates a new snapshot.
create_system	This method creates a new system.
create_tag	This method creates a new snapshot tag.
create_tenant_public_key	Creates a tenant public key.
create_tool	This method creates a new tool.
create_tool_versions	This method creates a new tool version.
delete_app_integration	This method deletes an app integration by id.
delete_personal_access_token	This method deletes a personal access token.
deprecate_module	This method deprecates all versions of a module.
deprecate_module_version	This method deprecates a module version.
fetch_function_auth_secret	This method gets a function auth secret by id.
find_function_auth_secret	This method lists all function auth secrets that a user has access to.
get_agent	This method gets an agent by id.
get_agent_available_jobs	This method gets the list of available jobs for an agent.
get_agent_display_name	This method gets an agent’s display name.
get_agent_modules	This method gets an agent’s loaded modules.
get_agent_status	This method gets an agent’s status.
get_artifact	This method gets an artifact from the database.
get_artifact_control_tagging_history	This method gets the full history of control taggings added to and removed from an artifact.
get_artifact_control_taggings	This method gets a artifact’s active control taggings.
get_author	This method gets an author by id.
get_comment	This method gets a comment by id
get_configuration	This method gets a configuration by id.
get_control_tag	This method gets a control tag by id.
get_control_tag_revision_history	Control tag revision history.
get_current_user	This method gets the current user.
get_app_integration	This method gets app integration info by id.
get_file	This method gets a file by id.
get_file_by_revision_id	This method gets a file by revision id.
get_file_control_tagging_history	This method gets the full history of control taggings added to and removed from a file.
get_file_control_taggings	This method gets a file’s active control taggings.
get_function	This method gets a function by id.
get_function_schema	This method gets a function schema by id.
get_job	This method gets a job by id.
get_model	This method gets a model by id.
get_model_control_tagging_history	This method gets the full history of control taggings added to and removed from a model.
get_model_control_taggings	This method gets a model’s active control taggings.
get_module	This method gets a module by id
get_module_version	This method gets a module version by id.
get_object_control_tags	Get the active control tag assignments for an object
get_operating_system	This method gets an operating system by id.
get_revision	This method gets a revision by id.
get_snapshot	This method gets a snapshot by id.
get_system	This method gets a system by id.
get_system_baseline	This method gets the system baseline by system id.
get_tag	This method gets a snapshot tag by id.
get_tenant_public_key	Gets a tenant public key.
get_tool	This method gets a tool by id
get_tool_version	This method gets a tool version by id.
get_user_by_id	This method gets a user by id.
get_user_control_tagging_history	This method gets the full history of control taggings added to and removed from a user.
get_user_control_taggings	This method gets a user’s active control taggings.
list_access	This method lists access for a resource or file.
list_agent_status_history	This method lists an agent’s status history.
list_agents	This method lists all agents a user has access to.
list_artifact_access	(Deprecated)
list_artifact_comments	This method lists all comments a user has access to for an artifact.
list_artifacts	This method lists all artifacts a user has access to.
list_auth_integration	This method lists all AuthIntegrations a user has access to.
list_authors	This method lists all authors a user has access to.
list_control_tags	List all control tags
list_app_integrations	This method lists app integration info a use has access to.
list_files	This method lists all files that a user has access to.
list_function_access	This method lists all access to a function.
list_functions	This method lists all functions a user has access to.
list_job_access	(Deprecated)
list_jobs	This method lists the jobs that a user has access to.
list_model_access	(Deprecated)
list_model_artifacts	This method lists all artifacts a user has access to for a model.
list_model_comments	This method lists all comments a user has access to for a model.
list_model_jobs	This method lists all jobs a user has access to for a model.
list_models	This methods lists all models a user has access to.
list_module_versions	This method list all module versions a user has access to.
list_modules	This method lists all modules a user has access to.
list_operating_systems	This method lists all operating systems a user has access to.
list_personal_access_tokens	This method lists all personal access tokens a user has access to.
list_resources	This method lists all resources a user has access to.
list_snapshot_items	This method lists all the snapshot items a user has access to.
list_snapshot_revisions	This method gets a snapshot’s revisions.
list_snapshots	This method lists all the snapshots a user has access to
list_system_configurations	This method lists all the system configurations a user has access to.
list_systems	This method lists all the systems a user has access to.
list_tags	This method lists all the snapshot tags a user has access to.
list_tool_versions	This method lists all tool versions a user has access to.
list_tools	This method list all tools a user has access to
list_tracked_files	This methods list all the tracked files for a configuration that the user has access to.
list_users	This method lists all users a user has access to.
liveness_check	Liveness probe
patch_artifact_access	(Deprecated)
patch_artifact_control_taggings	This method adds or removes control tags on a artifact.
patch_file_control_taggings	This method adds or removes control tags on a file.
patch_function_access	This method updates access to a function.
patch_job_access	(Deprecated)
patch_model_access	(Deprecated)
patch_model_control_taggings	This method adds or removes control tags on a model.
patch_user_control_taggings	This method adds or removes control tags on a user.
readiness_check	Readiness probe
register_agent	This method registers a new agent.
remove_access	This method removes access to a resource or file.
remove_job_assigned_agent	This method removes the assigned agent from a job.
restore_artifact	This method restores an artifact by updating it’s archive status to Active.
restore_comment	This method restores a comment by updating it’s archive status to Active.
restore_configuration	This method restores a configuration by updating it’s archive status to Active.
restore_file	This method restores a file by updating it’s archive status to Active.
restore_file_revision	This method restores a FileRevision by updating it’s archive status to Active.
restore_job	This method restores a job by updating it’s archive status to Active.
restore_model	This method restores a model by updating it’s archive status to Active.
restore_system	This method restores a system by updating it’s archive status to Active.
restore_tag	This method restores a snapshot tag by updating it’s archive status to Active.
revoke_all_personal_access_tokens	This method revokes all personal access tokens.
transfer_revision_to_existing_artifact	This method transfers a revision to an existing artifact. The original revision that was copied will be archived and no longer active.
transfer_revision_to_existing_file	This method transfers a file revision to an existing file. The original revision that was copied will be archived and no longer active.
transfer_revision_to_new_artifact	This method transfers a revision to a new artifact. The original revision that was copied will be archived and no longer active.
transfer_revision_to_new_file	This method transfers a file revision to a new file. The original revision that was copied will be archived and no longer active.
update_access	This method updates access to a resource or file.
update_agent_display_name	This method updates an agent’s display name.
update_agent_information	This method updates an agent’s information.
update_agent_modules	This method updates an agent’s loaded modules.
update_agent_status	This method updates an agent’s status.
update_auth_integration	This method updates an AuthIntegration. The auth integration name must be unique per org.
update_author	This method updates an author.
update_control_tag	This method updates an existing control tag.
update_app_integration	This method updates an app integration.
update_job_assigned_agent	This method updates the assigned agent for a job.
update_job_status	This method updates the status of a job.
update_operating_system	This method updates an existing operating system.
update_system	This method updates an existing system.
update_tag	This method updates an existing snapshot tag by moving it to a different snapshot.
update_tool	This method updates a tool.

add_artifact()

Add an artifact

• Parameters:

  • model_id (str) – The model ID to get (required)
  • path (PathLike) – The path to the artifact (required)
  • sources (List [**NewSource | str ] | None) – The sources of the artifact (optional)
  • description (str | None) – The description of the artifact (optional)
  • version_name (str | None) – The version name of the artifact (optional)
  • external_identifier (str | None) – The external identifier of the artifact (optional)
  • display_name (str | None) – The display name of the artifact (optional)

• Return Type: Artifact

update_artifact()

• Return Type: Artifact

add_comment()

Add a comment to a resource

• Parameters:

  • resource_id (str) – The resource to add the comment to (required)
  • path (PathLike) – The path to the comment (required)
  • description (str | None) – The description of the comment (optional)

• Return Type: Comment

update_comment()

Update a comment

• Parameters:

  • comment_id (str) – The comment to update (required)
  • path (PathLike) – The path to the comment (required)
  • description (str | None) – The description of the comment (optional)

• Return Type: Comment

add_file()

Add a file

• Parameters:

  • path (PathLike) – The path to the file (required)
  • sources (List [**NewSource | str ] | None) – The sources of the file (optional)
  • description (str | None) – The description of the file (optional)
  • version_name (str | None) – The version name of the file (optional)
  • external_identifier (str | None) – The external identifier of the file (optional)
  • display_name (str | None) – The display name of the file (optional)

• Return Type: File

update_file()

Update a file

• Parameters:

  • file_id (str) – The file to update (required)
  • path (PathLike | str) – The path to the file (required)
  • sources (List [**NewSource | str ] | None) – The sources of the file (optional)
  • description (str | None) – The description of the file (optional)
  • version_name (str | None) – The version name of the file (optional)
  • external_identifier (str | None) – The external identifier of the file (optional)
  • display_name (str | None) – The display name of the file (optional)

• Return Type: File

update_file_properties()

Update file properties

• Parameters:

  • file (File) – The file to update (required)
  • display_name (str | None) – The display name of the file (optional)
  • description (str | None) – The description of the file (optional)

• Return Type: File

add_job()

Add a job

• Parameters:

  • model_id (str) – The model to add the job to (required)
  • function (str) – The function of the job (required)
  • parameters (JSON | None) – The parameters of the job (optional)
  • parameters_file (PathLike | None) – The path to the parameters file (optional)
  • tool_name (str | None) – The name of the tool (optional)
  • tool_version (str | None) – The version of the tool (optional)
  • operating_system (str | None) – The operating system of the agent (optional)
  • assigned_agent_id (str | None) – The agent id for the agent assigned to execute the job (optional)
  • agent_identifier (str | None) – The agent identifier for the agent that created the job (optional)
  • sources (List [**NewSource | str ] | None) – The sources of the job (optional)
  • description (str | None) – The description of the job (optional)
  • version_name (str | None) – The version name of the job (optional)
  • external_identifier (str | None) – The external identifier of the job (optional)
  • display_name (str | None) – The display name of the job (optional)

• Return Type: Job

update_job()

Update a job

• Parameters:

  • job_id (str) – The job to update (required)
  • path (PathLike) – The path to the job (required)
  • sources (List [**NewSource | str ] | None) – The sources of the job (optional)
  • description (str | None) – The description of the job (optional)
  • version_name (str | None) – The version name of the job (optional)
  • external_identifier (str | None) – The external identifier of the job (optional)
  • display_name (str | None) – The display name of the job (optional)

• Return Type: Job

add_model()

Add a model

• Parameters:

  • path (PathLike) – The path to the model (required)
  • sources (List [**NewSource | str ] | None) – The sources of the model (optional)
  • description (str | None) – The description of the model (optional)
  • version_name (str | None) – The version name of the model (optional)
  • external_identifier (str | None) – The external identifier of the model (optional)
  • display_name (str | None) – The display name of the model (optional)

• Return Type: Model

update_model()

Update a model

• Parameters:

  • model_id (str) – The model to update (required)
  • path (PathLike) – The path to the model (required)
  • sources (List [**NewSource | str ] | None) – The sources of the model (optional)
  • description (str | None) – The description of the model (optional)
  • version_name (str | None) – The version name of the model (optional)
  • external_identifier (str | None) – The external identifier of the model (optional)
  • display_name (str | None) – The display name of the model (optional)

• Return Type: Model

add_function_auth_secret()

This method creates a new function auth secret from a file.

• Parameters:

  • auth_provider_name (str) – The name of the auth provider (required)
  • function_auth_type (FunctionAuthType) – The type of the function auth secret (required)
  • path (PathLike) – The path to the file containing the secret (required)
  • expiration (Optional [**datetime ]) – The expiration date of the secret (optional)

• Return Type: FunctionAuthSecret

add_user_control_taggings()

Assign one or more control tags to a model. The list resource control taggings returned may be more than the number of control tags assigned, as when a tag is applied to a model, the tagging is applied to each of its child artifacts as well. The calling user must be a customer admin on the tenant the target user is a member of or the operation will fail with a permission denied error.

• Parameters:

  • user_id (str) – The id of the user to assign control tag access to.
  • control_tag_ids (Iterable [**str ]) – The ids of the control tags to assign access to.
  • reason (Optional [**str ]) – The reason for the assignment (optional)

• Return Type: list[UserControlTagging]

remove_user_control_taggings()

Remove (archive) one or more control tag access assignments from a user. The calling user must be a customer admin on the tenant the target user is a member of or the operation will fail with a permission denied error.

• Parameters:

  • user_id (str) – The id of the user to remove control tag access from.
  • control_tag_ids (Iterable [**str ]) – The ids of the control tags to remove access assignments from.
  • reason (Optional [**str ]) – The reason for the assignment (optional)

• Return Type: list[UserControlTagging]

add_model_control_taggings()

Assign one or more control tags to a model. The list resource control taggings returned may be more than the number of control tags assigned, as when a tag is applied to a model, the tagging is applied to each of its child artifacts as well. Owner or administrator access to the model is required to modify control tag assignments.

• Parameters:

  • model_id (str) – The id of the model to assign the control tag to.
  • control_tag_ids (Iterable [**str ]) – The ids of the control tags to assign.
  • reason (Optional [**str ]) – The reason for the assignment (optional)

• Return Type: list[ResourceControlTagging]

remove_model_control_taggings()

Remove (archive) one or more control tag assignments from a model. Owner or administrator access to the model its parent model is required to modify control tag assignments.

• Parameters:

  • model_id (str) – The id of the model to remove the control tag assignment from (required)
  • control_tag_ids (Iterable [**str ]) – The ids of the control tags to assign (required)
  • reason – The reason for the assignment (optional)

• Return Type: list[ResourceControlTagging]

add_artifact_control_taggings()

Assign one or more control tags to an artifact. Owner or administrator access to the artifacts parent model is required to modify control tag assignments.

• Parameters:

  • artifact_id (str) – The id of the artifact to assign the control tag to (required)
  • control_tag_ids (Iterable [**str ]) – The ids of the control tags to assign (required)
  • reason (Optional [**str ]) – The reason for the assignment (optional)

• Return Type: list[ResourceControlTagging]

remove_artifact_control_taggings()

Archive one or more control taggings on a model. Owner or administrator access to the artifacts parent model is required to modify control tag assignments.

• Parameters:

  • artifact_id (str) – The id of the artifact to remove the control tag assignment from (required)
  • control_tag_ids (Iterable [**str ]) – The ids of the control tags to assign (required)
  • reason (Optional [**str ]) – The reason for the assignment (optional)

• Return Type: list[ResourceControlTagging]

get_model_control_tags()

Get list of control tags for the active control taggings on a model.

• Parameters: model_id (str) – The id of the model to get the assigned control tags for (required)

• Return Type: list[ControlTag]

get_artifact_control_tags()

Get list of control tags for the active control taggings on a model.

• Parameters: artifact_id (str) – The id of the artifact to get the assigned control tags for (required)

• Return Type: list[ControlTag]

get_user_control_tags()

Get list of control tags a user has been assigned access to.

• Parameters: user_id (str) – The id of the user to get the assigned control tags for (required)

• Return Type: list[ControlTag]

get_user()

Get a user from the registry. This method simply a convenience wrapper for “get_user_by_id” added for “get” method naming convention consistency (get_model, get_artifact, etc…)

• Parameters: user_id (str) – The id of the user to get (required)

• Return Type: User

get_resource()

• Return Type: Resource

create_revision()

• Return Type: FileRevision

create_secret_revision()

• Return Type: FileRevision

update_revision_content()

• Return Type: FileRevision

update_revision_properties()

• Return Type: File

read_contents()

• Return Type: bytes

read_properties()

• Return Type: Properties

archive_artifact()

This method archives an artifact by updating it’s archive status to Archived.

• Parameters:

  • artifact_id (str) – The id of the artifact to archive. This is a required field. (required)
  • archive (Archive)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Artifact

archive_comment()

This method archives a comment by updating it’s archive status to Archived.

• Parameters:

  • comment_id (str) – The ID of the comment to archive. (required)
  • archive (Archive)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Comment

archive_configuration()

This method archives a configuration by updating it’s archive status to Archived.

• Parameters:

  • configuration_id (str) – The id of the configuration to archive. (required)
  • archive (Archive)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SystemConfiguration

archive_file()

This method archives a file by updating it’s archive status to Archived.

• Parameters:

  • file_id (str) – The id of the file to archive. (required)
  • archive (Archive)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: File

archive_file_revision()

This method archives a FileRevision by updating it’s archive status to Archived.

• Parameters:

  • revision_id (str) – The id of the file revision to archive. (required)
  • archive (Archive)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FileRevision

archive_job()

This method archives a job by updating it’s archive status to Archived.

• Parameters:

  • job_id (str) – The id of the job to archive. (required)
  • archive (Archive)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Job

archive_model()

This method archives a model by updating it’s archive status to Archived.

• Parameters:

  • model_id (str) – The id of the model to archive. (required)
  • archive (Archive)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Model

archive_system()

This method archives a system by updating it’s archive status to Archived.

• Parameters:

  • system_id (str) – The id of the system to archive. (required)
  • archive (Archive)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: System

archive_tag()

This method archives a snapshot tag by updating it’s archive status to Archived.

• Parameters:

  • tag_id (str) – The id of the tag to archive. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SnapshotTag

copy_revision_to_existing_file()

This method copies a revision to an existing file.

• Parameters:

  • revision_id (str) – The id of the revision to copy (required)
  • file_id (str) – The id of the file to copy the revision to (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: File

copy_revision_to_new_file()

This method copies a revision to a new file.

• Parameters:

  • revision_id (str) – The id of the revision to copy (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: File

create_access()

This method shares a resource or file with a user by updating the resource or file’s access.

• Parameters:

  • access_relationship (AccessRelationship) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AccessRelationship

create_access_by_email_for_other_tenants()

This method shares a resource or file across tenants by the applicable user’s email.

• Parameters:

  • subject_type (AccessSubjectType) – The type of the subject to create. (required)
  • email (str) – The email of the subject to create access for. (required)
  • resource_type (AccessResourceType) – The type of the resource to create access for. (required)
  • resource_id (str) – The id of the resource to create access for. (required)
  • access_relationship (AccessRelation) – The access relationship to create. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AccessRelationship

create_agent_personal_access_token()

This method creates an agent personal access token.

• Parameters:

  • name (str) – The name of the personal access token. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PersonalAccessToken

create_author()

This method creates a new author.

• Parameters:

  • new_module_author (NewModuleAuthor) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleAuthor

create_configuration()

This method creates a new configuration for a system.

• Parameters:

  • system_id (str) – The id of the system to create a configuration for. (required)
  • new_system_configuration (NewSystemConfiguration) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SystemConfiguration

create_control_tag()

This method creates a new control tag.

• Parameters:

  • new_control_tag (NewControlTag) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ControlTag

create_app_integration()

This method creates an app integration.

• Parameters:

  • new_app_integration (NewAppIntegration) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AppIntegration

create_module()

This methods creates a new module.

• Parameters:

  • new_module_manifest (NewModuleManifest) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Module

create_operating_system()

This method creates a new operating system.

• Parameters:

  • new_operating_system (NewOperatingSystem) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: OperatingSystem

create_personal_access_token()

This method creates a personal access token.

• Parameters:

  • name (str) – The name of the personal access token. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PersonalAccessToken

create_snapshot()

This methods creates a new snapshot.

• Parameters:

  • configuration_id (str) – The id of the configuration to create a snapshot for. (required)
  • new_snapshot (NewSnapshot) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ResponseCreateSnapshot

create_system()

This method creates a new system.

• Parameters:

  • new_system (NewSystem) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: System

create_tag()

This method creates a new snapshot tag.

• Parameters:

  • snapshot_id (str) – The id of the snapshot to create a tag for. (required)
  • new_snapshot_tag (NewSnapshotTag) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SnapshotTag

create_tenant_public_key()

Creates a tenant public key.

• Parameters:

  • public_key_file (bytearray) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: TenantPublicKey

create_tool()

This method creates a new tool.

• Parameters:

  • new_tool (NewTool) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Tool

create_tool_versions()

This method creates a new tool version.

• Parameters:

  • tool_id (str) – The ID of the tool to add a version to. (required)
  • new_tool_version (NewToolVersion) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ToolVersion

delete_app_integration()

This method deletes an app integration by id.

• Parameters:

  • app_integration_id (str) – ID of the app integration to delete. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AppIntegration

delete_personal_access_token()

This method deletes a personal access token.

• Parameters:

  • pat_id (str) – The personal access token id. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: object

deprecate_module()

This method deprecates all versions of a module.

• Parameters:

  • module_id (str) – The id of the module to deprecate (required)
  • deprecation_reason (DeprecationReason) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Module

deprecate_module_version()

This method deprecates a module version.

• Parameters:

  • module_version_id (str) – The id of the module version to deprecate (required)
  • deprecation_reason (DeprecationReason) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleVersion

fetch_function_auth_secret()

This method gets a function auth secret by id.

• Parameters:

  • auth_secret_id (str) – The function auth secret ID to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FunctionAuthSecret

find_function_auth_secret()

This method lists all function auth secrets that a user has access to.

• Parameters:

  • app_integration_id (str)
  • auth_integration_type (AuthIntegrationType)
  • function_auth_type (FunctionAuthType)
  • expiration (datetime)
  • latest (bool)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[FunctionAuthSecret]

get_agent()

This method gets an agent by id.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

get_agent_available_jobs()

This method gets the list of available jobs for an agent.

• Parameters:

  • agent_identifier (str) – The identifier for the agent (required)
  • page (int) – Page number
  • size (int) – Page size
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageJob

get_agent_display_name()

This method gets an agent’s display name.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentDisplayName

get_agent_modules()

This method gets an agent’s loaded modules.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentModules

get_agent_status()

This method gets an agent’s status.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AgentStatus

get_artifact()

This method gets an artifact from the database.

• Parameters:

  • artifact_id (str) – The id of the artifact to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Artifact

get_artifact_control_tagging_history()

This method gets the full history of control taggings added to and removed from an artifact.

• Parameters:

  • artifact_id (str) – The ID of the artifact to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ResourceControlTagging]

get_artifact_control_taggings()

This method gets a artifact’s active control taggings.

• Parameters:

  • artifact_id (str) – The ID of the artifact to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ResourceControlTagging]

get_author()

This method gets an author by id.

• Parameters:

  • author_id (str) – The author ID to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleAuthor

get_comment()

This method gets a comment by id

• Parameters:

  • comment_id (str) – The ID of the comment to retrieve. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Comment

get_configuration()

This method gets a configuration by id.

• Parameters:

  • configuration_id (str) – The id of the configuration to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SystemConfiguration

get_control_tag()

This method gets a control tag by id.

• Parameters:

  • control_tag_id (str) – The ID of the control tag to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ControlTag

get_control_tag_revision_history()

Control tag revision history.

• Parameters:

  • control_tag_id (str) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ControlTagRevision]

get_current_user()

This method gets the current user.

• Parameters: http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: User

get_app_integration()

This method gets app integration info by id.

• Parameters:

  • app_integration_id (str) – ID of the app integration to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AppIntegration

get_file()

This method gets a file by id.

• Parameters:

  • file_id (str) – The id of the file to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: File

get_file_by_revision_id()

This method gets a file by revision id.

• Parameters:

  • revision_id (str) – The revision id of the file to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: File

get_file_control_tagging_history()

This method gets the full history of control taggings added to and removed from a file.

• Parameters:

  • file_id (str) – The ID of the file to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[FileControlTagging]

get_file_control_taggings()

This method gets a file’s active control taggings.

• Parameters:

  • file_id (str) – The ID of the file to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[FileControlTagging]

get_function()

This method gets a function by id.

• Parameters:

  • function_id (str) – ID of the function to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Function

get_function_schema()

This method gets a function schema by id.

• Parameters:

  • function_schema_id (str) – ID of the function schema to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FunctionSchema

get_job()

This method gets a job by id.

• Parameters:

  • job_id (str) – The id of the job to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Job

get_model()

This method gets a model by id.

• Parameters:

  • model_id (str) – The model ID to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Model

get_model_control_tagging_history()

This method gets the full history of control taggings added to and removed from a model.

• Parameters:

  • model_id (str) – The ID of the model to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ResourceControlTagging]

get_model_control_taggings()

This method gets a model’s active control taggings.

• Parameters:

  • model_id (str) – The ID of the model to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ResourceControlTagging]

get_module()

This method gets a module by id

• Parameters:

  • module_id (str) – The id of the module to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Module

get_module_version()

This method gets a module version by id.

• Parameters:

  • module_version_id (str) – The id of the module version to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleVersion

get_object_control_tags()

Get the active control tag assignments for an object

• Parameters:

  • object_type (ControlTaggingObjectType) – Type of object to get control tags for. This is a required field. (required)
  • object_id (str) – ID of the object to get control tags for. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ControlTag]

get_operating_system()

This method gets an operating system by id.

• Parameters:

  • operating_system_id (str) – The operating system ID to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: OperatingSystem

get_revision()

This method gets a revision by id.

• Parameters:

  • revision_id (str) – The id of the revision to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FileRevision

get_snapshot()

This method gets a snapshot by id.

• Parameters:

  • snapshot_id (str) – The id of the snapshot to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Snapshot

get_system()

This method gets a system by id.

• Parameters:

  • system_id (str) – The id of the system to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: System

get_system_baseline()

This method gets the system baseline by system id.

• Parameters:

  • system_id (str) – The id of the system to get the baseline for. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SystemBaseline

get_tag()

This method gets a snapshot tag by id.

• Parameters:

  • tag_id (str) – The id of the tag to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SnapshotTag

get_tenant_public_key()

Gets a tenant public key.

• Parameters: http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: TenantPublicKey

get_tool()

This method gets a tool by id

• Parameters:

  • tool_id (str) – The ID of the tool to get. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Tool

get_tool_version()

This method gets a tool version by id.

• Parameters:

  • tool_version_id (str) – The tool version ID to get (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ToolVersion

get_user_by_id()

This method gets a user by id.

• Parameters:

  • user_id (str) – The id of the user. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: User

get_user_control_tagging_history()

This method gets the full history of control taggings added to and removed from a user.

• Parameters:

  • user_id (str) – The ID of the user to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[UserControlTagging]

get_user_control_taggings()

This method gets a user’s active control taggings.

• Parameters:

  • user_id (str) – The ID of the user to get. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[UserControlTagging]

list_access()

This method lists access for a resource or file.

• Parameters:

  • resource_type (AccessResourceType) – The type of the resource. (required)
  • resource_id (str) – The id of the resource. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

list_agent_status_history()

This method lists an agent’s status history.

• Parameters:

  • agent_id (str) – The ID of the agent to get. (required)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAgentStatus

list_agents()

This method lists all agents a user has access to.

• Parameters:

  • agent_version (str) – Filter by the agent version
  • host_os (str) – Filter by the host OS
  • updated_since (datetime) – Filter by last update time of agent
  • module_name (str) – Filter by name of module loaded on the agent
  • module_version (str) – Filter by version of module loaded on the agent
  • status_name (AgentStatusName) – Filter by the agent status name
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAgent

list_artifact_access()

(Deprecated) This method lists all access to an artifact. It is deprecated. Use list_access instead.

• Parameters:

  • artifact_id (str) – The id of the artifact to get access for. This is a required field. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

list_artifact_comments()

This method lists all comments a user has access to for an artifact.

• Parameters:

  • artifact_id (str) – The id of the artifact to get comments for. This is a required field. (required)
  • page (int) – Page number
  • size (int) – Page size
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageComment

list_artifacts()

This method lists all artifacts a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • filter_by (FilterBy) – Filter artifacts by created by user or shared with user. (created_by_id, -created_by_id)
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageArtifact

list_auth_integration()

This method lists all AuthIntegrations a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAuthIntegration

list_authors()

This method lists all authors a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageModuleAuthor

list_control_tags()

List all control tags

• Parameters: http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ControlTag]

list_app_integrations()

This method lists app integration info a use has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageAppIntegration

list_files()

This method lists all files that a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • filter_by (FilterBy) – Filter results by models that were created by the user (created_by_id) or shared with the user (-created_by_id).
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageFile

list_function_access()

This method lists all access to a function.

• Parameters:

  • function_id (str) – ID of the function to get access relationships for (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

list_functions()

This method lists all functions a user has access to.

• Parameters:

  • name (str) – Filter functions by name
  • module_version (str) – Filter functions by module version
  • tool (str) – Filter functions by tool name
  • tool_version (str) – Filter functions by tool version
  • operating_system (str) – Filter functions by operating system
  • input_extension (str) – Filter functions by input file extension
  • input_user_models (UserModelInputs) – Filter functions by input user models (single, multiple)
  • status (UsabilityStatusParams) – Filter functions by usability status (supported, deprecated, all)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageFunction

list_job_access()

(Deprecated) This method lists all access to a job. It is deprecated. Use list_access instead.

• Parameters:

  • job_id (str) – The id of the job to list access permissions for. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

list_jobs()

This method lists the jobs that a user has access to.

• Parameters:

  • model_id (str) – Filter jobs by model id
  • status_name (JobStatusName) – Filter jobs by status name
  • page (int) – Page number
  • size (int) – Page size
  • archive_status (ArchiveStatus) – Filter jobs by archive status
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageJob

list_model_access()

(Deprecated) This method lists all access to a model. It is deprecated. Use list_access instead.

• Parameters:

  • model_id (str) – The id of the model to list access permissions for. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

list_model_artifacts()

This method lists all artifacts a user has access to for a model.

• Parameters:

  • model_id (str) – The id of the model to list artifacts for. (required)
  • page (int) – Page number
  • size (int) – Page size
  • filter_by (FilterBy) – Filter model artifacts by created by user or shared with user (created_by_id, -created_by_id)
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageArtifact

list_model_comments()

This method lists all comments a user has access to for a model.

• Parameters:

  • model_id (str) – The model ID to which the comment belongs. (required)
  • page (int) – Page number
  • size (int) – Page size
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageComment

list_model_jobs()

This method lists all jobs a user has access to for a model.

• Parameters:

  • model_id (str) – The id of the model to list jobs for. (required)
  • status_name (JobStatusName) – Filter results by job status name
  • page (int) – Page number
  • size (int) – Page size
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageJob

list_models()

This methods lists all models a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • filter_by (FilterBy) – Filter results by models that were created by the user (created_by_id) or shared with the user (-created_by_id).
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageModelListItem

list_module_versions()

This method list all module versions a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageModuleVersion

list_modules()

This method lists all modules a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageModule

list_operating_systems()

This method lists all operating systems a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageOperatingSystem

list_personal_access_tokens()

This method lists all personal access tokens a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PagePersonalAccessToken

list_resources()

This method lists all resources a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • id (List [**Optional [**str ] ]) – A list of resource IDs to filter on
  • file_name (List [**Optional [**str ] ]) – A list of file names to filter on (single value performs a like comparison)
  • type_name (List [**ResourceType ]) – A list of resource types to filer on
  • description (List [**str ]) – A list of file descriptions to filter on (single value performs a like comparison)
  • version_name (List [**str ]) – A list of file version names to filter on (single value performs a like comparison)
  • external_identifier (List [**str ]) – A list of file external identifiers to filter on (single value performs a like comparison)
  • display_name (List [**str ]) – A list of file display names to filter on (single value performs a like comparison)
  • mime_type (List [**str ]) – A list of file mime types to filter on
  • file_size (List [**int ]) – A list of file sizes to filter on
  • created_timestamp (List [**datetime ]) – A list of file creation timestamps to filter on
  • updated_timestamp (List [**datetime ]) – A list of file update timestamps to filter on
  • created_by_id (List [**str ]) – A list of user IDs that created the file to filter on
  • updated_by_id (List [**str ]) – A list of user IDs that updated the file to filter on
  • archive_status (List [**ArchiveStatusName ]) – A list of archive statuses to filter on
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageResourceSearchItem

list_snapshot_items()

This method lists all the snapshot items a user has access to.

• Parameters:

  • snapshot_id (str) – The id of the snapshot to list items for. (required)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageSnapshotItem

list_snapshot_revisions()

This method gets a snapshot’s revisions.

• Parameters:

  • snapshot_id (str) – The id of the system snapshot to list revisions for. (required)
  • page (int) – Page number
  • size (int) – Page size
  • name (List [**str ]) – A list of file names to filter on (single value performs a like comparison)
  • extension (List [**str ]) – A list of file extensions to filter on (single value performs a like comparison)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageSnapshotRevisionSearchItem

list_snapshots()

This method lists all the snapshots a user has access to

• Parameters:

  • system_id (str) – The id of the system to filter snapshots by
  • configuration_id (str) – The id of the configuration to filter snapshots by
  • tag (str) – The tag to filter snapshots by
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageSnapshot

list_system_configurations()

This method lists all the system configurations a user has access to.

• Parameters:

  • system_id (str) – The id of the system to list configurations for. (required)
  • page (int) – Page number
  • size (int) – Page size
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageSystemConfiguration

list_systems()

This method lists all the systems a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • filter_by (FilterBy) – Filter results by systems that were created by the user (created_by_id) or shared with the user (-created_by_id).
  • archive_status (ArchiveStatus) – Filter results by archive status (active, archived, all)
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageSystem

list_tags()

This method lists all the snapshot tags a user has access to.

• Parameters:

  • system_id (str) – The id of the system to filter tags by
  • configuration_id (str) – The id of the configuration to filter tags by
  • snapshot_id (str) – The id of the snapshot to filter tags by
  • archive_status (ArchiveStatus)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageSnapshotTag

list_tool_versions()

This method lists all tool versions a user has access to.

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageToolVersion

list_tools()

This method list all tools a user has access to

• Parameters:

  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageTool

list_tracked_files()

This methods list all the tracked files for a configuration that the user has access to.

• Parameters:

  • configuration_id (str) – The id of the configuration to list tracked files for. (required)
  • page (int) – Page number
  • size (int) – Page size
  • sort (str)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: PageTrackedFile

list_users()

This method lists all users a user has access to.

• Parameters:

  • user_state (UserStateOption) – Filter users by state (active or all).
  • user_type (UserType) – Filter users by type (human, agent or all).
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[User]

liveness_check()

Liveness probe

• Parameters: http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: HealthcheckReport

patch_artifact_access()

(Deprecated) This method updates access to an artifact. It is deprecated. Use update_access instead.

• Parameters:

  • artifact_id (str) – The id of the artifact to update access for. This is a required field. (required)
  • access_relationship (AccessRelationship) – (required)
  • patch_op (PatchOp) – The operation to perform on the access relationship. This is a required field.
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

patch_artifact_control_taggings()

This method adds or removes control tags on a artifact.

• Parameters:

  • artifact_id (str) – The ID of the artifact to get. This is a required field. (required)
  • request_body (List [**str ]) – (required)
  • patch_op (PatchOp) – The operation to perform. This is a required field.
  • reason (str) – The reason for the change. This is an optional field.
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ResourceControlTagging]

patch_file_control_taggings()

This method adds or removes control tags on a file.

• Parameters:

  • file_id (str) – The ID of the file to get. This is a required field. (required)
  • request_body (List [**Optional [**str ] ]) – (required)
  • patch_op (PatchOp) – The operation to perform. This is a required field.
  • reason (str) – The reason for the change. This is an optional field.
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[FileControlTagging]

patch_function_access()

This method updates access to a function.

• Parameters:

  • function_id (str) – ID of the function to modify access permissions on (required)
  • access_relationship (AccessRelationship) – (required)
  • patch_op (PatchOp) – The operation to perform on the access relationship.
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

patch_job_access()

(Deprecated) This method updates access to a job. It is deprecated. Use update_access instead.

• Parameters:

  • job_id (str) – The id of the job to modify access permissions on (required)
  • access_relationship (AccessRelationship) – (required)
  • patch_op (PatchOp) – The operation to perform on the access relationship.
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

patch_model_access()

(Deprecated) This method updates access to a model. It is deprecated. Use update_access instead.

• Parameters:

  • model_id (str) – The id of the model to update access for. (required)
  • access_relationship (AccessRelationship) – (required)
  • patch_op (PatchOp) – The operation to perform on the access relationship.
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[AccessRelationship]

patch_model_control_taggings()

This method adds or removes control tags on a model.

• Parameters:

  • model_id (str) – The ID of the model to add or remove taggings. This is a required field. (required)
  • request_body (List [**str ]) – (required)
  • patch_op (PatchOp) – The operation to perform. This is a required field.
  • reason (str) – The reason for the change. This is an optional field.
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[ResourceControlTagging]

patch_user_control_taggings()

This method adds or removes control tags on a user.

• Parameters:

  • user_id (str) – The ID of the user to get. This is a required field. (required)
  • request_body (List [**str ]) – (required)
  • patch_op (PatchOp) – The operation to perform. This is a required field.
  • reason (str) – The reason for the change. This is an optional field.
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: List[UserControlTagging]

readiness_check()

Readiness probe

• Parameters: http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: HealthcheckReport

register_agent()

This method registers a new agent.

• Parameters:

  • new_agent (NewAgent) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

remove_access()

This method removes access to a resource or file.

• Parameters:

  • subject_type (AccessSubjectType) – The type of the subject to remove. (required)
  • subject_id (str) – The id of the subject to remove. (required)
  • resource_type (AccessResourceType) – The type of the resource to remove. (required)
  • resource_id (str) – The id of the resource to remove. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: object

remove_job_assigned_agent()

This method removes the assigned agent from a job.

• Parameters:

  • job_id (str) – The id of the job to remove the assigned agent from. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Job

restore_artifact()

This method restores an artifact by updating it’s archive status to Active.

• Parameters:

  • artifact_id (str) – The id of the artifact to restore. This is a required field. (required)
  • restore (Restore)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Artifact

restore_comment()

This method restores a comment by updating it’s archive status to Active.

• Parameters:

  • comment_id (str) – The ID of the comment to restore. (required)
  • restore (Restore)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Comment

restore_configuration()

This method restores a configuration by updating it’s archive status to Active.

• Parameters:

  • configuration_id (str) – The id of the configuration to restore. (required)
  • restore (Restore)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SystemConfiguration

restore_file()

This method restores a file by updating it’s archive status to Active.

• Parameters:

  • file_id (str) – The id of the file to restore. (required)
  • restore (Restore)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: File

restore_file_revision()

This method restores a FileRevision by updating it’s archive status to Active.

• Parameters:

  • revision_id (str) – The id of the file revision to restore. (required)
  • restore (Restore)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FileRevision

restore_job()

This method restores a job by updating it’s archive status to Active.

• Parameters:

  • job_id (str) – The id of the job to restore. (required)
  • restore (Restore)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Job

restore_model()

This method restores a model by updating it’s archive status to Active.

• Parameters:

  • model_id (str) – The id of the model to restore. (required)
  • restore (Restore)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Model

restore_system()

This method restores a system by updating it’s archive status to Active.

• Parameters:

  • system_id (str) – The id of the system to restore. (required)
  • restore (Restore)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: System

restore_tag()

This method restores a snapshot tag by updating it’s archive status to Active.

• Parameters:

  • tag_id (str) – The id of the tag to restore. (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SnapshotTag

revoke_all_personal_access_tokens()

This method revokes all personal access tokens.

• Parameters: http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: object

transfer_revision_to_existing_artifact()

This method transfers a revision to an existing artifact. The original revision that was copied will be archived and no longer active.

• Parameters:

  • revision_id (str) – The id of the revision to transfer (required)
  • artifact_id (str) – The id of the artifact to transfer the revision to (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FileRevision

transfer_revision_to_existing_file()

This method transfers a file revision to an existing file. The original revision that was copied will be archived and no longer active.

• Parameters:

  • revision_id (str) – The id of the revision to transfer (required)
  • file_id (str) – The id of the file to transfer the revision to (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: File

transfer_revision_to_new_artifact()

This method transfers a revision to a new artifact. The original revision that was copied will be archived and no longer active.

• Parameters:

  • revision_id (str) – The id of the revision to transfer (required)
  • model_id (str) – The id of the model to transfer the revision to (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: FileRevision

transfer_revision_to_new_file()

This method transfers a file revision to a new file. The original revision that was copied will be archived and no longer active.

• Parameters:

  • revision_id (str) – The id of the revision to transfer (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: File

update_access()

This method updates access to a resource or file.

• Parameters:

  • subject_type (AccessSubjectType) – The type of the subject to update. (required)
  • subject_id (str) – The id of the subject to update. (required)
  • resource_type (AccessResourceType) – The type of the resource to update. (required)
  • resource_id (str) – The id of the resource to update. (required)
  • update_access_relationship (UpdateAccessRelationship) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AccessRelationship

update_agent_display_name()

This method updates an agent’s display name.

• Parameters:

  • agent_identifier (str) – The ID of the agent to update. (required)
  • new_agent_display_name (NewAgentDisplayName) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

update_agent_information()

This method updates an agent’s information.

• Parameters:

  • agent_identifier (str) – The ID of the agent to update. (required)
  • new_agent_information (NewAgentInformation) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

update_agent_modules()

This method updates an agent’s loaded modules.

• Parameters:

  • agent_identifier (str) – The ID of the agent to update. (required)
  • new_agent_module_version (List [**NewAgentModuleVersion ]) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

update_agent_status()

This method updates an agent’s status.

• Parameters:

  • agent_identifier (str) – The ID of the agent to update. (required)
  • new_agent_status (NewAgentStatus) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Agent

update_auth_integration()

This method updates an AuthIntegration. The auth integration name must be unique per org.

• Parameters:

  • auth_integration_id (str) – The unique name of the AuthIntegration to update (required)
  • auth_integration_update (AuthIntegrationUpdate) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AuthIntegration

update_author()

This method updates an author.

• Parameters:

  • author_id (str) – The author ID to update. (required)
  • new_module_author (NewModuleAuthor) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ModuleAuthor

update_control_tag()

This method updates an existing control tag.

• Parameters:

  • update_control_tag (UpdateControlTag) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: ControlTag

update_app_integration()

This method updates an app integration.

• Parameters:

  • app_integration_id (str) – ID of the app integration to update. This is a required field. (required)
  • new_app_integration (NewAppIntegration) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: AppIntegration

update_job_assigned_agent()

This method updates the assigned agent for a job.

• Parameters:

  • job_id (str) – The id of the job to update the assigned agent for. (required)
  • new_job_assigned_agent (NewJobAssignedAgent) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Job

update_job_status()

This method updates the status of a job.

• Parameters:

  • job_id (str) – The id of the job to update (required)
  • status_name (JobStatusName) – The new status name to update the job with. (required)
  • agent_identifier (str) – An optional identifier for the agent.
  • job_status_message (JobStatusMessage)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Job

update_operating_system()

This method updates an existing operating system.

• Parameters:

  • operating_system_id (str) – The id of the operating system to update. (required)
  • new_operating_system (NewOperatingSystem) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: OperatingSystem

update_system()

This method updates an existing system.

• Parameters:

  • system_id (str) – The id of the system to update. (required)
  • update_system (UpdateSystem) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: System

update_tag()

This method updates an existing snapshot tag by moving it to a different snapshot.

• Parameters:

  • tag_id (str) – The id of the tag to update. (required)
  • update_tag (UpdateTag) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: SnapshotTag

update_tool()

This method updates a tool.

• Parameters:

  • tool_id (str) – The ID of the tool to update. (required)
  • update_tool (UpdateTool) – (required)
  • http_request_timeout_secs (int , optional) – timeout setting for this request

• Return Type: Tool