Skip to main content

User settings

Manage Git Tokens​

To access the User Settings use the Settings capability on the top right of the page and navigate to the User Settings page.

Create a Git Token​

Each user can have only one token for each Git provider for which he has rights. To create a new token use the header capability Create in the Git tokens tab on the User Settings page.

A Git token is defined using the following master data:

  • Token name: Name of the token. (required, unique for each user)
  • Git provider: List of all Git providers for which the current user has access permission. The Git providers are represented with their assigned alias that was provided by the admin user (required)
  • Git access token: The actual Git token (required)
  • Git username: The username as defined in the Git provider (required)
💡tip

By using the default Verify and Create the provided Git username and Git access token will be validated before the creation. In case of incorrect data you will get an error notification. If you want to use that data anyway please choose the Create button.

Verify a Git Token​

To verify a Git token use the inline or header Verify capability. You will get either a "Success" or an "Error" notification displayed.

Delete a Git Token​

To delete a Git token use the inline or header Delete capability. After you confirm the action the Git token will be permanently deleted.

Update a Git Token​

In order to update a Git token use the inline or header Edit capability. This action only allows a change of the access token itself. If your username has changed delete the previous Git token and create a new Git token for the same Git provider. After saving the changes, all Pipeline Configurations using your personal credentials will also be updated.

Manage AI API keys​

Generative AI capabilities can be configured centrally by your administrator via the k5-ai-credentials secret — see AI providers. When central credentials are configured, ADR Sidekick and Diagram Assistant are available without a personal API key.

Alternatively, users can provide their own OpenAI API key in User Settings for the ADR Sidekick and Diagram Assistant. If you have access, you can create an API key directly from your platform (OpenAI platform, Microsoft Azure or Amazon Bedrock) or by contacting your system administrator.

❗️info

The Design Assistant does not work with user AI API keys and always requires centrally configured credentials.

Create an AI API key​

To create a new AI API key use the header capability Create in the AI API tokens tab on the User Settings page.

An AI API key token is defined using the following master data:

  • AI API Key: API key created through the AI provider platform (required)

Delete an AI API key​

To delete an AI API key use the inline or header Delete capability. After you confirm the action the AI API key will be permanently deleted.

Update an AI API key​

In order to update an AI API key use the inline or header Edit capability. This action allows you to change the API key. After changing the key, the new key is immediately applied for future calls to the AI provider.