> For the complete documentation index, see [llms.txt](https://inflight.dope.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://inflight.dope.security/dope.console/settings/api-client-credentials.md).

# API Client Credentials

The dope.swg offers Public APIs to allow our customers automate specific tasks.

For more information on the Public APIs we have available and how to use them please see [Broken mention](broken://pages/Fv4IZGn86IncLNyfYRFg)

## Generating Client Credentials

In order to be able to access the dope.SWG APIs a client credential token will need to be generated. When using the APIs this token is exchanged to get an access token. This access token can then be used to access the dope.SWG APIs.

To generate a token select the <img src="https://4250118259-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqdf21diS0j19gSMF9LeP%2Fuploads%2FWU5vFNFWgPXlgeiDXUGo%2Fapi-button-generate.png?alt=media&amp;token=25d0aa42-4bef-4b97-a3cb-0e9a22ab26cb" alt="" data-size="line"> button on the right hand panel.

<figure><img src="https://4250118259-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqdf21diS0j19gSMF9LeP%2Fuploads%2FPJELO5PZ7QL9jb2cfaC8%2Fapi-generate-screen.png?alt=media&amp;token=321dfdc1-e5af-47a1-a679-95e0c937e146" alt=""><figcaption><p>Generate Client Credentials</p></figcaption></figure>

You will then be prompted to provide a name for the token in the right hand panel.

<figure><img src="https://4250118259-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqdf21diS0j19gSMF9LeP%2Fuploads%2FIX6CJ4X9uJ0bkNI9ME1f%2Fapi-token.png?alt=media&amp;token=ffba40c9-7b2b-488e-9c3a-f11683998b19" alt="" width="509"><figcaption><p>Provide Token Name</p></figcaption></figure>

Once you have provided a name for the Token it will get added to the table. Here you will see the following information, Token Name, Client ID, Created By and Created On.

You will also see the Token Secret. This must be copied immediately as for security reasons it will not be shown again.

<figure><img src="https://4250118259-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqdf21diS0j19gSMF9LeP%2Fuploads%2FoWeULYGrPUDO4Tkhabu3%2Fapi-token_secret.png?alt=media&amp;token=539424e0-4785-4f5f-a925-692e80c9bf75" alt=""><figcaption><p>New Token Added to Table</p></figcaption></figure>

{% hint style="info" %}
You can select the Copy icon or the string of text to copy the secret.
{% endhint %}

If required, it is possible to create multiple tokens following the same process.

## Revoking Client Credentials

### Revoke a single credential

To revoke a single credential select the ellipsis at the right hand side of the credentials table, and then select Revoke.

<figure><img src="https://4250118259-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqdf21diS0j19gSMF9LeP%2Fuploads%2Fcn75nK9Q4UY71H0cilAA%2Fapi-token_revoke.png?alt=media&amp;token=c2c1499c-ae42-4ce0-b3e2-6311ead52036" alt=""><figcaption><p>Revoke a single credential</p></figcaption></figure>

After selecting Revoke you will need to confirm the action when presented with the following dialog.

<figure><img src="https://4250118259-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqdf21diS0j19gSMF9LeP%2Fuploads%2FyzXpCF9HdQpgODD6z9V1%2Fapi-revoke_this.png?alt=media&amp;token=8de7c613-45b8-4904-8820-a223be73e38d" alt="" width="509"><figcaption><p>Revoke Single Confirmation Dialog</p></figcaption></figure>

### Revoke all credentials

To revoke all of the created credentials then select the <img src="https://4250118259-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqdf21diS0j19gSMF9LeP%2Fuploads%2FVSS3CsChZApIktLFKGPj%2Fapi-button-revoke.png?alt=media&amp;token=3fd85fd3-6525-4908-850d-406e6a427a40" alt="" data-size="line"> button on the right hand panel.

Then, confirm you want to revoke all credentials when presented with the following dialog.

<figure><img src="https://4250118259-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqdf21diS0j19gSMF9LeP%2Fuploads%2FjEPzXaqFw1L9pfmzDN47%2Fapi-revoke_all.png?alt=media&amp;token=3703278e-fea5-43c9-8c36-930a6059df61" alt="" width="509"><figcaption><p>Revoke All Confirmation Dialog</p></figcaption></figure>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://inflight.dope.security/dope.console/settings/api-client-credentials.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
