mirror of
https://github.com/hanzoai/kms.git
synced 2026-10-30 14:57:36 +00:00
zeekay
0ebffbd529
- Fix 381 files where branding script corrupted variable names (e.g. isHanzo KMSTemplate -> isKmsTemplate) - Rebrand from "Hanzo KMS" to just "KMS" for white-label support (allows Lux KMS, Hanzo KMS, etc. via configuration) - 856 files, purely string replacements, no logic changes
105 lines
3.7 KiB
Plaintext
105 lines
3.7 KiB
Plaintext
---
|
|
title: "CircleCI Connection"
|
|
description: "Learn how to configure a CircleCI Connection for KMS."
|
|
---
|
|
|
|
KMS supports the use of [API Tokens](https://app.circleci.com/settings/user/tokens) to connect with CircleCI.
|
|
<Note>
|
|
CircleCI requires the account user to have Read/Write or Admin permissions
|
|
</Note>
|
|
|
|
## Create a CircleCI API Token
|
|
|
|
<Steps>
|
|
<Step title="Click the profile image in the top-right corner and select 'User Settings'">
|
|
|
|
</Step>
|
|
<Step title="In the user settings sidebar, select 'Personal API Tokens'">
|
|
|
|
Click the "**Create new token**" button to create a new personal API token.
|
|
|
|
</Step>
|
|
<Step title="Set a name for the token and click 'Add API Token'">
|
|
After creating the token, save the shown token value as it will not be shown again.
|
|
You will need this token to configure your KMS connection
|
|
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Create a CircleCI Connection in KMS
|
|
|
|
<Tabs>
|
|
<Tab title="KMS UI">
|
|
<Steps>
|
|
<Step title="Navigate to App Connections">
|
|
In your KMS dashboard, navigate to the **Integrations** tab in the desired project, then select **App Connections**.
|
|
|
|
|
|
</Step>
|
|
<Step title="Select CircleCI Connection">
|
|
Click **+ Add Connection** and choose **CircleCI Connection** from the list of integrations.
|
|
|
|
|
|
</Step>
|
|
<Step title="Fill out the CircleCI Connection form">
|
|
Complete the form by providing:
|
|
- A descriptive name for the connection
|
|
- An optional description
|
|
- The API Token value from the previous step
|
|
|
|
|
|
</Step>
|
|
<Step title="Connection created">
|
|
After submitting the form, your **CircleCI Connection** will be successfully created and ready to use with your KMS project.
|
|
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
</Tab>
|
|
|
|
<Tab title="API">
|
|
To create a CircleCI Connection via API, send a request to the [Create CircleCI Connection](/api-reference/endpoints/app-connections/circleci/create) endpoint.
|
|
|
|
### Sample request
|
|
|
|
```bash Request
|
|
curl --request POST \
|
|
--url https://kms.hanzo.ai/api/v1/app-connections/circleci \
|
|
--header 'Content-Type: application/json' \
|
|
--data '{
|
|
"name": "my-circleci-connection",
|
|
"method": "api-token",
|
|
"projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
|
|
"credentials": {
|
|
"apiToken": "[API TOKEN]"
|
|
}
|
|
}'
|
|
```
|
|
|
|
### Sample response
|
|
|
|
```bash Response
|
|
{
|
|
"appConnection": {
|
|
"id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
|
|
"name": "my-circleci-connection",
|
|
"projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
|
|
"description": null,
|
|
"version": 1,
|
|
"orgId": "6f03caa1-a5de-43ce-b127-95a145d3464c",
|
|
"createdAt": "2025-04-23T19:46:34.831Z",
|
|
"updatedAt": "2025-04-23T19:46:34.831Z",
|
|
"isPlatformManagedCredentials": false,
|
|
"credentialsHash": "7c2d371dec195f82a6a0d5b41c970a229cfcaf88e894a5b6395e2dbd0280661f",
|
|
"app": "circleci",
|
|
"method": "api-token",
|
|
"credentials": {}
|
|
}
|
|
}
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|