Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Authentication guide sets ADMIN_API_KEY and AUTO_PROVISIONING_ENABLED, which the Cloud Agent does not read

Open Beginner friendly
  • Is something wrong?
#297 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
84/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Read documentation/develop/cloud-agent/authentication.md, especially lines 69–85, and compare its environment variable names with the matching Cloud Agent application.conf entries and the portal's environment-variables.md reference. Update both setup tables to use the variables the server reads and explain their defaults. Done when the tables match that configuration and an isolated configuration check confirms the selected admin token and auto-provisioning setting are applied.

Written by the indexing model from the issue text.

Description

bug documentation

User impact

An operator following the authentication guide cannot enable API-key auto-provisioning and cannot install their own administrator secret. Setting AUTO_PROVISIONING_ENABLED=true leaves auto-provisioning off, so the first request for an unregistered tenant fails instead of provisioning it. Setting ADMIN_API_KEY=secret does not replace the admin token, so the built-in default admin token stays in effect. The same portal's environment-variable reference already lists the names the agent reads, so the guide also contradicts itself.

Affected documentation and ownership

  • Page: https://identus.io/documentation/develop/cloud-agent/authentication/ — GET 200 after trailing-slash resolution, Last-Modified: Tue, 27 Oct 2026 12:51:14 GMT, observed 2026-10-29T10:22Z. The deployed HTML contains both AUTO_PROVISIONING_ENABLED and ADMIN_API_KEY.
  • Documentation source: authentication.md lines 69–77 and 79–85, revision fa985dfa33caefa45bf1e9009e1f6f5a445344fb.
  • Editable owning source: the same file. Ordinary committed Markdown, not prepare.sh/OpenAPI/TypeDoc output.
  • Intended component version: Identus Cloud Agent 2.2.1-SNAPSHOT. The docs revision pins its cloud-agent submodule at eee1ff7, whose version.sbt and application.conf are identical to the comparison revision 24facc used below; the compare contains only CI-workflow and client-generator lockfile changes. The pages are unversioned, so this is the normative main configuration at the pinned docs revision.

Observed versus expected

The auto-provisioning table (source lines 73–77) sets:

| API_KEY_ENABLED                      | true  |
| API_KEY_AUTHENTICATE_AS_DEFAULT_USER | false |
| AUTO_PROVISIONING_ENABLED            | true  |

The admin table (source lines 83–85) sets ADMIN_API_KEY=secret.

The Cloud Agent configuration reads neither name:

The same portal's environment-variable reference lists ADMIN_TOKEN (line 14, default admin) and API_KEY_AUTO_PROVISIONING (line 29, default false).

Expected: the setup tables name environment variables that the matching Cloud Agent reads, so following them changes the running configuration.

Evidence and reproduction

Static comparison at the revisions above, observed 2026-10-29:

tar xzf cloud-agent-24faccaa.tar.gz
grep -rn "AUTO_PROVISIONING_ENABLED" .    # no matches
grep -rn "ADMIN_API_KEY" .                # integration-test client configs only, e.g.
#   tests/integration-tests/src/test/resources/configs/*.conf: apikey = "${ADMIN_API_KEY:-admin}"
grep -n "ADMIN_TOKEN\|API_KEY_AUTO_PROVISIONING" cloud-agent/service/server/src/main/resources/application.conf
#   120: token = ${?ADMIN_TOKEN}
#   143: autoProvisioning = ${?API_KEY_AUTO_PROVISIONING}

The integration-test hits are the value the test client sends in the x-admin-api-key header (default admin, matching the server default), not a server binding.

Limitations: static source comparison and saved HTTP responses only. No agent was started; the conclusion does not depend on runtime behaviour, because an unread environment variable cannot change HOCON substitution.

Existing work checked

GitHub issue/PR search across hyperledger-identus/docs and hyperledger-identus/cloud-agent, open and closed, by exact identifier in title and body (2026-10-29):

  • ADMIN_API_KEY → 0 results; AUTO_PROVISIONING_ENABLED → 0 results.
  • ADMIN_TOKEN → 4 closed agent-startup reports unrelated to these tables.
  • API_KEY_AUTO_PROVISIONING → includes cloud-agent#1628 (merged), which changed the default of API_KEY_AUTO_PROVISIONING to false; it does not touch the documentation tables, so it is related work, not a duplicate.

Acceptance criteria

  • Both tables name environment variables that the matching Cloud Agent server reads, or the sections explain the real keys and defaults.
  • A reader who follows the tables can observe auto-provisioning enabled and their chosen administrator token accepted. Verification: static comparison against the same revision's application.conf, plus an isolated configuration test showing the substituted values reach autoProvisioning and admin.token.
Dominant language
TypeScript
Stars
15
Forks
8
Avg merge
3d 14h
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from hyperledger-identus/docs

All issues in hyperledger-identus/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.