Skip to content
Hawzu Docs

Create Access Token

2 min read

Create access tokens when an external system needs to authenticate Hawzu API requests.

Tokens are shown only once after creation. Copy the token before closing the success window.

Open The Create Window

Section titled “Open The Create Window”

Go to the Access Tokens page and select Create Token.

If the workspace has no tokens yet, use Create Access Token from the empty state.

The create action is available only to users with permission to create workspace access tokens.

Token Name

Section titled “Token Name”

Token Name is required.

Use a name that explains the token’s purpose, such as:

  • CI Runner
  • Nightly Automation
  • External Sync

Clear names make it easier to audit and revoke tokens later.

Choose The Access Type

Section titled “Choose The Access Type”

Choose either Workspace or Project.

This choice controls how roles are assigned.

Workspace Token

Section titled “Workspace Token”

Choose Workspace when the token should use one workspace role.

Then select a role from Workspace Scope.

The role picker only shows workspace roles that can be assigned to access tokens. Some protected or user-only roles are intentionally not available.

Project Token

Section titled “Project Token”

Choose Project when the token should access one or more projects.

For each project row:

  1. Choose a project.
  2. Choose a project role.

Use Add another project to add another project row. The button is available after the current project rows are complete.

Projects already selected in another row are not shown again. A role can be selected only after a project is selected.

Use the remove action in a row to remove that project from the token before creation.

Expiry Date

Section titled “Expiry Date”

Choose one expiry option:

  • 1 Week
  • 1 Month
  • 6 Months
  • 1 Year
  • Custom Date
  • Never Expires

The default expiry is 1 Week.

Choose Custom Date to pick a specific date. Custom dates cannot be in the past.

Choose Never Expires only when needed. Hawzu shows a security warning because tokens without expiry should be kept carefully and rotated regularly.

Create Token

Section titled “Create Token”

Create Token is enabled only when:

  • The token name is filled in.
  • A workspace role is selected for workspace tokens.
  • Every project row has both a project and a role for project tokens.

Select Cancel to close the create window without creating a token.

Copy The Token

Section titled “Copy The Token”

After creation, Hawzu opens an Access Token Created window.

Copy the token immediately. This is the only time the token value is shown.

After the success window is closed, Hawzu will not show the full token value again. If the value is lost, create a new token and update the system that uses it.

After Creation

Section titled “After Creation”

The token appears in the Access Tokens table with its label, access type, creator, created date, expiry, and lifecycle actions.

Keep the copied token in a secure place, such as a secrets manager or CI/CD secret location.

Next Steps

Section titled “Next Steps”