> For the complete documentation index, see [llms.txt](https://www.cakewalk.security/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.cakewalk.security/docs/human-access/connections-and-integrations/integration-guides/sigma.md).

# Sigma

Connect Sigma to Cakewalk for auto-provisioning with a client ID and secret, including how to create them and find your API base URL.

### :sparkles: Auto Provisioning

| **Authentication method** | Client ID and Client Secret. See details [here](#how-can-i-create-a-rest-api-token). |
| ------------------------- | ------------------------------------------------------------------------------------ |
| **Required permissions**  | `Admin`.                                                                             |
| **Required metadata**     | `API base URL`. See details [here](#where-can-i-find-my-api-base-url).               |

<details>

<summary><strong>How can I create a REST API token?</strong></summary>

1. Navigate to Sigma and click `Administration`.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_a5da75068a954ba0a1632bc32882cd2f_596f782d5beb4d8ebdcbbce6d2530891_text_export.jpeg)

2. Click `Developer access`.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_96d7dd5e579644af8ecbf3d6f9e0d491_a64ee397340b4f829841f0d6e06b3549_text_export.jpeg)

3. Click `Create new`.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_ebe5164a5e274cba99c93eb769d4b06f_0f88fa9a09654ca899039a75c134e66f_text_export.jpeg)

4. Select `REST API` under `Select scopes`.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_bd636cd351db4b7b84922be500f54064_d0f16f05c65f4f46ad5e2876b72a3f8c_text_export.jpeg)

5. Type `Cakewalk` in the `Name` field.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_3bd04d014bde41478c144a5eedbdbf6e_54a65d2b58b142afa139b6f77705c519_text_export.jpeg)

6. Optionally, add a description in the `Description` field.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_c3cd0de2a56448e5a09e13c3f37d0d3f_85d56c4958484b909fe161a6dda8f7b3_text_export.jpeg)

7. Select the `Owner` of the credentials. API calls use the account type permissions of this member, so select a member with the `Admin` account type.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_e144670235d04a55936ba710d4f4411e_55e333942cd54fd7978233ab69f98e7d_text_export.jpeg)

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_3ad81018985340d7a5255ad5cb7ad31b_b3e8748d6f944ccdadaa06ed72b81322_text_export.jpeg)

8. Click `Create`.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_5595ba69e7af4edabbd17d46369a62eb_aacf4fdbb97543ac918243a7467da7d2_text_export.jpeg)

9. Copy the `Client ID` and paste it into the corresponding field in Cakewalk.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_e1bee37273d14bfd8e5ef6779ff00aca_d3d777e8145c49938c4c8c54d07304cf_text_export.jpeg)

10. Copy the `Secret` and paste it into the `Client Secret` field in Cakewalk. Sigma shows the secret only while this dialog is open, so copy it before you close the dialog.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_479b8addd3bc4a85b8e191183b5c8a01/steps/step_unknown_b0238eb35c3d464384112f002391898d_74df3150daf34b3fa7dcc70fc71655b2_text_export.jpeg)

</details>

<details>

<summary><strong>Where can I find my <code>API base URL</code>?</strong></summary>

Your API base URL depends on the cloud and region your Sigma organization runs on.

1. Navigate to Sigma and click `Administration`.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_4ba8dd56c9554ca8a99504ff1613fc79/steps/step_unknown_9debe1aff55d4407a25fd4dfcb0fbabb_0ead43cbf3284f9891ac3e9f5283af5d_text_export.jpeg)

2. Click `Developer access`.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_4ba8dd56c9554ca8a99504ff1613fc79/steps/step_unknown_00cd94de193b477a845298172391e5a9_0a5bf7f207cf4aaeb9bf953bb430096c_text_export.jpeg)

3. Click `Copy to clipboard` next to `API base URL`.

![](https://colony-recorder.s3.amazonaws.com/files/org_c933a115e74744e7b53a1a0f380687fd/team_892b90b9b9244792887e4c4635d862b2/document_4ba8dd56c9554ca8a99504ff1613fc79/steps/step_unknown_8fb4c0de8cf841deb8560f30ea4ed6d2_c6125f19b8794a33b190a97763749263_text_export.jpeg)

4. Enter only the host part of the URL in Cakewalk. The field already supplies `https://` and `.sigmacomputing.com`, so for `https://api.eu.aws.sigmacomputing.com` you enter `api.eu.aws`, and for `https://aws-api.sigmacomputing.com` you enter `aws-api`.

</details>


---

# 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://www.cakewalk.security/docs/human-access/connections-and-integrations/integration-guides/sigma.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.