From 57b91eb128aceb4a0c04acdef6cc1b5efced10af Mon Sep 17 00:00:00 2001 From: tigattack <10629864+tigattack@users.noreply.github.com> Date: Fri, 5 Jun 2020 15:51:21 +0100 Subject: [PATCH] docs(terminology.md): grammar and clarity Improved grammar and clarified some points. --- docs/terminology.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/terminology.md b/docs/terminology.md index 1b345e079..db3e72947 100644 --- a/docs/terminology.md +++ b/docs/terminology.md @@ -1,27 +1,27 @@ ### Policy -A Policy is at a base level a yes/no gate. It will either evaluate to True or False depending on the Policy Kind and settings. For example, a "Group Membership Policy" evaluates to True if the User is member of the specified Group and False if not. This can be used to conditionally apply Stages, grant/deny access to various objects and is also used for other custom logic. +At a base level a policy is a yes/no gate. It will either evaluate to True or False depending on the Policy Kind and settings. For example, a "Group Membership Policy" evaluates to True if the user is member of the specified Group and False if not. This can be used to conditionally apply Stages, grant/deny access to various objects, and for other custom logic. ### Provider -A Provider is a way for other Applications to authenticate against passbook. Common Providers are OpenID Connect (OIDC) and SAML. +A Provider is a way for other applications to authenticate against passbook. Common Providers are OpenID Connect (OIDC) and SAML. ### Source -Sources are ways to get users into passbook. This might be an LDAP Connection to import Users from Active Directory, or an OAuth2 Connection to allow Social Logins. +Sources are locations from which users can be added to passbook. For example, an LDAP Connection to import Users from Active Directory, or an OAuth2 Connection to allow Social Logins. ### Application An application links together Policies with a Provider, allowing you to control access. It also holds Information like UI Name, Icon and more. -### Flows - -Flows are a method of describing a sequence of stages. These flows can be used to defined how a user authenticates, enrolls, etc. - ### Stages -A stage represents a single verification or logic step. They are used to authenticate users, enroll them, and more. These stages can optionally be applied to a flow via policies. +A stage represents a single verification or logic step. They are used to authenticate users, enroll users, and more. These stages can optionally be applied to a flow via policies. + +### Flows + +Flows are an ordered sequence of stages. These flows can be used to define how a user authenticates, enrolls, etc. ### Property Mappings -Property Mappings allow you to make Information available for external Applications. For example, if you want to login to AWS with passbook, you'd use Property Mappings to set the User's Roles based on their Groups. +Property Mappings allow you to make information available for external applications. For example, if you want to login to AWS with passbook, you'd use Property Mappings to set the user's roles in AWS based on their group memberships in passbook.