> For the complete documentation index, see [llms.txt](https://docs.interlynk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.interlynk.io/api/reference/operations.md).

# Operations

A reference list of the queries and mutations these docs cover. The API schema is larger than this. These are the operations relevant to uploading, downloading, and managing SBOMs.

The production endpoint does not support introspection, so use this page as the operation reference.

## Queries

| Query                                | Returns                                                                      | Guide                                                               |
| ------------------------------------ | ---------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `organization`                       | Your organization, its products, environments, and versions.                 | [List Products and Versions](/api/inventory/list-resources.md)      |
| `sbom(projectId, sbomId)`            | A single version: metadata, authors, suppliers, components, download, vulns. | [Download](/api/managing-sboms/download-sbom.md)                    |
| `vexStatuses`                        | Valid VEX status IDs and names.                                              | [Vulnerabilities and VEX](/api/security/vulnerabilities-and-vex.md) |
| `vexJustifications`                  | Valid VEX justification IDs and names.                                       | [Vulnerabilities and VEX](/api/security/vulnerabilities-and-vex.md) |
| `cdxResponses`                       | Valid VEX response IDs and names.                                            | [Vulnerabilities and VEX](/api/security/vulnerabilities-and-vex.md) |
| `organization { organizationRoles }` | Roles in the organization and their permissions.                             | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `organization { users }`             | Members, their roles, and invitation status.                                 | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `organization { samlConfig }`        | The organization's SSO (SAML) configuration.                                 | [Manage Users and Roles](/api/user-management/user-management.md)   |

### Key fields on `sbom`

The `sbom` query resolves a version. Useful fields on it:

| Field                                      | Description                                                                                      |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `id`                                       | The version ID (`sbomId`).                                                                       |
| `projectVersion`                           | The version string, for example `3.0.2`.                                                         |
| `vulnRunStatus`                            | Vulnerability scan status. `FINISHED` when done.                                                 |
| `primaryComponent { name version }`        | The component the SBOM describes.                                                                |
| `sbomParts { id part { ... } }`            | The versions attached as direct parts. See [Group Products with Parts](/api/inventory/parts.md). |
| `deepParts { ... }`                        | The full nested tree of parts.                                                                   |
| `authors { id name email phone }`          | SBOM authors.                                                                                    |
| `suppliers { ... }`                        | SBOM suppliers.                                                                                  |
| `components(sbomId, first, after, search)` | Paginated components in the SBOM.                                                                |
| `vulns(sbomId, first, after)`              | Paginated vulnerabilities.                                                                       |
| `download(sbomId, ...)`                    | The SBOM file. See [Download](/api/managing-sboms/download-sbom.md).                             |

The `sbom` query also accepts `projectName`, `projectGroupName`, and `versionName` as an alternative to `projectId` and `sbomId`.

## Mutations

| Mutation                    | Purpose                                           | Guide                                                               |
| --------------------------- | ------------------------------------------------- | ------------------------------------------------------------------- |
| `sbomUpload`                | Upload an SBOM file as a new version.             | [Upload an SBOM](/api/managing-sboms/upload-sbom.md)                |
| `authorCreate`              | Add an author to a version.                       | [Edit SBOM Metadata](/api/managing-sboms/edit-sbom-metadata.md)     |
| `authorUpdate`              | Change an existing author.                        | [Edit SBOM Metadata](/api/managing-sboms/edit-sbom-metadata.md)     |
| `authorDelete`              | Remove an author.                                 | [Edit SBOM Metadata](/api/managing-sboms/edit-sbom-metadata.md)     |
| `sbomSupplierCreate`        | Add a supplier to a version.                      | [Edit SBOM Metadata](/api/managing-sboms/edit-sbom-metadata.md)     |
| `sbomSupplierUpdate`        | Change an existing supplier.                      | [Edit SBOM Metadata](/api/managing-sboms/edit-sbom-metadata.md)     |
| `sbomSupplierDelete`        | Remove a supplier.                                | [Edit SBOM Metadata](/api/managing-sboms/edit-sbom-metadata.md)     |
| `sbomPartCreate`            | Attach a version to another version as a part.    | [Group Products with Parts](/api/inventory/parts.md)                |
| `sbomPartDelete`            | Remove a part from a version.                     | [Group Products with Parts](/api/inventory/parts.md)                |
| `componentUpdate`           | Change a component's fields.                      | [Edit a Component](/api/inventory/edit-component.md)                |
| `compSupplierCreate`        | Add a supplier to a component.                    | [Edit a Component](/api/inventory/edit-component.md)                |
| `componentVexUpdate`        | Set VEX on one component vulnerability.           | [Vulnerabilities and VEX](/api/security/vulnerabilities-and-vex.md) |
| `componentVexBulkUpdate`    | Set VEX on many vulnerabilities at once.          | [Vulnerabilities and VEX](/api/security/vulnerabilities-and-vex.md) |
| `organizationUserInvite`    | Invite a user and assign a role.                  | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `organizationUserUpdate`    | Change the role a user holds.                     | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `organizationUserRemove`    | Remove a user from the organization.              | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `organizationRoleCreate`    | Create a custom role (Enterprise).                | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `organizationRoleUpdate`    | Change a role's permissions (Enterprise).         | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `organizationRoleBulkApply` | Assign a role to many users at once (Enterprise). | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `organizationRoleDelete`    | Delete a custom role (Enterprise).                | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `samlConfigCreate`          | Set up SSO from IdP metadata (Enterprise).        | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `samlConfigUpdate`          | Change or disable SSO (Enterprise).               | [Manage Users and Roles](/api/user-management/user-management.md)   |
| `samlConfigDelete`          | Remove the SSO configuration (Enterprise).        | [Manage Users and Roles](/api/user-management/user-management.md)   |

## Mutation response pattern

Every mutation returns an `errors` list. An empty list means success. Most also return the object they changed. Always request `errors` and check it. See [Errors](/api/reference/errors.md).

```graphql
mutation {
  authorCreate(input: { sbomId: "...", name: "..." }) {
    author { id name }
    errors
  }
}
```

## Looking for the rest of the schema?

These docs cover SBOM lifecycle operations. The platform exposes more, for example policies, automation rules, and integrations. If you need an operation that is not listed here, contact <hello@interlynk.io>.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.interlynk.io/api/reference/operations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.