auth

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-auth"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/0c2f32db-42fb-4521-9452-015ed6dd8c92/social-card.svg?v=3e7ae33eec8b" alt="auth" width="600" height="315"></a>
GEThttps://hermetica.15.204.158.166.sslip.io/auth/atlas/start

Sign in (or sign up with screen_hint=signup) at Atlas: authorization code + PKCE + nonce

Parameters

return_tostringquery
screen_hintstringquery
signup | signin
refstringquery
invitestringquery
login_hintstringquery

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/auth/atlas/start"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

302 Default Response
{}
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /auth/atlas/start

GEThttps://hermetica.15.204.158.166.sslip.io/auth/atlas/callback

Atlas redirect target: verifies the ID token, finds or creates the user, opens a session bound to the Atlas sid

Parameters

codestringquery
statestringquery
errorstringquery

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/auth/atlas/callback"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

302 Default Response
{}
4XX Default Response

Same as 4XX · GET /auth/atlas/start

5XX Default Response

Same as 4XX · GET /auth/atlas/start

POSThttps://hermetica.15.204.158.166.sslip.io/auth/atlas/backchannel-logout

OIDC back-channel logout from Atlas: ends every session opened from that Atlas session

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/auth/atlas/backchannel-logout"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · GET /auth/atlas/start

5XX Default Response

Same as 4XX · GET /auth/atlas/start

POSThttps://hermetica.15.204.158.166.sslip.io/auth/atlas/webhooks

Atlas webhooks (user.updated/deleted/banned, session.revoked/expired): signature-verified over the raw body

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/auth/atlas/webhooks"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · GET /auth/atlas/start

5XX Default Response

Same as 4XX · GET /auth/atlas/start

POSThttps://hermetica.15.204.158.166.sslip.io/auth/atlas/before-user-create

Atlas before_user_create hook: names the Hermetica user id (external_id), or denies while sign-up is closed

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/auth/atlas/before-user-create"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · GET /auth/atlas/start

5XX Default Response

Same as 4XX · GET /auth/atlas/start

Updated