SUsuperwall
Project Auth V2

Get Project Auth

Changed on

Returns the project's Superwall Auth mode, its sign-in methods, and Superwall's own issuer and JWKS URL for the project, which a backend uses to verify Superwall access tokens. A project that was never configured is off with no methods. Requires projects:read scope.

get/v2/projects/{id}/auth

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/projects/{id}/auth
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

idstring required

Response

Success

object'project_auth' required
project_idstring required
mode'off' | 'optional' | 'required' required

off: sign-in is refused. optional: tokens are verified when sent; client-asserted user ids still work. required: a request that names an identified (non-anonymous) user id must carry a valid access token for that user; anonymous ids still work.

issuerstring nullable required

Superwall's own issuer for this project: the iss (and aud) of the access tokens Superwall signs. null when this environment has no issuer configured.

jwks_urlstring nullable required

Where Superwall publishes the keys that sign this project's access tokens, so a backend can verify them offline. null when issuer is.

Changes