Begins an OAuth/OIDC sign-in attempt with the named provider and
redirects the browser to that provider's consent screen. An unknown
or disabled provider name reports the same not-found response as any
other absent resource.
Path Parameters
providerRequired
string
Identity provider name.
Values
googlegithubapple
Query Parameters
return_to
string·max 4096
Local browser path to resume after provider sign-in. Accepts /oauth/authorize with a query string, token-free /invitations/accept, or /app/ Workspace paths including query and fragment. External URLs and unapproved paths are ignored.
Pass false to decline "Remember this device": the session issued when the provider callback completes is a browser-session cookie bounded to 48 hours (idle and absolute). Any other value, or omitting it, issues the persistent session.
Responses
Location
string <uri>
The provider's authorization URL.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Retry-After
integer·min 0
Delay in seconds before retrying, when an expected maintenance end is known.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
