From 722df8535fe8dbff3424dfe5c498ee104e64ba85 Mon Sep 17 00:00:00 2001 From: Joel Lee Date: Thu, 5 Dec 2024 00:00:22 +0800 Subject: [PATCH] fix: update CLI yaml to add session features and Auth Hooks (#30878) * fix: update hook to add sessions and hooks * fix: correct errors * fix: update defaults --- apps/docs/spec/cli_v1_config.yaml | 55 +++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/apps/docs/spec/cli_v1_config.yaml b/apps/docs/spec/cli_v1_config.yaml index d6c2cbb2d1a..2fbdd858fab 100644 --- a/apps/docs/spec/cli_v1_config.yaml +++ b/apps/docs/spec/cli_v1_config.yaml @@ -1142,6 +1142,39 @@ parameters: - name: 'Auth Server configuration' link: 'https://supabase.com/docs/reference/auth' + - id: 'auth.hook..enabled' + title: 'auth.hook..enabled' + tags: ['auth'] + required: false + default: 'false' + description: | + Enable Auth Hook. Possible values for `hook_name` are: `custom_access_token`, `send_sms`, `send_email`, `mfa_verification_attempt`, and `password_verification_attempt`. + links: + - name: 'Auth Hooks' + link: 'https://supabase.com/docs/guides/auth/auth-hooks' + + - id: 'auth.hook..uri' + title: 'auth.hook..uri' + tags: ['auth'] + required: false + default: '' + description: | + URI of hook to invoke. Should be a http or https function or Postgres function taking the form: `pg-functions:////`. For example, `pg-functions://postgres/auth/custom-access-token-hook`. + links: + - name: 'Auth Hooks' + link: 'https://supabase.com/docs/guides/auth/auth-hooks' + + - id: 'auth.hook..secrets' + title: 'auth.hook..secrets' + tags: ['auth'] + required: false + default: '' + description: | + Configure when using a HTTP Hooks. Takes a list of base64 comma separated values to allow for secret rotation. Currently, Supabase Auth uses only the first value in the list. + links: + - name: 'Auth Hooks' + link: 'https://supabase.com/docs/guides/auth/auth-hooks?queryGroups=language&language=http' + - id: 'auth.mfa.totp.enroll_enabled' title: 'auth.mfa.totp.enroll_enabled' tags: ['auth'] @@ -1254,6 +1287,28 @@ parameters: - name: 'Auth Multi-Factor Authentication' link: 'https://supabase.com/docs/guides/auth/auth-mfa' + - id: 'auth.sessions.timebox' + title: 'auth.sessions.timebox' + tags: ['auth'] + required: false + default: '' + description: | + Force log out after the specified duration. Sample values include: '50m', '20h'. + links: + - name: 'Auth Sessions' + link: 'https://supabase.com/docs/guides/auth/sessions' + + - id: 'auth.sessions.inactivity_timeout' + title: 'auth.sessions.inactivity_timeout' + tags: ['auth'] + required: false + default: '' + description: | + Force log out if the user has been inactive longer than the specified duration. Sample values include: '50m', '20h'. + links: + - name: 'Auth Sessions' + link: 'https://supabase.com/docs/guides/auth/sessions' + - id: 'auth.third_party.aws_cognito.enabled' title: 'auth.third_party.aws_cognito.enabled' tags: ['auth']