Skip to content

Commit

Permalink
Apply grammar/formatting suggestions
Browse files Browse the repository at this point in the history
Co-authored-by: Andy Pai <[email protected]>
  • Loading branch information
spwitt and andrewpai authored Dec 26, 2024
1 parent 1f59d93 commit 1381c62
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Once you have completed this configuration you will be able to log in to FusionA

## Create a SAML v2 IdP Initiated Identity Provider

To create an Identity Provider navigate to **Settings -> Identity Providers** and click **Add provider** and select **SAML v2 IdP Initiated**.
To create an Identity Provider navigate to **Settings -> Identity Providers**, click **Add provider**, and select **SAML v2 IdP Initiated**.

Check failure on line 52 in astro/src/content/docs/lifecycle/authenticate-users/identity-providers/enterprise/samlv2-idp-initiated.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'idp|IDP' instead of 'IdP'. Raw Output: {"message": "[Vale.Terms] Use 'idp|IDP' instead of 'IdP'.", "location": {"path": "astro/src/content/docs/lifecycle/authenticate-users/identity-providers/enterprise/samlv2-idp-initiated.mdx", "range": {"start": {"line": 52, "column": 125}}}, "severity": "ERROR"}

This will take you to the **Add SAML v2 IdP Initiated** panel. Here you will need to fill out the required fields.

Check failure on line 54 in astro/src/content/docs/lifecycle/authenticate-users/identity-providers/enterprise/samlv2-idp-initiated.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'idp|IDP' instead of 'IdP'. Raw Output: {"message": "[Vale.Terms] Use 'idp|IDP' instead of 'IdP'.", "location": {"path": "astro/src/content/docs/lifecycle/authenticate-users/identity-providers/enterprise/samlv2-idp-initiated.mdx", "range": {"start": {"line": 54, "column": 41}}}, "severity": "ERROR"}

Expand All @@ -74,15 +74,15 @@ This will take you to the **Add SAML v2 IdP Initiated** panel. Here you will nee
The public key or certificate that you must import into FusionAuth's KeyMaster. This is the public key provided to you by the identity provider.
</APIField>
<APIField name="Linking strategy" optional since="1.28.0">
The linking strategy for the SAML v2 identity provider. [See Linking Strategies for more](/docs/lifecycle/authenticate-users/identity-providers/#linking-strategies).
The linking strategy for the SAML v2 identity provider. See [Linking Strategies](/docs/lifecycle/authenticate-users/identity-providers/#linking-strategies) for more information.
</APIField>
<APIField name="Reconcile lambda" optional>
A lambda maps custom claims returned from the SAML response into the FusionAuth `User` and `Registration`. To learn more about creating a lambda, view the [SAML v2 Reconcile lambda documentation](/docs/extend/code/lambdas/samlv2-response-reconcile).

To configure a lambda, navigate to **Settings -> Lambdas**.
</APIField>
<APIField name="Debug enabled" optional>
Some identity providers are not compliant with the SAML and XML signing specifications. This makes it challenging to get them working with FusionAuth.
Some identity providers are not compliant with the SAML and XML signing specifications. This can make it challenging to integrate with them.

If you are running into integration issues, toggle this setting on and FusionAuth will output debugging information into the Event Log during a SAML login. You can find the event log in **System -> Event Log**.
</APIField>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Once you have completed this configuration you will be able to enable the SAML v

## Create a SAML v2 Identity Provider

To create an Identity Provider navigate to **Settings -> Identity Providers** and click `Add provider` and select `SAML v2` from the dialog.
To create an Identity Provider navigate to **Settings -> Identity Providers**, click `Add provider`, and select `SAML v2` from the dialog.

This will take you to the `Add SAML v2` screen. Here you will need to fill out the required fields. If you do not know the IdP endpoint of your SAML v2 provider, you will need to contact the identity provider owner to get the URL.

Expand Down Expand Up @@ -92,7 +92,7 @@ This will take you to the `Add SAML v2` screen. Here you will need to fill out t
<APIField name="Reconcile lambda" optional>
A lambda maps custom claims returned from the SAML Response to the FusionAuth User or Registration.

To create or configure a lambda, navigate to **Settings -> Lambdas**. [See the lambda documentation for more](/docs/extend/code/lambdas/).
To create or configure a lambda, navigate to **Settings -> Lambdas**. See the [lambda documentation](/docs/extend/code/lambdas/) for more information on using lambdas.
</APIField>
<APIField name="Debug enabled" optional defaults="false">
Some identity providers are not compliant with the SAML and XML signing specifications. This makes it challenging to get them working with FusionAuth.
Expand Down Expand Up @@ -129,7 +129,7 @@ This will take you to the `Add SAML v2` screen. Here you will need to fill out t
When enabled authentication requests sent to the Identity Provider will be signed.
</APIField>
<APIField name="Request signing key" optional>
The key used to sign the SAML request. Required when <InlineField>Sign request</InlineField> is enabled. To create, manage or import a key, navigate to **Settings -> Key Master**.
The key used to sign the SAML request. Required when <InlineField>Sign request</InlineField> is enabled. To create, manage, or import a key, navigate to **Settings -> Key Master**.
</APIField>
<APIField name="Canonicalization method" optional>
The XML signature canonicalization method used when digesting and signing the SAML request. Required when <InlineField>Use POST method</InlineField> and <InlineField>Sign request</InlineField> are enabled.
Expand Down

0 comments on commit 1381c62

Please sign in to comment.