Which sign-in methods the web app can offer
const url = 'https://example.com/v1/auth/config';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/auth/configResponses
Section titled “Responses”Sign-in configuration
object
Browser sign-in through an identity provider is configured
Providers the sign-in page may offer directly, e.g. github (pass as ?provider= to /v1/auth/login)
Invites may ask for a password account (password_account)
Base URL of the product documentation for the web app’s Help links, e.g. https://docs.affectra.eu (AFFECTRA_DOCS_URL). Absent: no Help links
The audience GitHub Actions tokens must carry for trusted publishing (AFFECTRA_GITHUB_ACTIONS_AUDIENCE): the url to pass to affectra/upload-sbom. Absent: trusted publishing is off
Example generated
{ "oidc": true, "providers": [ "example" ], "password_accounts": true, "docs_url": "https://example.com", "github_actions_audience": "example"}Over the operation’s rate-limit budget (x-affectra-budget): code request.rateLimited with params.budget. Wait Retry-After seconds before trying again.
Every error answer, Content-Type
application/problem+json. The web app and integrations translate code; detail is English,
for people reading curl output or CI logs, and may change wording at
any time. Match on code, never on detail.
object
The HTTP status
Stable error codes. A code is never renamed; new ones may be added, so
a client falls back to detail for a code it doesn’t know. Another
organization’s object answers notFound, the same as a missing one.
What went wrong
Values the code’s message needs, e.g. {“field”: “version”}. Only values the caller sent or may see. Empty when the message needs none.
object
Example
{ "code": "notFound"}Headers
Section titled “Headers”Seconds until a request would be allowed again, at least 1