Skip to main content
POST
Create Hosted Auth URL

Body

application/json
client_key
string
required

Public client key copied from Developer Access.

redirect_uri
string<uri>
required

Saved Redirect URL that will receive the one-time code.

state
string
required

Cryptographically random callback value generated by your app.

Required string length: 16 - 2048
code_challenge
string
required

Base64url-encoded SHA-256 digest of the PKCE verifier.

Required string length: 43 - 128
Pattern: ^[A-Za-z0-9\-._~]+$
code_challenge_method
enum<string>
required

Required PKCE challenge method.

Available options:
S256

Response

Hosted sign-in URL created.

auth_url
string<uri>
Example:

"https://auth.thefaithapp.com/member/sign-in?client_key=your-public-client-key&redirect_uri=https%3A%2F%2Fexample.com%2Fauth%2Fcallback&state=replace-with-at-least-16-random-characters&code_challenge=base64url-sha256-of-your-code-verifier&code_challenge_method=S256"

client
object
redirect_uri
string<uri>
Example:

"https://example.com/auth/callback"

providers
string[]
Example: