My company

The “My company” section (formerly "Team management") is where you can manage Akoya-hosted accounts. You can also edit company details, set a logo, and more.

📘

Federated accounts are managed via your IDP

While you will be able to view users who currently have Hub access in "My company", user role assignments and modifications must be made from your IDP.

All topics on this page refer only to Akoya-hosted accounts unless specified otherwise.

User roles

The Hub offers role-based access control (RBAC) to Akoya-hosted and federated accounts. Admin and Viewer roles are available.

Admins are designated by the crown icon next to the user’s name on the My company page.

• Administrator Role: Provides comprehensive management capabilities across the Hub, enabling application edits, client ID and secret management, as well as team oversight.
• Viewer Role: Provides read-only access to products, data elements, and data providers. This role is for individuals requiring information access for analytical or troubleshooting purposes without edit capabilities. A Viewer can create support cases but cannot reset credentials.
• Both Administrators and Viewers can submit production incident tickets.

If you're using federated accounts to access the Hub, role assignment is managed via your own IDP. For more information, see Authentication.

Adding users

The account you use to sign up with Akoya will be your company’s first user. Afterward, you can set up users from the "My company" section or by clicking your company name at the bottom of the navigation pane (both links take you to "My company").

Click the “Invite” button in the "Team" tab.

Fields will populate for you to enter the new user’s name and email. You can also assign a role to the user.

Click the “Invite” button when finished. The user will receive an invitation email with further instructions to set up their account.

🚧

The email invite link expires in seven days!

If the new user hasn’t completed the initial login by then, you’ll need to delete/recreate the user to generate a new invite.

After setting a password, the new user is prompted to set up multi-factor authentication (MFA). Setting up MFA is mandatory for Hub accounts. See the Authentication section for more details.

Change role assignment

A user with admin rights can change any other team member’s user role by clicking the pencil next to the user’s name. Select either Admin or Viewer from the drop-down menu and click “Submit.”

Deleting users

To remove a team member, an admin selects the trash can icon next to the user.

Resetting passwords

📘

Note

You can only reset your own password

1. Click the "Reset password" button on the right.

2. Enter your new password twice in the fields indicated and click "Save."

Edit profile display name

You can update your display name by clicking the pencil next to your name (as shown in the image above), edit the name field, and click "Save."

Edit company details

The "Edit company details" page allows you to modify the following attributes:

• Company name
• Description
• Logo URL
  • See "Registering sandbox apps” for logo requirements.
• Icon URL
  • See "Registering sandbox apps” for icon requirements.
• Contact us URL
  • This is your company's "Contact us" page.
• Contact email address
  • Emails from our support team will go to this email address, so we recommend using a distribution list to ensure the correct parties receive these notifications.

1. Click the "Edit profile" button next to your company's name. An update screen will appear.
2. When you're finished with your updates, click the "Update" button at the bottom.

Service API credentials

We offer two service APIs:

• Management API
  • helps you create and update your applications on the Akoya network. You may also search for providers and request subscriptions for the data you need.
• Notifications API
  • enables you to retrieve notices about significant changes to the status of an item on the Akoya network.

You can generate credentials and reset your client secret from the “API credentials” tab.

A csv download with your credentials will trigger. These credentials are used to obtain service tokens. After downloading the csv, the “Generate” button will change to a reset icon. The credentials are not stored in the Hub, so please save them in a safe place. If you lose them, you’ll have to reset them.

🚧

Service tokens are only for service APIs

The Akoya Service tokens API is used to generate tokens for Akoya service APIs, such as our Management or Notifications APIs. The Akoya Token API is used to generate ID tokens for the Akoya Products APIs.