Docs: Add admin secret info to authentication, queries, mutations, subscriptions section

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5396
GitOrigin-RevId: 05f6a8156ba5dc5e23edd4b9df71c08e929f38ca
This commit is contained in:
Sean Park-Ross 2022-08-11 15:09:58 +02:00 committed by hasura-bot
parent 6c88b96b21
commit a94ae64e35
4 changed files with 26 additions and 0 deletions

View File

@ -25,6 +25,9 @@ like `X-Hasura-User-Id`, to build permission rules.
You can also configure Hasura to allow access to unauthenticated users by configuring a specific role which will be set
for all unauthenticated requests.
For information about making requests using the Admin Secret header please
[see here](/auth/authentication/index.mdx#admin-secret-header).
## Authentication options
Hasura supports two modes of authentication configuration:
@ -59,3 +62,12 @@ Enterprise Grade Authorization -
[Watch Webinar](https://hasura.io/events/webinar/authorization-modeling-hasura/?pg=docs&plcmt=body&cta=watch-webinar&tech=).
:::
## Using the Admin Secret header {#admin-secret-header}
Hasura will allow all queries, mutations and subscriptions when you include your `X-Hasura-Admin-Secret` header on
your request. If you also include the `X-Hasura-User-Id` and `X-Hasura-Role` headers along with the
`X-Hasura-Admin-Secret` header you can "pretend" to be that user and role.
Without the `X-Hasura-Admin-Secret` header you will need to authenticate your requests as a user and role with one
of the options below.

View File

@ -19,6 +19,11 @@ Data of all tables in the database tracked by the GraphQL engine can be modified
a tracked table in your database, its insert/update/delete mutation fields are added as nested fields under the
`mutation_root` root level type.
## Authentication
For information about authenticating your mutations see the [authentication section](/auth/authentication/index.mdx)
here.
## Explore mutations
- [Explore mutations with Postgres / Citus / Hyperscale](/mutations/postgres/index.mdx)

View File

@ -19,6 +19,10 @@ generates a range of possible queries and operators that also work with relation
All tables of the database tracked by the GraphQL engine can be queried over the GraphQL endpoint. If you have a tracked
table in your database, its query field is added as a nested field under the `query_root` root level type.
## Authentication
For information about authenticating your queries see the [authentication section](/auth/authentication/index.mdx) here.
## Explore queries
- [Explore queries with Postgres / Citus / Hyperscale](/queries/postgres/index.mdx)

View File

@ -24,6 +24,11 @@ for only one root field in a subscription.
:::
## Authentication
For information about authenticating your subscriptions see the [authentication section](/auth/authentication/index.mdx)
here.
## Explore subscriptions
- [Explore subscriptions with Postgres / Citus / Hyperscale](/subscriptions/postgres/index.mdx)