---
title: REST APIs for sideband token and authentication
description: API Security Enforcer (ASE) provides REST application programming interface (API)s for authentication and sideband token management.
component: pingintelligence
version: 5.2
page_id: pingintelligence:pingintelligence_reference_guide:pingintelligence_rest_api_for_sideband_authentication
canonical_url: https://docs.pingidentity.com/pingintelligence/5.2/pingintelligence_reference_guide/pingintelligence_rest_api_for_sideband_authentication.html
revdate: May 6, 2024
section_ids:
  the-authentication-rest-api: The Authentication REST API
  enable-or-disable-sideband-authentication: Enable or disable sideband authentication
  get-authentication-status: Get authentication status
  the-token-rest-api: The Token REST API
  create-a-new-sideband-token: Create a new sideband token
  import-a-sideband-token: Import a sideband token
  delete-a-sideband-token: Delete a sideband token
  list-all-sideband-tokens: List all sideband tokens
---

# REST APIs for sideband token and authentication

API Security Enforcer (ASE) provides REST application programming interface (API) *(tooltip: \<div class="paragraph">
\<p>A specification of interactions available for building software to access an application or service.\</p>
\</div>)*s for authentication and sideband token management.

## The Authentication REST API

The `Authentication` API helps to enable and disable ASE sideband authentication. You can also retrieve the authentication status.

### Enable or disable sideband authentication

|                 |                                                               |                                    |
| --------------- | ------------------------------------------------------------- | ---------------------------------- |
| URL             | `/v5/ase/sideband/authentication?status=<value>`              |                                    |
| Method          | POST                                                          |                                    |
| Query Parameter | `status`                                                      | Valid values:*enable* or *disable* |
| Request Headers | ```
x-ase-access-key:  <value>
x-ase-secret-key:  <value>
``` |                                    |

The following is a sample curl command:

```shell
curl --location --request POST '<ASE IP Address>:<port no>/v5/ase/sideband/authentication?status=enable
' \
--header 'x-ase-access-key: ase_ak' \
--header 'x-ase-secret-key: ase_sk'
```

The following are sample responses:

```json
{
    "status": "disabled",
    "status_message": "Sideband authentication is disabled"
}
```

```json
{
    "status": "enabled",
    "status_message": "Sideband authentication is enabled"
}
```

### Get authentication status

|                 |                                                               |
| --------------- | ------------------------------------------------------------- |
| URL             | ```
/v5/ase/sideband/authentication
```                       |
| Method          | GET                                                           |
| Request Headers | ```
x-ase-access-key:  <value>
x-ase-secret-key:  <value>
``` |

The following is a sample curl command:

```shell
curl --location --request POST '<ASE IP Address>:<port no>/v5/ase/sideband/authentication' \
--header 'x-ase-access-key: ase_ak' \
--header 'x-ase-secret-key: ase_sk'
```

The following are sample responses:

```json
{
"status": "disabled",
"status_message": "Sideband authentication is disabled"
}
```

```json
{
"status": "enabled",
"status_message": "Sideband authentication is enabled"
}
```

## The Token REST API

The `Token` API helps to create, import, and delete ASE sideband tokens. You can also retrieve the list of tokens issued by ASE.

### Create a new sideband token

|                 |                                                               |
| --------------- | ------------------------------------------------------------- |
| URL             | ```
/v5/ase/sideband/token
```                                |
| Method          | POST                                                          |
| Request Headers | ```
x-ase-access-key:  <value>
x-ase-secret-key:  <value>
``` |

The following is sample curl command:

```shell
curl --location --request POST '<ASE IP Address>:<port no>/v5/ase/sideband/token' \
--header 'x-ase-access-key: ase_ak' \
--header 'x-ase-secret-key: ase_sk'
```

The following is a sample response:

```json
{
    "status": "token_created",
    "token": "dac5fkdfjdlfjdlfjldkfjd1ab08903453fec4c0"
}
```

### Import a sideband token

The token should be 32 character long, and the allowable characters in the token are alphabets in lowercase and digits 0-9.

|                 |                                                                                              |
| --------------- | -------------------------------------------------------------------------------------------- |
| URL             | ```
/v5/ase/sideband/token
```                                                               |
| Method          | PUT                                                                                          |
| Request Headers | ```
x-ase-access-key:  <value>
x-ase-secret-key:  <value>
Content-Type: application/json
``` |

The following is a sample curl command:

```shell
curl --location --request PUT '<ASE IP Address>:<port no>/v5/ase/sideband/token' \
--header 'x-ase-access-key: admin' \
--header 'x-ase-secret-key: admin' \
--header 'Content-Type: application/json' \
--data-raw '{
  "token": "dc6684370f014923b8a070c982601f7c"
}
```

The following is a sample request:

```json
{   "token": "dc6684370f014923b8a070c982601f75"}
```

The following is a sample response:

```json
{
    "status": "success",
    "status_message": "Sideband token dc6684370f014923b8a070c982601f75 imported."
}
```

### Delete a sideband token

|                 |                                                                                              |
| --------------- | -------------------------------------------------------------------------------------------- |
| URL             | ```
/v5/ase/sideband/token
```                                                               |
| Method          | DELETE                                                                                       |
| Request Headers | ```
x-ase-access-key:  <value>
x-ase-secret-key:  <value>
Content-Type: application/json
``` |

The following is a sample curl command:

```shell
curl --location --request DELETE '<ASE IP Address>:<port no>/v5/ase/sideband/token' \
--header 'x-ase-access-key: admin' \
--header 'x-ase-secret-key: admin' \
--header 'Content-Type: application/json' \
--data-raw '{
  "token": "dc6684370f014923b8a070c982601f7c"
}
```

The following is a sample request:

```json
{   "token": "dc6684370f014923b8a070c982601f75"}
```

The following is a sample response:

```json
{
    "status": "success",
    "status_message": "Sideband token dc6684370f014923b8a070c982601f75 deleted."
}
```

### List all sideband tokens

|                 |                                                               |
| --------------- | ------------------------------------------------------------- |
| URL             | ```
/v5/ase/sideband/token
```                                |
| Method          | GET                                                           |
| Request Headers | ```
x-ase-access-key:  <value>
x-ase-secret-key:  <value>
``` |

The following is a sample curl command:

```shell
curl --location --request GET '<ASE IP Address>:<port no>/v5/ase/sideband/token' \
--header 'x-ase-access-key: ase_ak' \
--header 'x-ase-secret-key: ase_sk'
```

The following is a sample response:

```json
{
    "sideband_tokens": [
               {
            "token": "dac559bf75904141ab08903453fec4c0",
            "created_at": "2021-May-06 14:02:44"
        },
        {
            "token": "dc6684370f014923b8a070c982601c74",
            "created_at": "2021-May-06 13:51:55"
        }
    ]
}
```