Organizations using Backlog can enhance their security using SSH public and API keys.
In this overview, we’ll go over how to:
- Register an SSH public key
- Generate an API key
Register an SSH public key
Your SSH public key needs to be registered to access the Git repository via SSH. For authentication, SSH keys operate in pairs: private, which is saved to your computer, and public, which is registered in Backlog. Depending on your operation system and preferred SSH client, you can create your SSH pair using your computer.
To register your SSH public key:
- Select your profile icon in the global navigation.
- Select “Personal settings.”
- Select “SSH public key” from the menu on the left.
- Paste your key into the text field.
- Select “Submit.”
Generate an API key
Backlog’s API settings identify whether a specific user has access to call the API. Backlog offers a developer API, but non-developers may use this setting when bulk registering issues using Google sheets.
To generate an API key:
- Select your profile icon in the global navigation.
- Select “Personal settings.”
- Select API from the menu on the left.
- Enter a memo to help differentiate API keys and their usage.
- Select “Submit” to generate the API key.
Once registered, API keys appear at the bottom of the page. Use the clipboard icon to copy an API key or the “X” to remove a key.