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
Access the panel using the icon in the top right corner:
Generating an 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
User Details
The values for all fields are automatically taken from CAST Imaging's authentication system, 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:
Authentication system:
CAST Imaging UI
{{% alert color="info" %}}
- 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.
- Currently the I want to receive email notifications option does not function.
Comments