graphql-engine/docs/graphql/manual/auth/index.rst

47 lines
1.9 KiB
ReStructuredText
Raw Normal View History

.. meta::
:description: Manage GraphQL Authentication and Authorization with Hasura
:keywords: hasura, docs, authentication, auth, authorization
.. _auth:
Authentication & Authorization
==============================
.. contents:: Table of contents
:backlinks: none
:depth: 1
:local:
2019-05-17 15:03:35 +03:00
In Hasura, access control or authorization is based on **roles**. Let's take a look at how this works
2019-09-11 10:17:14 +03:00
when the GraphQL engine receives a request:
2019-05-17 15:03:35 +03:00
.. thumbnail:: ../../../img/graphql/manual/auth/auth-high-level-overview.png
:alt: Authentication and authorization with Hasura
2019-05-17 15:03:35 +03:00
As you can see from this:
2019-05-17 15:03:35 +03:00
- **Authentication** is handled outside Hasura. Hasura delegates authentication and resolution of request
headers into session variables to your authentication service *(existing or new)*.
2019-05-17 15:03:35 +03:00
Your authentication service is required to pass a user's **role** information in the form of session
variables like ``X-Hasura-Role``, etc. More often than not, you'll also need to pass user information
2019-09-11 10:17:14 +03:00
for your access control use cases, like ``X-Hasura-User-Id``, to build permission rules.
2019-01-15 13:49:58 +03:00
2019-05-17 15:03:35 +03:00
- For **Authorization** or **Access Control**, Hasura helps you define granular role-based access control
rules for every field in your GraphQL schema *(granular enough to control access to any row or
column in your database)*.
2019-05-17 15:03:35 +03:00
Hasura uses the role/user information in the session variables and the actual query itself to validate
2019-09-11 10:17:14 +03:00
the query against the rules defined by you. If the query/operation is allowed, it generates an SQL
2019-05-17 15:03:35 +03:00
query, which includes the row/column-level constraints from the access control rules, and sends it to
the database to perform the required operation (*fetch the required rows for queries, insert/edit
rows for mutations, etc.*).
2019-05-17 15:03:35 +03:00
**See more details about setting up authentication and access control at:**
.. toctree::
2019-05-17 15:03:35 +03:00
:maxdepth: 1
authentication/index
authorization/index