# List the sign-in methods offered on a hosted sign-in screen

Returns the methods the app's client offers for the requested screen (login, register, forgot or reset password), narrowed during a re-confirmation to the...

`GET /api/v1/auth/supported-methods`

- Sign-in: No credential. Name the organization with the hosted sign-in state header or the org query parameter.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Returns the methods the app's client offers for the requested screen (login, register, forgot or reset password), narrowed during a re-confirmation to the ways the account has, plus any sign-up notice and the intent of the sign-in (re-confirmation or device). The register screen returns no methods when sign-up is closed.

## Request

| Field             | Type   | Required | Constraints                                                             | Description |
| ----------------- | ------ | -------- | ----------------------------------------------------------------------- | ----------- |
| `invitationToken` | string | No       | at most 64 characters                                                   | -           |
| `screen`          | string | Yes      | one of `"login"`, `"register"`, `"forgot-password"`, `"reset-password"` | -           |

## Example request

Replace each `YOUR_...` value with your own.

```bash title="cURL"
curl -X GET "https://api.console.buildbase.app/api/v1/auth/supported-methods?screen=login&org=YOUR_ORG_ID"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/supported-methods?screen=login&org=YOUR_ORG_ID',
  {
    method: 'GET',
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/auth/supported-methods?screen=login&org=YOUR_ORG_ID",
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "data": [
    {
      "description": "Sign in with email and password",
      "formDetails": {
        "button": {
          "title": "Sign in"
        },
        "clientRedirectUrl": "",
        "fields": [
          {
            "id": "email",
            "name": "Email",
            "placeholder": "user@example.com",
            "required": true,
            "type": "email"
          },
          {
            "id": "password",
            "name": "Password",
            "placeholder": "",
            "required": true,
            "type": "password"
          }
        ],
        "links": [
          {
            "href": "/v1/auth/forgot-password",
            "title": "Forgot password?"
          }
        ]
      },
      "icon": "",
      "id": "password",
      "name": "Password",
      "type": "form",
      "url": "http://localhost:3000/api/v1/auth/login",
      "validScreens": ["login"]
    },
    {
      "description": "Login with GitHub",
      "icon": "http://localhost:3000/api/images/auth/github.svg",
      "id": "github",
      "name": "GitHub",
      "type": "button",
      "url": "http://localhost:3000/api/v1/auth/social/github/000000000000000000000001/EHuYtkRaAmaMqH8UVC6w",
      "validScreens": ["login", "register"]
    },
    {
      "description": "Login with Google",
      "icon": "http://localhost:3000/api/images/auth/google.svg",
      "id": "google",
      "name": "Google",
      "type": "button",
      "url": "http://localhost:3000/api/v1/auth/social/google/000000000000000000000001/fTPHpsqAUeCCsW3axU7v",
      "validScreens": ["login", "register"]
    },
    {
      "description": "Sign in with a passkey",
      "icon": "",
      "id": "passkey",
      "name": "Passkey",
      "type": "passkey",
      "url": "http://localhost:3000/api/v1/auth/passkey",
      "validScreens": ["login"]
    },
    {
      "description": "Login with magic link",
      "formDetails": {
        "button": {
          "title": "Send Magic Link"
        },
        "clientRedirectUrl": "/v1/auth/check-email-for-magic-link",
        "delivery": "link",
        "fields": [
          {
            "id": "email",
            "name": "Email",
            "placeholder": "user@example.com",
            "required": true,
            "type": "email"
          }
        ]
      },
      "icon": "",
      "id": "magic-link",
      "name": "Magic Link",
      "type": "form",
      "url": "http://localhost:3000/api/v1/auth/magic-link",
      "validScreens": ["login"]
    },
    {
      "description": "Sign in with a code sent to your phone",
      "formDetails": {
        "button": {
          "title": "Continue"
        },
        "channels": ["sms", "whatsapp", "voice"],
        "clientRedirectUrl": "",
        "defaultCountry": "US",
        "fields": []
      },
      "icon": "",
      "id": "phone",
      "name": "Phone",
      "type": "phone",
      "url": "http://localhost:3000/api/v1/auth/phone",
      "validScreens": ["login", "register"]
    },
    {
      "description": "Sign in with a crypto wallet",
      "formDetails": {
        "button": {
          "title": "Continue with a wallet"
        },
        "clientRedirectUrl": "",
        "ethereumChainIds": [1, 137],
        "fields": [],
        "solana": true
      },
      "icon": "",
      "id": "wallet",
      "name": "Wallet",
      "type": "wallet",
      "url": "http://localhost:3000/api/v1/auth/wallet",
      "validScreens": ["login", "register"]
    },
    {
      "description": "Continue without an account",
      "formDetails": {
        "button": {
          "title": "Continue as guest"
        },
        "clientRedirectUrl": "",
        "fields": []
      },
      "icon": "",
      "id": "guest",
      "name": "Guest",
      "type": "guest",
      "url": "http://localhost:3000/api/v1/auth/guest",
      "validScreens": ["login"]
    }
  ],
  "success": true
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Auth guide](/authentication/overview): how this part of BuildBase works
- [All Auth operations](/http-api/reference/auth)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `auth.supportedMethods.list` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
