Passwords / License

Password for the IAA user

When you install or enable the Intrexx Administration API, you will be prompted to set a password for the IAA user. (See the Go to the "Administration API Configuration" tab. section for more information.)

The password for the IAA user is stored in encrypted form in the admin-api.yaml file. You can find these at the following path: \<intrexx-installation-directory>\admin-api\cfg\

Portal Password

To access the provided API endpoints via the Intrexx Administration API, the password for the portal (or multiple portals, if applicable) must also be specified in the admin-api.yaml file.

The password is set automatically during installation of the Intrexx Administration API (Windows - Installing IAA via the graphical user interface). When activating the Intrexx Administration API, the password must be entered manually in the admin-api.yaml file (Windows - Enable IAA via the graphical user interface). The password is stored in encrypted form.

Assign a new password for IAA users

When you install or enable the Intrexx Administration API, you will be prompted to set a password for the IAA user. (See the Go to the "Administration API Configuration" tab. section for more information.)

You can change the password in the file at any time. After saving, the password is encrypted by the Intrexx Administration API.

  1. Open the admin-api.yaml file in a text editor.

    You can find these at the following path:

    \<intrexx-installation-directory>\admin-api\cfg\

  2. Overwrite the password.

  3. Make a note of the password. (Once the change is complete, the password will be displayed only in encrypted form.)

  4. Restart the Intrexx Administration API service.

  5. Update the document.

  6. The password is displayed in an encrypted form.

Update Password Changes for Intrexx Components

The passwords stored in the admin-api.yaml file are not automatically updated when they are changed in Portal Manager.

The reason for this is that the Administration API can be run independently (e.g., on a different host) and is therefore not part of the Intrexx server. New or changed passwords must therefore be entered manually in admin-api/cfg/admin-api.yaml, and the Intrexx Administration API must then be restarted.

The passwords are encrypted during this process and are stored in the configuration only in this secure form. For day-to-day operations, this means that if the password for the technical API user is changed on the Intrexx side for the supervisor or a portal, the API endpoints will temporarily lose their authorization. Therefore, especially when unexpected messages about missing authorization appear, it is recommended to check the passwords in admin-api/cfg/admin-api.yaml, re-enter them if necessary, and restart the Intrexx Administration API to ensure that they match those on the Intrexx server.

License

Enter the license for the Administration API in the ` admin-api.yaml ` file located in the ` admin-api/cfg ` directory of the Intrexx installation. In the admin-api.yaml file, look for the entry ` license: null ` and replace ` null` with your license.

admin-api.yaml

---
environment:
  host: "0.0.0.0"
  port: 4242
  portalManagementBySupervisor: false
  keystorePassword: "apiape-v1:rjIkOYgF3nzFmJhWsvpCwg=="
  sudoPassword: null
  keystore: "/opt/intrexx/admin-api/cfg/cacerts"
  secret: "apiape-v1:2g30kd5kFu8uLxplMzlhYp6J2k6Zb/HP8YZo3j/d2ToTTAU4xCe2VdnoGqi+MiOqu/n7vQmLIJgY3VeWAB0GSg=="
https: true
debugMode: true
credentials:
  password: "apiape-v1:rjIkOYgF3nzFmJhWsvpCwg=="
  username: "irma"
supervisor: null
maxAuthRequestPerIP: 50
https: true
license: null
connectTimeout: 5
readTimeout: 5
writeTimeout: 5
portals:
- name: "exampleportal"
  scheme: "https"
  host: "localhost"
  port: 8117
  credentials:
    password: ""
    username: "Administrator"