GraphQL Types Reference

This page provides a detailed reference for the enums and object types used in the Klarity ImageFactory GraphQL schema. Understanding these types is essential for constructing valid queries and mutations.

Enums

Provider

The cloud service provider where images are built and distributed.

• AWS: Amazon Web Services
• AZURE: Microsoft Azure
• EXOSCALE: Exoscale
• GCP: Google Cloud Platform
• IBMCLOUD: IBM Cloud
• VMWARE: VMware vSphere / Cloud Foundation

Scope

The geographic or regulatory scope of the cloud provider.

• PUBLIC: Standard public cloud regions.
• CHINA: Regions located within mainland China (requires specific account configurations).

OSType

The high-level operating system family.

• LINUX
• WINDOWS

OSSubtype

The specific distribution or version of the operating system.

• UBUNTU
• CENTOS
• AMAZON: Amazon Linux
• REDHAT: Red Hat Enterprise Linux
• SUSE: SUSE Linux Enterprise Server
• ORACLE_LINUX
• ROCKY: Rocky Linux

OSFamily

Used for grouping similar operating systems.

• WINDOWS, UBUNTU, CENTOS, AMAZON, REDHAT, SUSE, ORACLE_LINUX, ROCKY

BuildStatus

The current state of a template's build process.

• TEMPLATE_CREATED: Template metadata exists.
• TEMPLATE_PENDING: Build is scheduled.
• TEMPLATE_ERROR: Initial validation or setup failed.
• IMAGE_BUILDING: The image build process is currently running.
• IMAGE_TESTING: Post-build tests are executing.
• IMAGE_CREATED: Build and tests completed successfully.
• IMAGE_ERROR: Build or testing failed.
• IMAGE_QUEUED: Waiting for available build resources.

ImageStatus

The lifecycle state of an individual image.

• PENDING, CREATED, DELETED, ERROR, SHARE_ERROR, DELETE_ERROR

AccountStatus

The health status of a cloud account connection.

• ACCESS_SUCCESS: Credentials are valid and permissions are sufficient.
• ACCESS_MISSING: Credentials are missing or expired.
• ACCESS_ERROR: An error occurred while validating access.

ComponentType

• SYSTEM: Global components provided by Nordcloud.
• CUSTOM: Components created by a specific customer.

ComponentStage

When the component script is executed.

• BUILD: During the image creation phase.
• TEST: During the image validation phase.

ScriptProvisioner

The tool used to execute the component content.

• POWERSHELL: For Windows targets.
• SHELL: For Linux targets.
• ANSIBLE: For complex configurations.

NotificationType

• SNS, PUB_SUB, WEB_HOOK

RebuildReasonType

Why a rebuild was triggered.

• SECURITY_CHECK, SOURCE_IMAGE_CHANGE, HARDENING_SCRIPT_CHANGE, WEEKLY_UPDATES, MANUAL

Action

Permissions for RBAC.

• VIEW, CREATE, UPDATE, DELETE, ANY

Resource

Target of an action for RBAC.

• ACCOUNT, API_KEY, AUDIT_LOG, COMPONENT, NOTIFICATION_GROUP, ROLE, ROLE_BINDING, TEMPLATE, VARIABLE, ANY

Kind

The type of subject in a role binding.

• USER: An Auth0 user.
• API_KEY: An ImageFactory API key.

SearchAlgorithm

• EXACT_MATCH, SUBSTRING_MATCH, REGEXP_MATCH, FUZZY_MATCH

SortOrder

• ASC, DESC

EBSVolumeType

• gp2, gp3

---

Object Types

Customer

Field	Type	Description
id	String!	Unique identifier for the customer.
name	String!	Display name of the customer.
organizationName	String	Legal name of the organization.
contract	String	Contract reference or ID.
createdAt	DateTime!	When the customer was created.

Account

Field	Type	Description
id	String!	Unique identifier for the account.
name	String!	Display name of the account.
provider	Provider!	Cloud provider (AWS, Azure, etc.).
status	AccountStatus!	Current health of the account connection.
lastCheckAt	DateTime	Last time the account was validated.

Template

Field	Type	Description
id	String!	Unique identifier for the template.
name	String!	Name of the template.
osType	OSType!	OS family (Linux/Windows).
buildStatus	BuildStatus!	Current status of the template build.
images	ImageResults	List of images generated from this template.
distributions	[Distribution]	Regions where images are distributed.

Image

Field	Type	Description
id	String!	Unique identifier for the image.
status	ImageStatus!	Current lifecycle state.
providerImageId	String	The ID of the image in the cloud provider (e.g., AMI ID).
reportUrl	String	URL to the security scan report (if requested).
createdAt	DateTime!	When the image build started.

Component

Field	Type	Description
id	String!	Unique identifier for the component.
name	String!	Name of the component.
type	ComponentType!	System or Custom.
content	[VersionedContent]	List of versions for this component.