Merge pull request #16556 from supabase/j0/id_token_docs

chore: add docs for sign in with id token
This commit is contained in:
Joel Lee authored and GitHub committed 2023-08-16 11:14:20 +02:00
commit 9acd166aef
20 files changed
+78868 -73725

No files matched your search

+742 -429
View File
File diff suppressed because it is too large. Load diff
+2 -2
View File
@@ -260,7 +260,7 @@ parameters:
links:
- name: 'Auth Server configuration'
link: 'https://supabase.com/docs/reference/auth'
- id: 'auth.email.template.type.subject'
title: 'auth.email.template.<type>.subject'
tags: ['auth']
@@ -276,7 +276,7 @@ parameters:
links:
- name: 'Auth Server configuration'
link: 'https://supabase.com/docs/reference/auth'
- id: 'auth.email.template.type.content_path'
title: 'auth.email.template.<type>.content_path'
tags: ['auth']
+7
View File
@@ -415,6 +415,13 @@
"product": "auth",
"type": "function"
},
{
"id": "sign-in-with-id-token",
"title": "Sign in with ID Token",
"slug": "auth-signinwithidtoken",
"product": "auth",
"type": "function"
},
{
"id": "sign-in-with-otp",
"title": "Sign in a user through OTP",
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
@@ -187,10 +187,7 @@
{
"title": "Properties",
"kind": 1024,
"children": [
8,
7
]
"children": [8, 7]
}
]
}
@@ -624,11 +621,7 @@
{
"title": "Properties",
"kind": 1024,
"children": [
35,
30,
34
]
"children": [35, 30, 34]
}
],
"sources": [
@@ -719,26 +712,17 @@
{
"title": "Constructors",
"kind": 512,
"children": [
2
]
"children": [2]
},
{
"title": "Properties",
"kind": 1024,
"children": [
15,
14,
13
]
"children": [15, 14, 13]
},
{
"title": "Methods",
"kind": 2048,
"children": [
23,
20
]
"children": [23, 20]
}
],
"sources": [
@@ -853,16 +837,12 @@
{
"title": "Constructors",
"kind": 512,
"children": [
37
]
"children": [37]
},
{
"title": "Properties",
"kind": 1024,
"children": [
42
]
"children": [42]
}
],
"sources": [
@@ -984,16 +964,12 @@
{
"title": "Constructors",
"kind": 512,
"children": [
44
]
"children": [44]
},
{
"title": "Properties",
"kind": 1024,
"children": [
47
]
"children": [47]
}
],
"sources": [
@@ -1097,16 +1073,12 @@
{
"title": "Constructors",
"kind": 512,
"children": [
49
]
"children": [49]
},
{
"title": "Properties",
"kind": 1024,
"children": [
52
]
"children": [52]
}
],
"sources": [
@@ -1210,16 +1182,12 @@
{
"title": "Constructors",
"kind": 512,
"children": [
54
]
"children": [54]
},
{
"title": "Properties",
"kind": 1024,
"children": [
57
]
"children": [57]
}
],
"sources": [
@@ -1449,11 +1417,7 @@
{
"title": "Properties",
"kind": 1024,
"children": [
35,
30,
34
]
"children": [35, 30, 34]
}
],
"sources": [
@@ -1490,10 +1454,7 @@
],
"type": {
"type": "union",
"types": [
null,
null
]
"types": [null, null]
}
}
],
@@ -1501,21 +1462,12 @@
{
"title": "Classes",
"kind": 128,
"children": [
1,
36,
43,
48,
53
]
"children": [1, 36, 43, 48, 53]
},
{
"title": "Type Aliases",
"kind": 4194304,
"children": [
28,
58
]
"children": [28, 58]
}
],
"sources": [
@@ -1525,4 +1477,4 @@
"character": 0
}
]
}
}
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
+3 -1
View File
@@ -680,6 +680,7 @@
"name": { "type": "string" },
"bucket_id": { "type": "string" },
"owner": { "type": "string" },
"owner_id": { "type": "string" },
"version": { "type": "string" },
"id": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
"updated_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
@@ -1090,7 +1091,7 @@
"Either the object does not exist or you do not have access to it"
]
},
"version": { "type": "string", "examples": ["folder/cat.png"] },
"path": { "type": "string", "examples": ["folder/cat.png"] },
"signedURL": {
"type": ["null", "string"],
"examples": [
@@ -1227,6 +1228,7 @@
"name": { "type": "string" },
"bucket_id": { "type": "string" },
"owner": { "type": "string" },
"owner_id": { "type": "string" },
"version": { "type": "string" },
"id": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
"updated_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
+13
View File
@@ -339,6 +339,19 @@ functions:
})
const oAuthToken = data.session.provider_token // use to access provider API
```
- id: sign-in-with-id-token
title: 'signInWithIdToken'
$ref: '@supabase/gotrue-js.GoTrueClient.signInWithIdToken'
examples:
- id: sign-in-with-id-token
name: 'Sign In using ID Token'
code: |
```js
const { data, error } = await supabase.auth.signInWithIdToken({
provider: 'google',
token: 'your-id-token'
})
```
- id: sign-in-with-sso
title: 'signInWithSSO()'
$ref: '@supabase/gotrue-js.GoTrueClient.signInWithSSO'
File diff suppressed because it is too large. Load diff
@@ -1027,6 +1027,9 @@
"owner": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"version": {
"type": "string"
},
@@ -1665,7 +1668,7 @@
"Either the object does not exist or you do not have access to it"
]
},
"version": {
"path": {
"type": "string",
"examples": ["folder/cat.png"]
},
@@ -1882,6 +1885,9 @@
"owner": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"version": {
"type": "string"
},