Credential Rotation Guide

To rotate your credentials before they expire, follow the steps below. You control the naming and expiration settings for any new credentials you create.

  1. Generate New Credentials
    1. Use the POST /api/v0/client-credentials (Details Here) endpoint to create a new set of credentials. The response will include both a clientId and a clientSecret.

      IMPORTANT The clientSecret is only returned once. Be sure to store it securely.

  2. Use the New Credentials
    1. Use the newly generated clientId and clientSecret to obtain access tokens via the /api/v0/oauth/token (Details Here) endpoint.

      We recommend running your new credentials in parallel with your existing ones and monitoring functionality to ensure a smooth transition

  3. Retire the Old Credentials
    1. Once you're confident the new credentials are working correctly, you may delete the old, expiring credentials using the DELETE /api/v0/client-credentials/{clientId} (Details Here) endpoint.