docs(providers.md): grammar and clarity

This commit is contained in:
tigattack 2020-06-18 18:55:01 +01:00 committed by GitHub
parent cf9023269e
commit 1cbaf865d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,17 +1,17 @@
# Providers # Providers
Providers allow external Applications to authenticate against passbook and use its User Information. Providers allow external applications to authenticate against passbook and use its user information.
## OpenID Provider ## OpenID Provider
This provider uses the commonly used OpenID Connect variation of OAuth2. This provider utilises the commonly used OpenID Connect variation of OAuth2.
## OAuth2 Provider ## OAuth2 Provider
This provider is slightly different than the OpenID Provider. While it uses the same basic OAuth2 Protocol, it provides a GitHub-compatible Endpoint. This allows you to integrate Applications, which don't support Custom OpenID Providers. This provider is slightly different than the OpenID Provider. While it uses the same basic OAuth2 Protocol, it provides a GitHub-compatible endpoint. This allows you to integrate applications which don't support custom OpenID providers.
The API exposes Username, E-Mail, Name and Groups in a GitHub-compatible format. The API exposes username, email, name, and groups in a GitHub-compatible format.
## SAML Provider ## SAML Provider
This provider allows you to integrate Enterprise Software using the SAML2 Protocol. It supports signed Requests. This Provider uses [Property Mappings](property-mappings/index.md#saml-property-mapping) to determine which fields are exposed and what values they return. This makes it possible to expose Vendor-specific Fields. This provider allows you to integrate enterprise software using the SAML2 Protocol. It supports signed requests and uses [Property Mappings](property-mappings/index.md#saml-property-mapping) to determine which fields are exposed and what values they return. This makes it possible to expose vendor-specific fields.
Default fields are exposed through Auto-generated Property Mappings, which are prefixed with "Autogenerated..." Default fields are exposed through auto-generated Property Mappings, which are prefixed with "Autogenerated".