Skip to main content

API Authentication

Follow this process to authenticate API access securely in a SaaS tenant environment.

Step 1: Create an API Credential​

  1. Open Settings -> API Access.
  2. Click Create Credential.
  3. Name the credential by owner and purpose.
  4. Assign least-privilege scopes.
  5. Save and securely store the value.

Step 2: Store Credential Safely​

  • Use a secrets manager.
  • Never commit credentials to source control.
  • Avoid sharing credentials across unrelated automations.

Step 3: Validate Access​

curl "$CHYPER_API_BASE/projects" \
  -H "Authorization: Bearer $CHYPER_API_KEY"

If the request fails, verify:

  1. Credential is active.
  2. Scope includes the requested resource.
  3. Request is sent to the correct base URL.

Step 4: Rotate Credentials​

  1. Create replacement credential.
  2. Update dependent services.
  3. Confirm successful requests.
  4. Revoke the old credential.

Step 5: Revoke on Risk Events​

Immediately revoke credentials when:

  • A token is exposed.
  • Ownership changes.
  • Unexpected activity is detected.

Scope Design Best Practices​

  • Split credentials by workload.
  • Keep write scopes narrow.
  • Separate sandbox and production credentials.
  • Review scope assignments quarterly.