Skip to main content
POST
Create Hosted Auth URL

Body

application/json
client_key
string
required

Client key copied from Developer Access.

Example:

"your-client-api-key"

redirect_uri
string<uri>
required

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

Example:

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

state
string

Random value generated by your app and verified when the member returns.

Example:

"replace-with-random-state"

code_challenge
string

Optional PKCE code challenge for public clients.

Example:

"base64url-sha256-code-verifier"

code_challenge_method
enum<string>

PKCE challenge method. Use S256 when sending code_challenge.

Available options:
S256
Example:

"S256"

Response

Hosted sign-in URL created.

auth_url
string<uri>
Example:

"https://auth.thefaithapp.com/member/sign-in?client_key=your-client-api-key&redirect_uri=https%3A%2F%2Fexample.com%2Fauth%2Fcallback&state=replace-with-random-state"

client
object
redirect_uri
string<uri>
Example:

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

providers
string[]
Example: