Hawcx sign-in can now run on your own domain

Published
Reading time
3 min

These Hawcx release notes cover October 23: Hawcx sign-in can now run on a domain you own, such as auth.example.com. Sign-in, token and logout are served on your verified domain from the shared platform, with no dedicated deployment and no proxy to run.

You verify the domain with one DNS record, point a CNAME at Hawcx, and manage it from the admin console. The server SDKs build sign-in and logout links on your domain with one option.

At a glance

ChangeTypeWho it affects
Sign-in, token and logout on your own domainNewYour users, developers
Verify a domain with a DNS TXT recordNewAdministrators
Verified domains are re-checked automaticallyNewAdministrators
Enforce: allow sign-in only on your verified domainsNewAdministrators
A Custom domains card in the admin consoleNewAdministrators
customDomain and URL helpers in the server SDKsNewDevelopers

For your users

Sign-in on your own domain

New. Your users can sign in at an address on your own domain instead of a Hawcx one. Sign-in, the token endpoint and logout all run on your verified domain, so the whole passwordless sign-in carries your brand. It runs on the shared Hawcx platform, so there is no separate deployment to set up or maintain. It suits passwordless login for customers, where the sign-in page is part of your product.

For administrators

Verify and manage domains in the admin console

New. Admins manage domains in the admin console, under Super admin controls, then Custom domains:

  1. Add your domain and copy its TXT value.
  2. Publish the TXT record in your DNS, and point a CNAME at Hawcx.
  3. Click Verify.

Verified domains are re-checked automatically, so a domain that stops pointing at you doesn't stay trusted.

Enforce mode

New. Once a domain is verified, you can turn on Enforce. Hawcx then accepts sign-in for your tenant only on your verified domains and the Hawcx platform host. That gives you control over where your login is served.

For developers

customDomain in the server SDKs

New. The Node, Python and Java SDKs take an optional customDomain alongside the issuer, and two helpers build the browser URLs on it: buildAuthorizeUrl for sign-in and buildEndSessionUrl for logout. You no longer build those URLs by hand.

Only the two browser URLs move to your domain. Token exchange, key retrieval and the issuer check stay on the Hawcx issuer, and tokens carry the platform issuer as before.

This support is in Node 6.2.0, Python 2.2.0 and Java 0.7.0, published on November 9 and 10 with the new Profile Service client. Those versions also change how a token exchange handles redirects, so read that post's upgrade notes before you move.

Getting started

Nothing changes for an existing tenant until it configures a custom domain: sign-in keeps working on the Hawcx host. To move your sign-in to your own domain, contact Hawcx and we'll turn it on for your domain. You then add the domain in the admin console and publish the two DNS records. Setup guides are on docs.hawcx.com.

Frequently asked questions

Do existing tenants need to change anything?

No. Nothing changes until you add a custom domain. Until then, sign-in, token and logout keep working on the Hawcx host as before.

What DNS records do I need?

Two: a TXT record that proves you own the domain, and a CNAME that routes it to Hawcx. You don't need a reverse proxy of your own. Contact Hawcx first, so we can turn custom domains on for your domain.

What does Enforce do?

With Enforce on, Hawcx accepts sign-in for your tenant only on your verified domains and the Hawcx platform host. It becomes available once at least one domain is verified.

Which SDK versions support custom domains?

Node @hawcx/oauth-client 6.2.0, Python hawcx-oauth-client 2.2.0 and Java com.hawcx:hawcx-java-sdk 0.7.0, each with the customDomain option and the buildAuthorizeUrl and buildEndSessionUrl helpers.

ShareLinkedInX

Authentication for people and the AI agents they put to work.