---
title: "Authentication tokens"
canonical: "https://docs.devo.com/space/latest/94763821/Authentication%20tokens"
format: markdown
---
> Macro (toc)

## Overview

In the **Administration → Credentials → Tokens** area, you can manage the existing tokens in your domain or generate new ones. You can create tokens to authorize requests to our [Devo APIs](https://devodocs.atlassian.net/wiki/spaces/latest/pages/95128251) or to send data using an [HTTP endpoint](https://devodocs.atlassian.net/wiki/spaces/latest/pages/94658823).

> ℹ️ **OData tokens**
> ℹ️ 
> ℹ️ Apart from the tokens generated in this area, this area also displays the OData tokens generated in the search window. Learn more about OData feeds [in this article](https://devodocs.atlassian.net/wiki/spaces/latest/pages/95205258).

![10_Authentication tokens.png](media://26ff4a51-86fd-4e9d-b65d-f39b3d3973bb)

## What permissions do I need?

All domain users can access this area. Management capabilities depend on having the 'Manage' level of the *[API Credentials](https://devodocs.atlassian.net/wiki/spaces/latest/pages/94763681/Role+permissions#Security)* permission, which allows users to create, modify, and delete tokens.

According to the Role-Based Access Control (RBAC) model, only token owners (the user who created the token) and authorised users (the recipient of the token) can view the token value. Other users will see the token value in a hashed format: `tk.<token_hash>.<last_5_characters_of_the_token>`.

![5_Authentication tokens.png](media://f9482a4e-f1a5-4340-b7bc-6d6a1db6f22e)

**Use cases:**

- ***Manage API Credentials***** + Owner or authorized user**: Users with these conditions will be able to view and manage their tokens in the domain.

![80_Authentication tokens.png](media://81eb8924-3598-446f-8cdb-74f2d58645d8)

- ***Manage***** *****API Credentials***** + Not owner or authorized user**: Users with these conditions will be able to view and manage the list of domain tokens. However, the value of tokens they do not own or are not authorised to access will appear hashed as `tk.<token_hash>.<last_5_characters_of_the_token>`

![110_Authentication tokens.png](media://f95bfd76-5ef9-4931-8fb7-c360b342673c)

- **Authorized user**: Users with these conditions will be able to  view their authorized token list in the domain.

![100_Authentication tokens.png](media://cd7b1990-2565-4905-9553-1b048f8c5d73)

## Create a new token

Click the **Create token **button at the top right of this area to generate a new token. Fill the fields in the window that appears:

![30_ Authentication token.png](media://5c931380-0f33-4c91-a031-03cac6c8f4e8)


> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Enter a **Name **for the new token and assign it to yourself or to another user in your domain in the **Authorized user** field. Only that user will be able to use the token.
> 
> > ⚠️ Note that the selected user must have permission to access the data tables specified in the field below.
> 
> > Macro (rw-step)
> 
> Use the **Target table/s **field to limit the tables in which the token will be used. Choose the required option(s) from the dropdown menu or enter the required tables manually and press [ENTER] to add them.
> 
> If you enter the target tables manually, you can use wildcards as needed to reference a family of tables. The following table describes how to use wildcard symbols to specify the required target tables:
> 
> | **Wildcard** | **Description** | **Example** | **Matches** |
> | --- | --- | --- | --- |
> | **?** | Matches a single character where the wildcard is placed. | siem.logtrust.web.inf**?** | siem.logtrust.web.**info** |
> | firewall.fortinet.even**?**.user | firewall.fortinet.**event**.user |
> | * | Matches zero or more characters in only one tag element. | siem.logtrust.alert.***** | siem.logtrust.alert.**info**<br>siem.logtrust.alert.**error** |
> | web.a*****.error | web.**apache**.error |
> | ** | Matches zero or more characters in one or more tag elements. | web.aws.****** | web.aws.**elb.access** |
> | firewal.fortinet.****** | firewal.fortinet.**event**.**user**<br>firewal.fortinet.**event**.**vpn**<br>firewall.fortinet.**traffic**.**forward**<br>firewall.fortinet.**traffic**.**local** |
> 
> > Macro (rw-step)
> 
> Select one of the allowed actions for the new token in the **Type **area:
> 
> - **HTTP ingestion: **Create a token to send data using HTTP. See the [HTTP endpoint](https://devodocs.atlassian.net/wiki/spaces/latest/pages/94658823) article for more information.
> - **Query API (Query data and manage my jobs): **With this kind of token, you can use the Query API to start, stop and remove your own jobs or any matching the target tables. Learn more about using the Query API [here](https://devodocs.atlassian.net/wiki/spaces/latest/pages/95128275).
> - **Query API (Query data and manage all domain jobs)**: This is the same as the option above but allows you to start, stop, or remove any job within your domain. Learn more about using the Query API [here](https://devodocs.atlassian.net/wiki/spaces/latest/pages/95128275).
> - **Alert API (Create and manage alerts using the API): **With this token, you can use the Alerts API to define new alerts and manage them. Learn more about using the Alerts API [here](https://devodocs.atlassian.net/wiki/spaces/latest/pages/95128644).
> - **Aggregation Tasks API**: Use this token to authorize your requests through the [Aggregation Tasks API](https://devodocs.atlassian.net/wiki/spaces/latest/pages/233242644).
> - **Credentials API:** Use this token to use the Credentials API. This token type doesn’t require permissions on tables, once it is selected the **Target table/s** checkbox is automatically disabled.
> 
> > Macro (rw-step)
> 
> Optionally, check the **Enabled box** in the **Expiration date **field if you want to enter an expiration date for the new token. Choose the required date in the calendar.
> 
> > ⚠️ If an HTTP ingestion token expires, data sent with the token will be permanently lost.
> > ⚠️ 
> > ⚠️ Devo deletes expired tokens after 30 days from expiration date.
> 
> > Macro (rw-step)
> 
> Click **Create** to generate the token.

![40_ Authentication tokens.png](media://80c9063d-b286-4f4d-b581-a252c5039399)

The token will now appear in the table. Under the **Token **column, you can view its value. Click the expanded icon to see ir more clearly.

To copy the generated token or the owner name to your clipboard, click the dropdown menu in the table and select the copy option from the expanded row.

![70_Authentication tokens.png](media://02173ad2-8b6d-433e-a69a-8b808d09dec9)

## Manage tokens

All the tokens generated in the domain will appear in the table of this area. Users with *API Credentials* permission can manage the token details by clicking the ellipsis button that appears at the end of a token in the table to access the following actions:

![40_Authentication tokens.png](media://ce504696-dfd8-4e04-858c-a2405b1bcaaf)

| **Edit** | Click to see the details of the token. Alternatively, you can click its name in the table.<br>In the **Token info **window that appears, you can change the name of the token, copy the token and its associated scope to your clipboard, and add tags to it.<br>![30_Authentication tokens.png](media://9494f9b7-264b-4340-b0b1-df6496a06790) |
| --- | --- |
| **Disable / Enable** | Click the ellipsis button and select the “disable/enable” option. The color in the **Status **column of the table shows if the token is enabled (*green*) or disabled (*red*).<br>![50_Authentication tokens.png](media://1baf2a73-44e8-4500-826c-76b23733dc95) |
| **Delete** | Click the ellipsis button and select the "delete" option. You can choose tokens individually or use the bulk checkbox to select multiple at once.<br>![60_Authentication tokens.png](media://f32e0b33-022d-4763-9901-646b5d9e861f) |

## Filter tokens

You can use the options at the top of the table to filter the list of tokens as required according to different parameters:

- Filter tokens by status. The available options are **Disabled **and **Enabled**.
- Filter tokens by specific characteristics. Open the dropdown menu next to the search box to select the required parameter (**Status**, **Name**, **Type**, **Authorized User**, **Scope**, **Token**, **Creation date **and **Expiration date**) and enter the value to filter by in the search box.
- Search tokens by name. Open the dropdown menu next to the search box and type the token name in the Name field.
- Search by token last 5 digits. Open the dropdown menu next to the search box and type the last 5 digits of the token in the Token field.

## Important considerations

- Tokens assigned to a <u>deleted user</u> will be reassigned to the domain owner and remain enabled. We recommend disabling them if these credentials are known or accessible by an undesired person.
- Tokens assigned to a <u>disabled user</u> will remain enabled and still assigned to that user.
- Tokens can be created by Devo features.  These tokens may be “Unnamed.”