# Nile Auth API

**Canonical:** https://apis.io/apis/thenile/thenile-auth-api/  
**Provider:** Nile — https://apis.io/providers/thenile/  
**Base URL:** https://global.thenile.dev  
**Documentation:** https://www.thenile.dev/docs/api-reference/post-oauth2token

Nile Auth API is one of 10 APIs that [Nile](https://apis.io/providers/thenile/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 17 JSON Schema definitions. Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification and 17 JSON Schemas.

The auth API from Nile — 10 operation(s) for auth.

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| POST | `/v2/databases/{database}/auth/signin` | Sign in to the application |
| POST | `/v2/databases/{database}/auth/signout` | Sign out of the application |
| GET | `/v2/databases/{database}/auth/session` | Get the current session |
| GET | `/v2/databases/{database}/auth/csrf` | Get CSRF token |
| GET | `/v2/databases/{database}/auth/providers` | Get available providers |
| POST | `/v2/databases/{database}/auth/callback/{provider}` | Handle provider callback |
| POST | `/v2/databases/{database}/auth/session/token` | Refresh session token |
| PUT | `/v2/databases/{database}/auth/mfa` | Complete an MFA challenge |
| DELETE | `/v2/databases/{database}/auth/mfa` | Disable MFA for the current user |
| POST | `/v2/databases/{database}/auth/mfa` | Initiate MFA setup |
| POST | `/v2/databases/{database}/auth/reset-password` | Reset password |
| GET | `/v2/databases/{database}/auth/reset-password` | Retrieve password token |
| PUT | `/v2/databases/{database}/auth/reset-password` | Resets the password |
| GET | `/v2/databases/{database}/auth/verify-email` | Takes in an email verification token and ensures it is valid |
| POST | `/v2/databases/{database}/auth/verify-email` | Sends a verification email |

## Machine-readable artifacts (19)

- **OpenAPI** — https://artifacts.apis.io/thenile/openapi/thenile-auth-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-apierror-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-create-database-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-get-database-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-dedicated-compute-instance-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-unauthenticated-provision-database-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-workspace-usage-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-oidcprovider-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-user-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-tenant-ssoregistration-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-logical-database-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-oidcrelying-party-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-create-basic-user-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-mfa-setup-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-mfa-disable-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-tenant-user-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-mfa-verify-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/thenile/json-schema/thenile-mfa-verify-response-schema.json
- **APIsJSON** — https://artifacts.apis.io/thenile/apis.yml

## Other Nile APIs (9)

- [Nile Authentication API](https://apis.io/apis/thenile/thenile-authentication-api/)
- [Nile Compute API](https://apis.io/apis/thenile/thenile-compute-api/)
- [Nile Credentials API](https://apis.io/apis/thenile/thenile-credentials-api/)
- [Nile Databases API](https://apis.io/apis/thenile/thenile-databases-api/)
- [Nile Developers API](https://apis.io/apis/thenile/thenile-developers-api/)
- [Nile Internal API](https://apis.io/apis/thenile/thenile-internal-api/)
- [Nile Tenants API](https://apis.io/apis/thenile/thenile-tenants-api/)
- [Nile Users API](https://apis.io/apis/thenile/thenile-users-api/)
- [Nile Workspaces API](https://apis.io/apis/thenile/thenile-workspaces-api/)

## Tags

Authentication

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/thenile/thenile-auth-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/thenile/.