Authentication

Everything about signing in, keeping accounts secure, and connecting third-party apps. This page covers human logins to the dashboard. For machine-to-machine API access, see API Reference.

Login and registration

New accounts are created at https://portal.orenyxengine.com/signup. Sign-up needs only a name, work email, and password. Once an account exists, its owner can invite teammates from inside the dashboard and assign each one a role, so nobody needs their own separate signup link.

RoleWhat it can do
Platform AdminFull control of the workspace: billing, team, integrations, everything below
Bot OwnerConfigure and manage the automated bots
DeveloperAPI keys, webhooks, workflows, and technical integration work
AnalystRead-only access to reports and usage data
AuditorRead-only access to the audit log and compliance-related records
Integration PartnerScoped access for a third-party integration partner

Two-factor login (mandatory)

Every account, on every role, has two-factor email verification enabled with no exceptions and no opt-out. After entering an email and password, a one-time code (an OTP) is sent to that email address. The code must be entered before the dashboard becomes accessible.

  • The code is single-use and expires after a short window.
  • This applies on every new sign-in, not just the first one.
  • Because of this, an account cannot be accessed with a leaked password alone: whoever is signing in also needs access to the real inbox.

Sessions

A session is what keeps someone signed in between visits, without re-entering a password on every page load.

  • A session lasts up to 30 days, and quietly renews itself as long as it is used at least once a day.
  • Signing out ends the session immediately and is recorded in the audit log.
  • A session can also be force-ended instantly, from every device at once, either by the account holder ("log out everywhere") or by support/security staff for account-safety reasons. This does not require changing the password, and takes effect on the very next request.
Forcing a sign-out invalidates dashboard sessions. It does not revoke API keys or OAuth tokens, those are separate credentials with their own lifecycle (see API Reference).

OAuth 2.0 (for connecting third-party apps)

OAuth lets an external application request permission to act on a user's behalf, without that user ever sharing their password with the third-party app. This uses the standard Authorization Code flow with PKCE (a widely used extra layer of protection recommended for any modern OAuth integration).

Step 1: Register your application

Create an OAuth application from the dashboard, or directly against the API:

curl -X POST https://portal.orenyxengine.com/api/oauth/apps \
  -H "x-api-key: orx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Integration",
    "redirect_uris": ["https://myapp.example.com/oauth/callback"]
  }'

This returns a client_id and client_secret. Keep the secret private, treat it like a password.

Step 2: Send the user to authorize

Redirect the user to the authorization step with your client_id, your redirect_uri, and (recommended) a PKCE code_challenge. Once the user approves, they are sent back to your redirect_uri with a one-time authorization code.

Step 3: Exchange the code for a token

curl -X POST https://portal.orenyxengine.com/api/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "authorization_code",
    "client_id": "your_client_id",
    "client_secret": "your_client_secret",
    "code": "the_code_from_step_2",
    "redirect_uri": "https://myapp.example.com/oauth/callback",
    "code_verifier": "the_pkce_verifier_you_generated"
  }'

This returns an access token (used the same way as an API key, in the x-api-key header) and a refresh token. When the access token expires, use the refresh token to get a new one without asking the user to approve again:

curl -X POST https://portal.orenyxengine.com/api/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "refresh_token",
    "client_id": "your_client_id",
    "client_secret": "your_client_secret",
    "refresh_token": "the_refresh_token"
  }'

Managing your OAuth application

  • List every OAuth application registered for your account, and see which ones are active.
  • Rotate a client secret at any time if it may have been exposed, the old secret stops working immediately.
  • Delete an application to permanently revoke every token it has ever issued.

Managing API keys

Keys are created, rotated, and revoked from the developer dashboard or the business portal, by a signed-in person. They cannot be managed using an API key.

This changed, and it may affect you. Until recently, /api/v1/api-keys accepted an API key, which meant a key could mint further keys, including keys carrying scopes the original did not hold. That is a privilege escalation, so those endpoints now accept only a signed-in session and return 403 (MAE-4016) to an API key. If you automated key rotation by calling the API with a key, that automation will stop working and the rotation has to move to the dashboard. Nothing else about how you authenticate ordinary requests has changed.

Security best practices

  • Never share a password, API key, or OAuth client secret over email, chat, or a support ticket.
  • Use the "Developer" role, not "Platform Admin", for day-to-day integration work, so a compromised integration cannot touch billing or team settings.
  • Rotate API keys and OAuth secrets on a schedule, not only when something goes wrong.
  • Review the audit log periodically, every meaningful action on the account is recorded there with who did it and when.

Was this page helpful?