@tomato414941/foundation 0.5.1 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/guide.mjs +16 -2
- package/package.json +1 -1
package/guide.mjs
CHANGED
|
@@ -99,8 +99,22 @@ export function guide(connectors) {
|
|
|
99
99
|
'3. CONNECTING A SERVICE, so that Foundation may obtain credentials there itself. What renews them stays with the',
|
|
100
100
|
' grant, never in a value you can read. Connecting creates one grant, listed with the others.',
|
|
101
101
|
...connectorLines(connectors),
|
|
102
|
-
' POST /v1/requests {"kind":"connect", "input":{"connector":"<id>"
|
|
103
|
-
'
|
|
102
|
+
' POST /v1/requests {"kind":"connect", "input":{"connector":"<id>", "scopes":["<the service\'s scope>", ...]}, "purpose":"...",',
|
|
103
|
+
' "valid_minutes":30} Give the owner the verification_uri.',
|
|
104
|
+
' scopes are the service\'s own names for what the connection may do (see each connector\'s scopes.documentation_url).',
|
|
105
|
+
' Ask for what the work needs; the owner sees each one before agreeing, and decides. Foundation adds only the few',
|
|
106
|
+
' it needs to know who authorized (scopes.base). facts.missing_scopes lists any the service did not grant.',
|
|
107
|
+
' A connection is made through an OAuth app: Foundation\'s own for the service, or one the owner holds (or was lent).',
|
|
108
|
+
' GET /v1/holdings?kind=app the apps the owner may connect through, Foundation\'s included (foundation: true).',
|
|
109
|
+
' Add "app":"<app id>" inside input to connect through one; without it, Foundation\'s is used, or on reconnecting,',
|
|
110
|
+
' the app the connection was made through. With their own app the owner decides at the service which scopes can',
|
|
111
|
+
' be granted at all, and what name the consent screen shows.',
|
|
112
|
+
' POST /v1/requests {"kind":"app", "input":{"connector":"<id>"}, "purpose":"...", "steps":["..."]} asks the owner',
|
|
113
|
+
' to register one: they make it at the service (redirect URL <this server>/oauth/<connector id>/callback) and',
|
|
114
|
+
' type its client ID and secret on the page. result.app_id names it. You never see or handle its secret.',
|
|
115
|
+
' GET /v1/connectors says which connectors take apps (apps.fields: what registering one asks for).',
|
|
116
|
+
' To reconnect, add "connection_id":"<existing id>" inside input. This updates that connection and keeps its id,',
|
|
117
|
+
' its scopes (add more with scopes) and the app it was made through.',
|
|
104
118
|
' Without connection_id, authorization creates a separate connection, even for the same service user. List and use',
|
|
105
119
|
' an existing connection when no new authorization is needed. Provider consent and revocation may affect several connections.',
|
|
106
120
|
' A connector whose flow is "role" (aws.role) has the owner make a role for Foundation in their own console and',
|
package/package.json
CHANGED