From cf9023269eafadd972cbf127c46c4abca49ea939 Mon Sep 17 00:00:00 2001 From: tigattack <10629864+tigattack@users.noreply.github.com> Date: Thu, 18 Jun 2020 18:47:45 +0100 Subject: [PATCH] docs(sources.md): grammar and clarity --- docs/sources.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/sources.md b/docs/sources.md index 28c6e6bfd..d1ffab326 100644 --- a/docs/sources.md +++ b/docs/sources.md @@ -1,39 +1,39 @@ # Sources -Sources allow you to connect passbook to an existing User directory. They can also be used for Social-Login, using external Providers like Facebook, Twitter, etc. +Sources allow you to connect passbook to an existing user directory. They can also be used for social logins, using external providers such as Facebook, Twitter, etc. ## Generic OAuth Source **All Integration-specific Sources are documented in the Integrations Section** -This source allows users to enroll themselves with an External OAuth-based Identity Provider. The Generic Provider expects the Endpoint to return OpenID-Connect compatible Information. Vendor specific Implementations have their own OAuth Source. +This source allows users to enroll themselves with an external OAuth-based Identity Provider. The generic provider expects the endpoint to return OpenID-Connect compatible information. Vendor-specific implementations have their own OAuth Source. -- Policies: Allow/Forbid Users from linking their Accounts with this Provider -- Request Token URL: This field is used for OAuth v1 Implementations and will be provided by the Provider. -- Authorization URL: This value will be provided by the Provider. -- Access Token URL: This value will be provided by the Provider. -- Profile URL: This URL is called by passbook to retrieve User information upon successful authentication. -- Consumer key/Consumer secret: These values will be provided by the Provider. +- Policies: Allow/Forbid users from linking their accounts with this provider. +- Request Token URL: This field is used for OAuth v1 implementations and will be provided by the provider. +- Authorization URL: This value will be provided by the provider. +- Access Token URL: This value will be provided by the provider. +- Profile URL: This URL is called by passbook to retrieve user information upon successful authentication. +- Consumer key/Consumer secret: These values will be provided by the provider. ## SAML Source -This source allows passbook to act as a SAML Service Provider. Just like the SAML Provider, it supports signed Requests. Vendor specific documentation can be found in the Integrations Section +This source allows passbook to act as a SAML Service Provider. Just like the SAML Provider, it supports signed requests. Vendor-specific documentation can be found in the Integrations Section. ## LDAP Source -This source allows you to import Users and Groups from an LDAP Server +This source allows you to import users and groups from an LDAP Server. -- Server URI: URI to your LDAP Server/Domain Controller -- Bind CN: CN to bind as, this can also be a UPN in the format of `user@domain.tld` -- Bind password: Password used during the bind process -- Enable Start TLS: Enables StartTLS functionality. To use SSL instead, use port `636` -- Base DN: Base DN used for all LDAP queries -- Addition User DN: Prepended to Base DN for User-queries. -- Addition Group DN: Prepended to Base DN for Group-queries. -- User object filter: Consider Objects matching this filter to be Users. -- Group object filter: Consider Objects matching this filter to be Groups. -- User group membership field: Field which contains Groups of user. -- Object uniqueness field: Field which contains a unique Identifier. -- Sync groups: Enable/disable Group synchronization. Groups are synced in the background every 5 minutes. -- Sync parent group: Optionally set this Group as parent Group for all synced Groups (allows you to, for example, import AD Groups under a root `imported-from-ad` group.) -- Property mappings: Define which LDAP Properties map to which passbook Properties. The default set of Property Mappings is generated for Active Directory. See also [LDAP Property Mappings](property-mappings/index.md#ldap-property-mapping) +- Server URI: URI to your LDAP server/Domain Controller. +- Bind CN: CN of the bind user. This can also be a UPN in the format of `user@domain.tld`. +- Bind password: Password used during the bind process. +- Enable StartTLS: Enables StartTLS functionality. To use LDAPS instead, use port `636`. +- Base DN: Base DN used for all LDAP queries. +- Addition User DN: Prepended to the base DN for user queries. +- Addition Group DN: Prepended to the base DN for group queries. +- User object filter: Consider objects matching this filter to be users. +- Group object filter: Consider objects matching this filter to be groups. +- User group membership field: This field contains the user's group memberships. +- Object uniqueness field: This field contains a unique identifier. +- Sync groups: Enable/disable group synchronization. Groups are synced in the background every 5 minutes. +- Sync parent group: Optionally set this group as the parent group for all synced groups. An example use case of this would be to import Active Directory groups under a root `imported-from-ad` group. +- Property mappings: Define which LDAP properties map to which passbook properties. The default set of property mappings is generated for Active Directory. See also [LDAP Property Mappings](property-mappings/index.md#ldap-property-mapping)