Update Auth Section. DOC-2256 #835

seanparkross · 2025-01-06T13:46:48Z

Description 📝

DOC-2256

Reworks and restructures Auth Section.

Edited Basics section to direct users to the right place.
Adds a FAQ section
Mostly adheres to the plan. Deviates by keeping tutorials in their relevant sections.
Brings in relevant tutorials from recipes section.
Brought in and edited JWT configuration section from v2. Needs @hgiasac to go over it to make sure that it is still accurate for v3.
Not sure if x-hasura-role as a header in webhook mode is a thing. @hgiasac to please confirm.
Needs more examples in permissions. Not for this PR.

Quick Links 🚀

/auth

hasura-bot · 2025-01-06T13:47:07Z

Redirects 🔀

Hey, @robertjdominguez & @seanparkross — the following redirects will be needed for deployment:

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/_category_.json
location = /docs/3.0/auth/authentication/_category_.json {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/index/
location = /docs/3.0/auth/authentication/index/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/jwt/index/
location = /docs/3.0/auth/authentication/jwt/index/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/jwt/providers/
location = /docs/3.0/auth/authentication/jwt/providers/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/jwt/setup/
location = /docs/3.0/auth/authentication/jwt/setup/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/role-emulation/.wip
location = /docs/3.0/auth/authentication/role-emulation/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/webhook/index/
location = /docs/3.0/auth/authentication/webhook/index/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/_category_.json
location = /docs/3.0/auth/authorization/_category_.json {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/index/
location = /docs/3.0/auth/authorization/index/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/inherited-roles/.wip
location = /docs/3.0/auth/authorization/inherited-roles/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/_category_.json
location = /docs/3.0/auth/authorization/permissions/_category_.json {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/aggregation-permissions/.wip
location = /docs/3.0/auth/authorization/permissions/aggregation-permissions/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/backend-only/.wip
location = /docs/3.0/auth/authorization/permissions/backend-only/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/column-level-permissions/.wip
location = /docs/3.0/auth/authorization/permissions/column-level-permissions/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/column-presets/.wip
location = /docs/3.0/auth/authorization/permissions/column-presets/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/common-roles-auth-examples/.wip
location = /docs/3.0/auth/authorization/permissions/common-roles-auth-examples/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/disabling-root-fields/.wip
location = /docs/3.0/auth/authorization/permissions/disabling-root-fields/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/index/.wip
location = /docs/3.0/auth/authorization/permissions/index/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/permissions-operators/.wip
location = /docs/3.0/auth/authorization/permissions/permissions-operators/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/permissions-summary/.wip
location = /docs/3.0/auth/authorization/permissions/permissions-summary/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/row-fetch-limit/.wip
location = /docs/3.0/auth/authorization/permissions/row-fetch-limit/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/permissions/row-level-permissions/.wip
location = /docs/3.0/auth/authorization/permissions/row-level-permissions/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/quickstart/.wip
location = /docs/3.0/auth/authorization/quickstart/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authorization/roles-variables/.wip
location = /docs/3.0/auth/authorization/roles-variables/.wip {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/jwt/_category_.json
location = /docs/3.0/auth/authentication/jwt/_category_.json {
    return 301 https://$host/docs/3.0/auth/jwt/_category_.json;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authentication/1-auth0/
location = /docs/3.0/recipes/authentication/1-auth0/ {
    return 301 https://$host/docs/3.0/auth/jwt/tutorials/integrations/1-auth0/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authentication/2-aws-cognito/
location = /docs/3.0/recipes/authentication/2-aws-cognito/ {
    return 301 https://$host/docs/3.0/auth/jwt/tutorials/integrations/2-aws-cognito/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authentication/3-firebase/
location = /docs/3.0/recipes/authentication/3-firebase/ {
    return 301 https://$host/docs/3.0/auth/jwt/tutorials/integrations/3-firebase/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authentication/4-clerk/
location = /docs/3.0/recipes/authentication/4-clerk/ {
    return 301 https://$host/docs/3.0/auth/jwt/tutorials/integrations/4-clerk/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/jwt/setup-test-jwt/
location = /docs/3.0/auth/authentication/jwt/setup-test-jwt/ {
    return 301 https://$host/docs/3.0/auth/jwt/tutorials/setup-test-jwt/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authorization/1-simple-user-permissions/
location = /docs/3.0/recipes/authorization/1-simple-user-permissions/ {
    return 301 https://$host/docs/3.0/auth/permissions/tutorials/1-simple-user-permissions/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authorization/2-public-access-role/
location = /docs/3.0/recipes/authorization/2-public-access-role/ {
    return 301 https://$host/docs/3.0/auth/permissions/tutorials/2-public-access-role/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authorization/4-service-account/
location = /docs/3.0/recipes/authorization/4-service-account/ {
    return 301 https://$host/docs/3.0/auth/permissions/tutorials/4-service-account/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/webhook/_category_.json
location = /docs/3.0/auth/authentication/webhook/_category_.json {
    return 301 https://$host/docs/3.0/auth/webhook/_category_.json;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/webhook/special-roles/
location = /docs/3.0/auth/authentication/webhook/special-roles/ {
    return 301 https://$host/docs/3.0/auth/webhook/tutorials/special-roles/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/webhook/setup/
location = /docs/3.0/auth/authentication/webhook/setup/ {
    return 301 https://$host/docs/3.0/auth/webhook/webhook-mode/;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authentication/_category_.json
location = /docs/3.0/recipes/authentication/_category_.json {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authentication/index/
location = /docs/3.0/recipes/authentication/index/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authorization/_category_.json
location = /docs/3.0/recipes/authorization/_category_.json {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.hasura.io/docs/3.0/recipes/authorization/index/
location = /docs/3.0/recipes/authorization/index/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

hasura-bot · 2025-01-06T13:47:12Z

@seanparkross Thanks for your PR! I've assigned @robertjdominguez to review it.

cloudflare-workers-and-pages · 2025-01-06T13:48:47Z

Deploying ddn-docs with Cloudflare Pages

Latest commit:	`7d62ee2`
Status:	✅ Deploy successful!
Preview URL:	https://9e42a507.v3-docs-eny.pages.dev
Branch Preview URL:	https://sean-doc-2256-update-auth-se.v3-docs-eny.pages.dev

View logs

hasura-bot · 2025-01-07T13:24:31Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 46.4%, saving 215.58 KB.

Filename	Before	After	Improvement	Visual comparison
`static/img/auth/console-authorization-screen-noauth-mode.png`	464.95 KB	249.37 KB	-46.4%	View diff

212 images did not require optimisation.

…/ddn-docs into sean/doc-2256-update-auth-section

seanparkross added 4 commits January 3, 2025 18:54

wip

663ed54

wip

c5e461c

wip

cf4f309

wip

7030718

seanparkross self-assigned this Jan 6, 2025

hasura-bot requested a review from robertjdominguez January 6, 2025 13:47

seanparkross added 4 commits January 7, 2025 11:45

wip

bec93d0

wip

9f7da12

Merge branch 'main' into sean/doc-2256-update-auth-section

aa4602c

wip

d3a0753

hasura-bot and others added 12 commits January 7, 2025 18:54

Optimised images with calibre/image-actions

68be984

wip

2f36c5d

Merge branch 'sean/doc-2256-update-auth-section' of github.com:hasura…

4341d64

…/ddn-docs into sean/doc-2256-update-auth-section

wip

50099cb

wip

3bb2288

wip

143dd20

wip

5e3b20a

wip

93595c7

wip

628e914

wip

b396b45

wip

ec0a7dc

wip

9ce9201

seanparkross requested a review from hgiasac January 8, 2025 13:31

seanparkross marked this pull request as ready for review January 8, 2025 13:31

seanparkross added 2 commits January 8, 2025 13:39

wip

d1ae682

wip

546b5a1

seanparkross added 2 commits January 8, 2025 13:45

wip

5c6a363

wip

7d62ee2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Auth Section. DOC-2256 #835

Update Auth Section. DOC-2256 #835

seanparkross commented Jan 6, 2025 •

edited

Loading

hasura-bot commented Jan 6, 2025 •

edited

Loading

hasura-bot commented Jan 6, 2025

cloudflare-workers-and-pages bot commented Jan 6, 2025 •

edited

Loading

hasura-bot commented Jan 7, 2025

Update Auth Section. DOC-2256 #835

Are you sure you want to change the base?

Update Auth Section. DOC-2256 #835

Conversation

seanparkross commented Jan 6, 2025 • edited Loading

Description 📝

Quick Links 🚀

hasura-bot commented Jan 6, 2025 • edited Loading

Redirects 🔀

hasura-bot commented Jan 6, 2025

cloudflare-workers-and-pages bot commented Jan 6, 2025 • edited Loading

Deploying ddn-docs with Cloudflare Pages

hasura-bot commented Jan 7, 2025

seanparkross commented Jan 6, 2025 •

edited

Loading

hasura-bot commented Jan 6, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Jan 6, 2025 •

edited

Loading