About Identity Management and Password Handling

Managing identities in the developer portal is the process that ensures developers can securely log in access resources needed to build, test, and deploy applications, and while protecting sensitive information and maintaining compliance. Key aspects include identifying the users, the roles, and the permissions.

Identifying the Users

The developer portal has three user personas: Admin, Developer, and Spectator.

Admin

The administrator is responsible for managing user permissions, user accounts, and access to keys within the organization. They have the authority to edit role permissions, add, delete, and edit user accounts, update user passwords, access shared keys, secret keys, and generate new keys as needed.

What Can I do as an Admin?

  • Edit permissions of users.
  • Ensure that users have appropriate access

User Account Management

  • Add new users to the system and assign them appropriate roles and permissions
  • Delete user accounts of employees who have left the organization

Key Management

  • View applications
  • Access shared keys and secret keys
  • Generate new keys as needed for different applications

Developer

The Developer is responsible for managing their own account information, accessing applications, utilizing the watchlist feature to favorite items, accessing, deleting, and generating shared and secret keys, and testing APIs using Postman.

What Can I do as an Admin?

Account Management

  • Manage their own account information, including personal details and contact information.
  • Update account preferences and settings as needed

Application Access

  • Access and utilize applications
  • Ensure proper authentication and authorization mechanisms are in place for secure access

Watchlist Management

  • Utilize the watchlist feature to favourite items, such as APIs, SDKs or trainings
  • Utilize watchlist to communicate interest with their Candescent representative

Key Management

  • Access shared and secret keys necessary for application development
  • Delete unused or outdated keys to maintain security and prevent unauthorized access
  • Generate new keys

API Testing with Postman

  • Utilize Postman to test APIs and ensure proper functionality and integration

Spectator

The Spectator is a general user who can view API information and request to learn more about the options to build applications.

Account Management

  • Manage their own account information, including personal details and contact information
  • Update account preferences and settings as needed

Watchlist Management

  • Utilize the watchlist feature to favourite items, such as APIs, SDKs or trainings
  • Utilize watchlist to communicate interest with their Candescent representative

User Management

User management refers to the processes and tools that allow administrators to create manage, and control access to the portal. It involves overseeing who can access the portal, what actions a user can perform, and how that user interacts with the resources and APIs offered by the portal.

Admin View

The User Management page is editable for the users assigned the admin role.

Developer View

The User Management page is a read-only view for the users assigned the developer role.

Adding or Deleting a User to the Developer Portal

The Manage Users page on the Users tab features a list of all existing service account users and team members for your org. While service account users can't be edited or removed, you may remove existing team members by selecting the trashcan icon next to their profile.  To add new users, input their email address into the Email field and assign the permissions level in the Select Permissions field.

During the initial invitation process, only one role can be assigned to a new team member. Below are the available roles for assignment, along with their associated permissions:
‍

  • Admin - This role allows a user to invite, remove, and edit roles for new and existing team members, as well as manage partnerships and sites.
  • Spectator - This role allows a user to view-only access to provisioning requests, partnerships, and sites.
  • Developer - This role grants a user access to the Developer Experience portal to view API documentation.

After you've selected the desired initial role for the user, select Invite to send the user an email notifying the person they are granted access to the developer portal.

Editing User Roles

Click on the gear icon next to a user profile on the Manage Users page to edit a role(s) assigned to an existing user. In the Permissions section of the users profile, check the box next to each role that you wish to grant. Save the changes before exiting out of the user profile.