@lowdefy/docs 4.0.0-alpha.7 → 4.0.0-alpha.8

package/users/user-object.yaml

@@ -1,73 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: user-object
-    pageTitle: User object
-    section: User Authentication
-    filePath: concepts/user-object.yaml
-    content:
-      - id: introduction
-        type: MarkdownWithCode
-        properties:
-          content: |
-            The `user` object contains all the claims on the OpenID Connect idToken, except for `aud`, `exp`, `iat`, and `iss`.
-
-            The following claims might be included:
-            - `sub`: The user id (Subject).
-            - `email`
-            - `name`
-            - `given_name`
-            - `family_name`
-            - `picture`: A url to the user's profile picture.
-            - `updated_at`
-            - `email_verified`
-
-            The user object can be accessed using the [`_user`](/_user) operator.
-
-            #### Examples
-
-            ###### Use the user profile picture in a Avatar block:
-            ```yaml
-            id: avatar
-            type: Avatar
-            properties:
-              src:
-                _user: picture
-            ````
-
-            ###### Insert user name and id (sub) when inserting a document in MongoDB:
-            ```yaml
-            id: insert_data
-            type: MongoDBInsertOne
-            properties:
-              doc:
-                field:
-                  _state: field
-                inserted_by:
-                  name:
-                    _user: name
-                  id:
-                    _user: sub
-            ````
-
-      - _ref:
-          path: templates/navigation_buttons.yaml
-          vars:
-            previous_page_title: Protected pages
-            previous_page_id: protected-pages
-            next_page_title: Roles
-            next_page_id: roles

package/users/users-introduction.yaml

@@ -1,80 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: users-introduction
-    pageTitle: Introduction
-    section: User Authentication
-    filePath: concepts/users-introduction.yaml
-    content:
-      - id: introduction
-        type: Markdown
-        properties:
-          content: |
-            To add user authentication and authorization to a Lowdefy app, you need to do the following:
-            - Configure an OpenID Connect provider
-            - Configure which pages should be public and protected (only available to logged in users).
-            - Add the `Login` and `Logout` actions to your app, to allow users to log in and out.
-
-            Optionally, you can also:
-            - Use role based authorization to make certain pages available only to users with the correct roles.
-
-            An example app implementing OpenID Connect can be found [here](https://github.com/lowdefy/lowdefy-example-openid-connect).
-
-      - id: jwt_session_warning
-        type: Alert
-        properties:
-          type: warning
-          icon: AiFilledWarning
-          message: Stateful JSON Web Tokens are used for authentication
-          description: Lowdefy uses stateful JSON Web Tokens for user authentication, since the Lowdefy server is stateless and does not maintain a database of user sessions. This means that once a token is issued, it is valid until the token expires. Any changes to the user's access will only reflect after the token has expired, and the user obtains (or fails to obtain) a new token from the OpenID Connect provider. We recommend making sure tokens have a relatively short expiry time (the default is 4 hours), and evaluating if the security provided by this system is appropriate for your use case.
-
-      - id: auth_config
-        type: MarkdownWithCode
-        properties:
-          content: |
-            Most authorization and authentication settings are configured in the `config.auth` object in the Lowdefy configuration. The following config can be set:
-            ```yaml
-            lowdefy: 3.23.2
-            config:
-              auth:
-                openId:
-                  # The url the user should be redirected to after logout.
-                  logoutRedirectUri: [string]
-                  # Field in the user idToken that contains the roles array.
-                  rolesField: [string]
-                  # The OpenID Connect scope to request. The default is 'openid profile email'.
-                  scope: [string]
-                jwt:
-                  # The length of time a user token should be valid.
-                  expiresIn: [string | number]
-                pages:
-                  # Either set all pages as protected, or list specific protected pages.
-                  protected: [boolean | string[]]
-                  # Either set all pages as public, or list specific public pages.
-                  public: [boolean | string[]]
-                roles:
-                  # Restrict pages to only users with a certain role.
-                  {roleName}: string[]
-            ```
-
-      - _ref:
-          path: templates/navigation_buttons.yaml
-          vars:
-            previous_page_title: Overview
-            previous_page_id: overview
-            next_page_title: OpenID Connect
-            next_page_id: openid-connect

package/version.yaml

@@ -1 +0,0 @@
-v4.0.0-alpha.0