Information for: DEVELOPERS   PARTNERS

Resetting API keys on Site Factory

To satisfy security needs, Site Factory administrators can use the Site Factory Management Console or the Site Factory API to reset API keys of an individual user, or all users. Users can also reset their own API key.

Resetting your own API key

You can reset your own API key, regardless of your assigned roles in Site Factory, by completing the following steps:

  1. Sign in to your Prod environment’s Site Factory Management Console.
  2. In the top menu, click your username.
  3. Click API Key in the menu to display your API key.
  4. Click Regenerate, and Site Factory will immediately regenerate your API key.

Until an administrator for your Factory performs the steps described in Copy production data to non-production environments, selecting the Stage all users option to copy user data to non-production environments, your previous API key will remain in effect on non-production environments.

Resetting another user’s API key

Administrators can reset a single user’s API key by using the Site Factory Management Console or the /api/v1/users/[user_id]/api-keys endpoint. To reset a single user’s API key from the Site Factory Management Console, complete the following steps:

  1. Sign in to your Prod environment’s Site Factory Management Console using an account with the platform admin role.
  2. In the admin menu, click Users, and search for the user whose API key you want to reset.
  3. Click API Key in the menu, and the Site Factory Management Console will display the user’s current API key.
  4. Click Regenerate, and Site Factory will immediately regenerate the API key.
  5. To update the user’s API key on your non-production environments, perform the steps described in Copy production data to non-production environments, selecting the Stage all users option to copy only user data to the non-production environment.

After the user staging process is complete, the user’s API key is updated on all environments.

Resetting API keys for all users

You can reset the API keys for all users by using the Site Factory Management Console or the /api/v1/users/all/api-keys endpoint. To reset the API keys of all users from the Site Factory Management Console, complete the following steps:

  1. Sign in to your Prod environment’s Site Factory Management Console using an account with the platform admin role.

  2. In the admin menu, click Administration, and then click the Security settings link.

  3. Scroll to API keys and click Regenerate keys.

    Site Factory will create tasks to regenerate the keys for all users. For information about monitoring these tasks, see Task logs in Site Factory.

  4. To update all API keys on your non-production environments, perform the steps described in Copy production data to non-production environments after the API key regeneration tasks complete, selecting the Stage all users option to copy only user data to the non-production environment.

After the user staging process is complete, all API keys are updated on all environments.