1. ProKnow
  2. Setup & Security
  3. User Access and Configuration

Configuring Your Profile

Avatar
Kyle Burnett
Follow

IN THIS ARTICLE

Your profile refers to the settings attached to your identity in ProKnow. This article describes how you can configure your profile with two-factor authentication and API keys.

Setting Up Two-Factor Authentication

Two-factor authentication is simply an extra layer of security for your account. In addition to your password, two-factor authentication works by requiring a second piece of information that only you know or have on your person when signing in to ProKnow. We recommend enabling two-factor authentication to bolster your account's security.

  1. Once you are signed in, click on the ProKnow icon in the top left corner of the page, and select Your Profile.
  2. Select the Two-Factor Authentication section.
  3. Toggle the status to Enabled to enable two-factor authentication, and read the notice.
  4. Check the box to indicate you have read and understood the notice, and press the Save button. You will be signed out and returned to the sign in screen.
  5. Log in to your account again. You will be directed to a page where you can pick your second factor authentication method. Choose a method, and follow the on-screen prompts to complete your device enrollment.

Managing API Keys

API keys are an advanced feature. If you don't know what API keys are, you can probably safely ignore this section. However, if you are using the ProKnow API programmatically in a script or if you are setting up a DICOM server for uploading files to ProKnow, you will probably need to create and manage API keys. Read on to find out how.

CAUTION: It is important to understand that the information contained in the downloaded credentials.json file is enough to grant anyone who is in possession of the file full access to the ProKnow DS user account that created the API key. As such, you should take great care to ensure that your API keys are stored in a safe and secure manner (for instance, you should NEVER store API keys in source code nor should you ever transmit your API keys over unencrypted protocols). When using API keys in stand-alone production services (e.g., ProKnow DICOM DS) it is best practice to create a dedicate user account for each service in ProKnow DS and generate the API keys using that dedicated user account. Using a dedicated user account for each service user has the following advantages:

  • Allows you to restrict the permissions of the user to only those that are explicitly required (limiting exposure in the event that the user's credentials are compromised)
  • Provides more accurate visibility into the actions performed by the service user (for auditing purposes)
  • Allows you to easily disable the service user in the event that you suspect that the service user's credentials have been compromised

Use the following steps to manage your API keys.

  1. Once you are signed in, click on the ProKnow icon in the top left corner of the page, and select Your Profile.
  2. Select the API Keys section.

  3. To create an API key, enter a descriptive name for the key and press the Create button. Save the downloaded credentials.json file in a safe place.

    To revoke an API key, click the trash icon next to the key you wish to delete, and press the Revoke button to confirm.

Note: You must have the Create API Keys permission on the organization to create API keys for your account.

Managing Personal Preferences

Use the following steps to manage your personal preferences.

  1. Once you are signed in, click on the ProKnow icon in the top left corner of the page, and select Your Profile.
  2. Select the Preferences section.

  3. Set the available preferences and press the Save button. Descriptions for each the configurable options are enumerated below.

    • Patient Orientation
      • Planning Orientation (or Image Orientation if not available): All patient objects will be rendered according to the orientation specified by the plan. If a plan is not activated, the Image Orientation will be used.
      • Planning Orientation (or Head First Image Orientation if not available): All patient objects will be rendered according to the orientation specified by the plan. If a plan is not activated, the Head First Image Orientation will be used.
      • Image Orientation: All patient objects will be rendered according to the orientation specified by the image set.
      • Head First Image Orientation: All patient objects will be rendered in the head first orientation related to the specified Image Orientation (e.g., FFS will be displayed as HFS and FFP will be displayed as HFP).
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.