> 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/getting-started/authentication.md).

# Authentication

The Interlynk API authenticates every request with a security token sent in the `Authorization` header.

## Token types

There are two kinds of token. Pick the one that matches how you will use the API.

|                           | Personal token                       | Service token                          |
| ------------------------- | ------------------------------------ | -------------------------------------- |
| Belongs to                | A user                               | The organization                       |
| Role                      | Inherits the user's role             | An explicit role you choose            |
| Survives the user leaving | No                                   | Yes                                    |
| Prefix                    | `lynk_live_...`                      | `lynk_service_live_...`                |
| Best for                  | Manual use, scripts you run yourself | CI/CD, automation, shared integrations |

{% hint style="success" %}
**For CI/CD integrations, use a service token.** A personal token stops working when the person who created it loses access or leaves the organization, which breaks the pipeline. A service token belongs to the organization and has its own role, so it keeps running independently of any one user.
{% endhint %}

## Create a personal token

1. Log in to the [Interlynk dashboard](https://app.interlynk.io).
2. Click **Settings** in the left-hand bar.
3. Click **Personal** in the top right.
4. Click **Security Tokens**.
5. Click **+** to generate a new token.

Give the token a name and an expiration date. Pick the shortest expiration that fits your use case.

A personal token looks like this:

```
lynk_live_CgzGW2qLk5C73o7SgsKyBT3wVcm**********
```

## Create a service token

Create a service token from your organization settings in the dashboard. A service token has two properties:

* A **name**, so you can identify it later.
* A **role**, which sets exactly what the token is allowed to do.

A service token looks like this:

```
lynk_service_live_CgzGW2qLk5C73o7SgsKyBT3wVcm**********
```

Give a CI/CD service token the least-privileged role that still lets the pipeline do its job. For a pipeline that only uploads SBOMs, a role without delete or admin rights is enough.

{% hint style="warning" %}
Copy the token as soon as it is generated. You cannot retrieve it again after you close the window. Store it as a secret in your CI/CD platform, never in the repository.
{% endhint %}

## Token permissions

A personal token inherits the role of the user who created it. A token created by an admin has admin privileges. A service token uses the role you assign when you create it.

Either way, give the token the least privilege the integration needs.

## Use the token

Both token types are used the same way. Send the token as a bearer token on every request:

```
Authorization: Bearer lynk_live_xxxxxxxxxxxxxxxxxxxx
```

Store it in an environment variable so it stays out of your shell history and your scripts:

```bash
export INTERLYNK_SECURITY_TOKEN="lynk_live_xxxxxxxxxxxxxxxxxxxx"
```

## Verify it works

This request returns your organization's name. If the token is valid, you get a name back.

```bash
curl https://api.interlynk.io/lynkapi \
  -H "Authorization: Bearer $INTERLYNK_SECURITY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "query { organization { id name } }"}'
```

Response:

```json
{
  "data": {
    "organization": {
      "id": "72219448-e3cf-47f4-8e54-49199fc47f52",
      "name": "Acme Corp"
    }
  }
}
```

If the token is missing or wrong, the API returns HTTP `401`:

```json
{
  "errors": [
    { "message": "Unauthorized", "extensions": { "code": "UNAUTHORIZED" } }
  ]
}
```

See [Errors](/api/reference/errors.md) for the full list of failure modes.


---

# 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/getting-started/authentication.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.