> ## Documentation Index
> Fetch the complete documentation index at: https://nocode-docs.zeroagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# General API Information

The Zeromagic Auth API Reference allows to create and manage users using `REST API`. These apis are great place to start if you want to build authentication system for your application. You can start consuming to the pre-built endpoints from your client application. We support both Basic and Social authentication methods.

## Get Started with Base URL

The authentication has separate url which can be found in the `Environments` section in the dashboard. The base url can be found in the name of `Auth URL` under Environments. To make an api call to the below authentication endpoint, the **URI** is in the format or

```jsx theme={null}
{base_auth_url}/{authentication_endpoint}
```

For example, if

```jsx theme={null}
https://authn.zeromagic.cloud/auth/353d1499ab5149e194a53cf0f6c837f4/development/
```

is your authentication base url and you have to make a request to `/email-password-signup` endpoint, then your uri will be

```jsx theme={null}
https://authn.zeromagic.cloud/auth/353d1499ab5149e194a53cf0f6c837f4/development/email-password-signup
```

<Note>
  **Environments** are required for making an api call. When you make an api call to the url mentioned in the environments, the database operations is performed over the **Database binded to the Environment**.
</Note>

## 1. Basic Authentication - Available APIs

### Email with password API

| API         | Path                                                                                    |
| ----------- | --------------------------------------------------------------------------------------- |
| Sign-up     | [/email-password-signup](/authentication/api/basicauth/emailpassword#sign-up)           |
| Login       | [/email-password-login](/authentication/api/basicauth/emailpassword#login-api)          |
| Reset       | [/email-password-reset](/authentication/api/basicauth/emailpassword#password-reset-api) |

### Mobile number with otp API

| API          | Path                                                                        |
| ------------ | --------------------------------------------------------------------------- |
| Sign-up      | [/mobile-otp-signup](/authentication/api/basicauth/phoneotp#signup-api)     |
| Login        | [/mobile-otp-login](/authentication/api/basicauth/phoneotp#login-api)       |
| Verify OTP   | [/mobile-otp-verify](/authentication/api/basicauth/phoneotp#verify-otp-api) |

### Username with password API

| API         | Path                                                                               |
| ----------- | ---------------------------------------------------------------------------------- |
| Sign-up     | [/username-password-signup](/authentication/api/basicauth/usernamepass#signup-api) |
| Login       | [/username-password-login](/authentication/api/basicauth/usernamepass#login-api)   |

### Email with otp API

| API          | Path                                                                       |
| ------------ | -------------------------------------------------------------------------- |
| Sign-up      | [/email-otp-signup](/authentication/api/basicauth/emailotp#signup-api)     |
| Login        | [/email-otp-login](/authentication/api/basicauth/emailotp#login-api)       |
| Verify OTP   | [/email-otp-verify](/authentication/api/basicauth/emailotp#verify-otp-api) |

## 2. Social Authentication - Available APIs

The endpoint `/oauth` is common for all social authentication methods

| API         | Path                                           |
| ----------- | ---------------------------------------------- |
| OAuth       | [/oauth](/authentication/api/socialconnection) |

### Support Social Providers

To know about the supported social providers, visit here - [Supported Social Providers](/authentication/methods/social#supported-social-providers)