Profile
Overview
The Profile panel is available to all users. Available settings include:
- Define your name
- Define your email address to receive notifications
- Generate an API key for use with third party applications or during a migration from v2
- Set language preferences
Available in ≥ 3.6.4-funcrel
Access the panel using the icon in the top right corner:
User Details
The values for all fields are automatically taken from CAST Imaging’s authentication system (Keycloak), if they exist there. Synchronization occurs in both directions - i.e. a manual update in the CAST Imaging UI will update the same value in the authentication system and vice-versa:
CAST Imaging UI
Authentication system:
- All three fields in this section must be populated in order to generate an API key.
- If you are using LDAP or SAML authentication, user details are taken directly from these systems (if they have been filled in). Therefore any manual updates made in the CAST Imaging UI may be overwritten when the LDAP/SAML user database is synchronized with the CAST Imaging authentication system.
User Preferences
I want to receive email notifications
See Email notifications.
Preferred Language
Select the display language to use for system wide labels and menus. This applies to all components in the UI:
- Front-end management and admin settings
- “Viewer” UI related results consultation (excluding result data related to delivered source code)
- “Dashboard” UI related results consultation (excluding result data related to delivered source code)
Currently two languages are available out-of-the-box:
- English (default)
- Japanese
- CAST Imaging will attempt to detect the browser language setting on login - if a language is set in the browser that is supported by CAST Imaging (whether out of the box or via a custom language), this language will be used automatically on the login screen only. After login, English will always be used as the display language regardless of the browser language set. If a different language is required, users need to set that via Preferred Language option (above). If a language is detected in the browser that is not supported, CAST Imaging will display the login screen in English.
- Custom languages (not provided out of the box) can be added - see Configure a custom language display.
- Dates are always formatted using ISO standards (YYYY-MM-DD).
- Roles and profiles are not translated.
- Special characters (i.e. Japanese etc) are not permitted for use with tenants/domains and when naming new and existing applications.
- Result data (i.e. originating in delivered source code) is not translated to the chosen language.
API key
When third-party applications need to interact with the CAST Imaging (or you need to migrate from V2) you can generate an API key to access the required resources securely. Traditional user/password credentials are deemed a security risk and can also expire causing recurring problems when the resources are used for automation purposes. An API key solves these issues and CAST recommends using one wherever possible.
Note that:
- An API key is generated on a per-user basis
- Only one key can exist for each user
- When a new key is generated, the old one instantly becomes invalid
- The User Details section must be populated with information before the Generate button will become active
How do I use an API key?
Ensure that you add an X-API-KEY attribute in the request header which contains your API key. For example when using curl:
curl -H "X-API-KEY: 06935MrA.G7LStH3Ck9sgeHBYokzIjTdv2DTbicsT" http://imaging.corp.domain.com/rest