Skip to content

Commit

Permalink
Merge pull request #510 from GSA-TTS/rk-LG-14519
Browse files Browse the repository at this point in the history
[LG 14519] Change Dev Docs language from Dashboard to Portal
  • Loading branch information
rahul-kamarouthu authored Nov 13, 2024
2 parents 939b731 + 7719d0f commit 7ac1e17
Show file tree
Hide file tree
Showing 13 changed files with 43 additions and 43 deletions.
12 changes: 6 additions & 6 deletions _data/errors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ oidc:
The issuer (also known as the client id) provided does not match a service provider registered in the IdP.
##### What to do:
- Ensure the authentication request has a `client_id` value
- Ensure that the `client_id` sent in the authentication request matches the one registered in your application on the [Partner Dashboard](https://dashboard.int.identitysandbox.gov/){:target="_blank"}.
- Ensure that the `client_id` sent in the authentication request matches the one registered in your application on the [Partner Portal](https://dashboard.int.identitysandbox.gov/){:target="_blank"}.
- Ensure that the application configuration's `active` value is set to `true`.
- title: Missing a valid IAL level
id: oidc-missing-ial
Expand All @@ -31,7 +31,7 @@ oidc:
If your application is Authentication Only, check the value of your `acr_values` parameter and ensure that it does **not** include `http://idmanagement.gov/ns/assurance/ial/2`.
If you believe your application **SHOULD** be set to Identity Verification Permitted, please:
- Reach out to your account manager to make sure your application is authorized for IdV. If it isn't, they can work with you to determine the right service level for your application.
- If your application **is** authorized for IdV, go to the dashboard and update the Level of Service value to "Identity Verification Permitted."
- If your application **is** authorized for IdV, go to the portal and update the Level of Service value to "Identity Verification Permitted."
- If this is a production instance, submit a [Zendesk request](https://zendesk.login.gov){:target="_blank"} to deploy that change to production.
- title: No acceptable acr_values found
id: oidc-no-acr-values
Expand Down Expand Up @@ -70,7 +70,7 @@ oidc:
##### Why it's happening
You have registered a redirect URI that cannot be parsed.
##### What to do:
- Check your application's configuration on the [Partner Dashboard](https://dashboard.int.identitysandbox.gov/){:target="_blank"}.
- Check your application's configuration on the [Partner Portal](https://dashboard.int.identitysandbox.gov/){:target="_blank"}.
- Ensure that all registered redirect_uris are propertly formatted and use `https` protocol.
- title: redirect_uri does not match registered redirect_uri
id: oidc-redirect-match
Expand All @@ -79,7 +79,7 @@ oidc:
##### Why it's happening
You have not registered the redirect_uri that you sent in your authentication request.
##### What to do:
- Check your application's configuration on the [Partner Dashboard](https://dashboard.int.identitysandbox.gov/){:target="_blank"} and the `redirect_uri` passed through your authentication request.
- Check your application's configuration on the [Partner Portal](https://dashboard.int.identitysandbox.gov/){:target="_blank"} and the `redirect_uri` passed through your authentication request.
- Ensure the `redirect_uri` that you are sending as part of your authentication request is registered. You must register every redirect uri that your application redirects through.
- title: Unauthorized scope
id: oidc-unauthotized-scope
Expand All @@ -100,7 +100,7 @@ oidc:
The issuer (also known as the client id) provided does not match a service provider registered in the IdP.
##### What to do:
- Ensure the logout request has a `client_id` value.
- Ensure that the `client_id` sent in the logout request matches the one registered in your application on the [Partner Dashboard](https://dashboard.int.identitysandbox.gov/){:target="_blank"}.
- Ensure that the `client_id` sent in the logout request matches the one registered in your application on the [Partner Portal](https://dashboard.int.identitysandbox.gov/){:target="_blank"}.
- Ensure that the application configuration's `active` value is set to `true`.
- title: client_id is missing
id: client-id-missing
Expand Down Expand Up @@ -194,7 +194,7 @@ oidc:
##### Why it's happening
There is no registered certificate that matches the signature of the `client_assertion` JWT that is being passed as part of the token. request.
##### What to do:
- Ensure that the public certificate that matches the private key used to sign the JWT is registered in your application's configuration in the [Partner Dashboard](https://dashboard.int.identitysandbox.gov/){:target="_blank"}.
- Ensure that the public certificate that matches the private key used to sign the JWT is registered in your application's configuration in the [Partner Portal](https://dashboard.int.identitysandbox.gov/){:target="_blank"}.
userinfo:
- title: Malformed Authorization header
id: malformed-auth-header
Expand Down
4 changes: 2 additions & 2 deletions _layouts/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,14 +120,14 @@ <h1 class="usa-logo" id="basic-logo">
</section>
</div>
<ul class="usa-nav__primary usa-accordion flex-justify">
<a href="https://dashboard.int.identitysandbox.gov/" class="mobile:display-block desktop:display-none usa-button flex-align-self-center" type="button">Go to Dashboard</a>
<a href="https://dashboard.int.identitysandbox.gov/" class="mobile:display-block desktop:display-none usa-button flex-align-self-center" type="button">Go to Portal</a>
{% include nav/list.html
links = site.data.nav.primary
li_class = 'usa-nav__primary-item'
subnav_ul_class = 'desktop:display-none usa-sidenav__sublist'
%}
<div class="desktop:margin-right-neg-2 grid-row flex-fill flex-justify-end">
<a href="https://dashboard.int.identitysandbox.gov/" class="mobile:display-none desktop:display-inline usa-button flex-align-self-center" type="button">Go to Dashboard</a>
<a href="https://dashboard.int.identitysandbox.gov/" class="mobile:display-none desktop:display-inline usa-button flex-align-self-center" type="button">Go to Portal</a>
</div>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions _pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ layout: home
<ol class="usa-process-list usa-prose margin-bottom-4">
<li class="usa-process-list__item">
<p>
Your integration with Login.gov starts in the <a href="{{ site.baseurl }}/testing/#using-the-sandbox" class="usa-link">dashboard</a> where you can register your app.
Your integration with Login.gov starts in the <a href="{{ site.baseurl }}/testing/#using-the-sandbox" class="usa-link">portal</a> where you can register your app.
</p>
</li>
<li class="usa-process-list__item">
Expand All @@ -32,7 +32,7 @@ layout: home
</li>
<li class="usa-process-list__item">
<p>
Configure your app in the dashboard and start <a href="{% link _pages/testing.md %}" class="usa-link">testing</a>! We have implementation guides and example apps to get you up and running quickly.
Configure your app in the portal and start <a href="{% link _pages/testing.md %}" class="usa-link">testing</a>! We have implementation guides and example apps to get you up and running quickly.
</p>
</li>
<li class="usa-process-list__item">
Expand Down
2 changes: 1 addition & 1 deletion _pages/oidc/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The following implementation methods of OIDC are not supported by Login.gov for

### Set up a Sandbox account

You are able to test authentication methods in real time with a testing account in our sandbox environment. To start, navigate to the [Login Partner Dashboard Sandbox](https://dashboard.int.identitysandbox.gov) and follow the steps below:
You are able to test authentication methods in real time with a testing account in our sandbox environment. To start, navigate to the [Login Partner Portal Sandbox](https://dashboard.int.identitysandbox.gov) and follow the steps below:

- Select the “Sign-in” button to create a new account. Anyone with a .gov or .mil email address may request an account.
- Create a new team - see [Testing](/testing/) page for instructions.
Expand Down
2 changes: 1 addition & 1 deletion _pages/oidc/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ sidenav:

---
{% capture client_assertion %}
A [JWT](https://jwt.io/){:class="usa-link--external"} signed with the client’s private key (minimum length of 2048 bits) associated with the public key uploaded to your application configuration within the Dashboard. The JWT should use the RS256 algorithm and containing the following claims:
A [JWT](https://jwt.io/){:class="usa-link--external"} signed with the client’s private key (minimum length of 2048 bits) associated with the public key uploaded to your application configuration within the Portal. The JWT should use the RS256 algorithm and containing the following claims:
- **iss** (string) — The issuer, which must be the `client_id`.
- **sub** (string) — The subject, which must also be the `client_id`.
- **aud** (string) — The audience, which should be (or, in the case of multiple audience values, include) the URL of the token endpoint, for example: `https://idp.int.identitysandbox.gov/api/openid_connect/token`
Expand Down
2 changes: 1 addition & 1 deletion _pages/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Login.gov is a FedRAMP moderate approved multifactor authentication and identity

This is the configuration for your application within Login.gov’s identity provider. In the sandbox environment, you will be able to determine the configuration yourself and decide what is the best fit for your needs. In the Login.gov production environment, we will manage the final configuration.
To configure a test application in the sandbox environment:
* Create an account in the [Login.gov dashboard](https://idp.int.identitysandbox.gov/). From here you will be able to test various configurations and determine what is right for your agency.
* Create an account in the [Login.gov Portal](https://portal.int.identitysandbox.gov). From here you will be able to test various configurations and determine what is right for your agency.
* Select between [OIDC]({{ site.baseurl }}/oidc/) or [SAML]({{ site.baseurl }}/saml/) protocol implementation protocols and understand which user attributes are required.
* If you have questions when testing your app, read through our [FAQs]({{ site.baseurl }}/support/) or submit a ticket to our [technical support help desk]({{ site.baseurl}}/support/#contacting-partner-support).
* Before submitting a request to move your app to production, review the [User experience]({{ site.baseurl }}/design-guidelines/) page and the [Production]({{ site.baseurl }}/production/) page. Additional requirements, like a [signed Interagency agreement]({{ site.baseurl }}/production/#confirm-interagency-agreement-iaa) (IAA) and [agency logo]({{ site.baseurl }}/user-experience/agency-logo/), are described in these pages.
14 changes: 7 additions & 7 deletions _pages/production.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Production deployment
lead: >
Once you’ve set up your integration through [our dashboard](https://dashboard.int.identitysandbox.gov/) and tested, you can request deployment to the Login.gov production environment.
Once you’ve set up your integration through [our portal](https://dashboard.int.identitysandbox.gov/) and tested, you can request deployment to the Login.gov production environment.
redirect_from:
- /production-deployment/
Expand Down Expand Up @@ -35,7 +35,7 @@ Make sure you have the following items ready before you start the deployment pro

- [Signed Interagency Agreement (IAA) listing this integration ]({{ site.baseurl}}/production/#confirm-interagency-agreement-iaa)

- A dedicated [application configuration within the Dashboard](https://dashboard.int.identitysandbox.gov/)
- A dedicated [application configuration within the Portal](https://dashboard.int.identitysandbox.gov/)
* We recommend having two configurations, one that is intended for deployment to production and one which is purely for testing purposes.
* All production urls should have .gov, .mil, or a dedicated .com address and point to an Authority to Operate (ATO) approved environment.

Expand Down Expand Up @@ -69,7 +69,7 @@ Please reach out to your agency IAA contact if you have any questions. If your a

## Production configuration process

Before you can request deployment, you need to create a new and separate application on our dashboard. This new app will include your production certificate, urls, and logo. When starting this process you need the following items ready to go:
Before you can request deployment, you need to create a new and separate application on our portal. This new app will include your production certificate, urls, and logo. When starting this process you need the following items ready to go:

- Signed IAA listing this integration 

Expand All @@ -79,7 +79,7 @@ Before you can request deployment, you need to create a new and separate applica

**When you have the components required, follow these steps to create your production configuration app:**

1. [Create a new app on the](https://dashboard.int.identitysandbox.gov/) Login.gov Partner Dashboard. Select “Apps” from the top right menu, then select the “Create a new app” button.
1. [Create a new app on the](https://dashboard.int.identitysandbox.gov/) Login.gov Partner Portal. Select “Apps” from the top right menu, then select the “Create a new app” button.

2. Select “YES” for production configuration - this configuration is for a production app.

Expand Down Expand Up @@ -131,7 +131,7 @@ Once you have:

2. [Created a production configuration app]({{site.baseurl}}/production/#production-configuration-process).

3. Confirmed that you have a logo uploaded to your production configuration in the [Partner Dashboard](https://dashboard.int.identitysandbox.gov/). **An uploaded logo is required for the deployment process.**
3. Confirmed that you have a logo uploaded to your production configuration in the [Partner Portal](https://dashboard.int.identitysandbox.gov/). **An uploaded logo is required for the deployment process.**

You are ready to submit a launch request through the [Partner Support Help Desk](https://zendesk.login.gov)

Expand Down Expand Up @@ -161,7 +161,7 @@ If you are rotating your application’s public/private keypair, or want to add

**For OIDC integrations or SAML integrations sending signed requests:**

1. Add the new certificate to the application dashboard configuration.
1. Add the new certificate to the application portal configuration.

2. Contact Login.gov technical support and request certificate addition.

Expand All @@ -174,7 +174,7 @@ If you are rotating your application’s public/private keypair, or want to add

1. The final certificate rotation must be coordinated with Login.gov technical support.

2. Add the new certificate to the application dashboard configuration.
2. Add the new certificate to the application portal configuration.

3. Request coordination of the certificate rotation from Login.gov technical support.

Expand Down
2 changes: 1 addition & 1 deletion _pages/saml/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Here are values needed to configure your service provider (SP) to work with Logi
Consistent with the [SAML metadata specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf){:class="usa-link--external"}, Login.gov's metadata for our sandbox environment is available at [https://idp.int.identitysandbox.gov/api/saml/metadata{{ site.data.saml.year.current }}](https://idp.int.identitysandbox.gov/api/saml/metadata{{ site.data.saml.year.current }}).

### Signing Certificates
Below you can find the X509 certificates used by the Login.gov IdP to sign SAML requests. **Do not enter these certificates in the Dashboard when configuring an application for testing** - you can follow the instructions in our [testing article]({% link _pages/testing.md %}#creating-a-public-certificate) to generate a client certificate.
Below you can find the X509 certificates used by the Login.gov IdP to sign SAML requests. **Do not enter these certificates in the Portal when configuring an application for testing** - you can follow the instructions in our [testing article]({% link _pages/testing.md %}#creating-a-public-certificate) to generate a client certificate.

<div class="usa-accordion--bordered">
<button class="usa-accordion__button" aria-controls="sandbox-cert-{{ site.data.saml.year.current }}">
Expand Down
2 changes: 1 addition & 1 deletion _pages/security-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ The URL must:

#### Agency integration environment:

- Use the dashboard to register the `push_notification_url` for your application
- Use the portal to register the `push_notification_url` for your application
- Your `push_notification_url` will be automatically added to the integration environment's outbound proxy allowlist by 5PM UTC.

#### Production environment:
Expand Down
Loading

0 comments on commit 7ac1e17

Please sign in to comment.