> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/global-settings/security/api-tokens/creating-an-api-token.md).

# Creating an API Token

{% hint style="success" %}

#### Required User Credentials

\[**Flosum User**] - **SystemAdministrator** Role
{% endhint %}

## ![](/files/LowV1q5srWJvPnm0X9bc) Overview

This article shows you how to create an API Token used to grant access to Flosum's APIs. This token can be used to access the following APIs.

* Flosum's SCIM API for Identity Provider user management.
* Flosum's DevOps Command Line Interface.

## Create an API Token

{% stepper %}
{% step %}

### Access Global Settings

1. From any **Flosum Cloud App**, click the **App Switcher** icon at the top of the left sidebar menu.

   <div align="left"><figure><img src="/files/7h3r8n9UNiGYD9uCV8er" alt="" width="563"><figcaption></figcaption></figure></div>
2. Click **Global Settings**.&#x20;

   <div align="left"><figure><img src="/files/EQK79XaUvnweaMkMlwqB" alt="" width="563"><figcaption></figcaption></figure></div>
3. The **Global Settings** app will open in a new tab.

{% hint style="info" %}
Global Settings can also be accessed by logging in directly via the Flosum Cloud Apps Login URL. See the following article for login instructions.

* [Log In To Global Settings](/global-settings/getting-started/log-in-to-global-settings.md)
  {% endhint %}
  {% endstep %}

{% step %}

### Create API Token

1. Click **API Tokens** from the left sidebar menu.
2. Click **Create**.

   <div align="left"><figure><img src="/files/lmEbCBQEcIEEvShDIKuz" alt="" width="563"><figcaption></figcaption></figure></div>
3. Enter a descriptive **Name** for the token.
4. Click the **Expiration** dropdown menu.

   <div align="left"><figure><img src="/files/ICBEyR2rTUll4lPBrmvt" alt="" width="375"><figcaption></figcaption></figure></div>
5. Select the number of days you want the API Token to be valid for.

   <div align="left"><figure><img src="/files/ZPvSqviMTQf8tFvsld1l" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="warning" %}

#### Token Expiration

Once an API Token expires, any services using the token will be unable to access Flosum's API. For services that require continuous access, such as an SSO Identity Provider, select **No expiration**.
{% endhint %}

6. Click **Create**.

   <div align="left"><figure><img src="/files/dak9CAEeTEOtKmEuztkB" alt="" width="375"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Save API Token

{% hint style="warning" %}

#### API Token

The API token is only displayed once. If you lose your token, you'll need to update it to generate a new one. Updating a token invalidates the previous one and requires you to update any services that use it.
{% endhint %}

1. Once created, the API Token will be displayed.
2. Click the **Copy** icon to copy the token and then save it securely. You won't be able to view it again.

   <div align="left"><figure><img src="/files/hT8tUj5UuGbOhHqx2Ygk" alt="" width="375"><figcaption></figcaption></figure></div>
3. Click **Close**.
4. The token you created is now listed in the API Tokens table.

   <div align="left"><figure><img src="/files/7ZvngRy9cndwgE5kTIB5" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}
{% endstepper %}


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.flosum.com/global-settings/security/api-tokens/creating-an-api-token.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
