Initiates a request for authorization of a Connected App to access a User's account.
Call this endpoint using the query parameters from an OAuth Authorization request. This endpoint validates various fields (scope, client_id, redirect_uri, prompt, etc...) are correct and returns relevant information for rendering an OAuth Consent Screen.
The ID of the Connected App client.
The callback URI used to redirect the user after authentication. This is the same URI provided at the start of the OAuth flow. This field is required when using the authorization_code grant.
The OAuth 2.0 response type. For authorization code flows this value is code.
An array of scopes requested by the client.
Space separated list that specifies how the Authorization Server should prompt the user for reauthentication and consent. Only consent is supported today.
Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
The unique ID of the affected User.
The user object affected by this API call. See the Get user endpoint for complete response field details.
The unique ID of the affected User.
The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
The name of the User. Each field in the name object is optional.
The first name of the user.
The middle name(s) of the user.
The last name of the user.
The trusted_metadata field contains an arbitrary JSON object of application-specific data. See the Metadata reference for complete field behavior details.
The untrusted_metadata field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and cannot be used to store critical information. See the Metadata reference for complete field behavior details.
An array of email objects for the User.
The unique ID of a specific email address.
The email address.
The verified boolean denotes whether or not this send method, e.g. phone number, email address, etc., has been successfully authenticated by the User.
An array of phone number objects linked to the User.
The unique ID for the phone number.
The phone number.
The verified boolean denotes whether or not this send method, e.g. phone number, email address, etc., has been successfully authenticated by the User.
An array of OAuth provider objects linked to the User.
The unique ID for an OAuth registration.
The unique identifier for the User within a given OAuth provider. Also commonly called the "sub" or "Subject field" in OAuth protocols.
Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Facebook, GitHub etc.
If available, the profile_picture_url is a url of the User's profile picture set in OAuth identity the provider that the User has authenticated with, e.g. Facebook profile picture.
If available, the locale is the User's locale set in the OAuth identity provider that the user has authenticated with.
An array that contains a list of all Passkey or WebAuthn registrations for a given User in the Stytch API.
The unique ID for the Passkey or WebAuthn registration.
The domain on which Passkey or WebAuthn registration was started. This will be the domain of your app.
The user agent of the User.
The authenticator_type string displays the requested authenticator type of the Passkey or WebAuthn device. The two valid types are "platform" and "cross-platform". If no value is present, the Passkey or WebAuthn device was created without an authenticator type preference.
The verified boolean denotes whether or not this send method, e.g. phone number, email address, etc., has been successfully authenticated by the User.
The name of the Passkey or WebAuthn registration.
An array that contains a list of all biometric registrations for a given User in the Stytch API.
The unique ID for a biometric registration.
The verified boolean denotes whether or not this send method, e.g. phone number, email address, etc., has been successfully authenticated by the User.
An array containing a list of all TOTP instances for a given User in the Stytch API.
The unique ID for a TOTP instance.
The verified boolean denotes whether or not this send method, e.g. phone number, email address, etc., has been successfully authenticated by the User.
An array contains a list of all crypto wallets for a given User in the Stytch API.
The unique ID for a crypto wallet
The actual blockchain address of the User's crypto wallet.
The blockchain that the User's crypto wallet operates on, e.g. Ethereum, Solana, etc.
The verified boolean denotes whether or not this send method, e.g. phone number, email address, etc., has been successfully authenticated by the User.
The password object is returned for users with a password.
The unique ID of a specific password
Indicates whether this password requires a password reset
Roles assigned to this User. See the RBAC guide for more information about role assignment.
The timestamp of the User's creation. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. 2021-12-29T12:33:09Z.
The status of the User. The possible values are pending and active.
The Connected App affected by this operation. Only a subset of fields safe for public viewing are returned.
The ID of the Connected App client.
A human-readable name for the client.
A human-readable description for the client.
The type of Connected App. Supported values are first_party, first_party_public, third_party, and third_party_public.
The logo URL of the Connected App, if any.
Whether the user must provide explicit consent for the authorization request.
Details about each requested scope.
The name of the scope.
A human-readable description of the scope, taken from the RBAC Policy.
Indicates whether the scope can be granted. Users can only grant scopes if they have the required permissions.
import React, { useState } from 'react';
import { useStytch } from '@stytch/react';
export const OAuthAuthorizeStart = () => {
const stytch = useStytch();
const [loading, setLoading] = useState(false);
const [result] = useState(null);
const startOAuthAuthorization = async () => {
setLoading(true);
try {
await stytch.idp.oauthAuthorizeStart({
client_id: 'connected-app-test-d731954d-dab3-4a2b-bdee-07f3ad1be888',
redirect_uri: 'https://example.com/callback',
response_type: 'code',
scopes: ['openid', 'profile', 'email'],
prompt: 'consent',
});
} catch (error) {
console.error('Error starting OAuth authorization:', error);
} finally {
setLoading(false);
}
};
return (
<div>
<button onClick={startOAuthAuthorization} disabled={loading}>
{loading ? 'Starting Authorization...' : 'Start OAuth Authorization'}
</button>
{result && (
<div>
<h3>Authorization Result:</h3>
<pre>{JSON.stringify(result, null, 2)}</pre>
</div>
)}
</div>
);
};{
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"user_id": "user-test-16d9ba61-97a1-4ba4-9720-b03761dc50c6",
"user": {
"user_id": "user-test-16d9ba61-97a1-4ba4-9720-b03761dc50c6",
"email_address": "sandbox@stytch.com",
"status": "active",
"name": "Sandbox User",
"created_at": "2023-06-01T12:00:00Z",
"updated_at": "2023-06-01T12:00:00Z"
},
"connected_app": {
"client_id": "example-connected-app-client-id",
"client_name": "Example Connected App",
"client_description": "An example connected app for testing",
"client_logo_url": "https://example.com/app-logo.png",
"client_website_url": "https://example.com",
"client_terms_of_service_url": "https://example.com/terms",
"client_privacy_policy_url": "https://example.com/privacy"
},
"consent_required": true,
"connected_app_scope_results": [
{
"scope": "openid",
"description": "Request basic profile information",
"is_grantable": true
},
{
"scope": "profile",
"description": "Request basic profile information",
"is_grantable": true
},
{
"scope": "email",
"description": "Request email address",
"is_grantable": true
},
{
"scope": "read:data",
"description": "Read user data",
"is_grantable": true
}
]
}