diff --git a/en/developer-docs/docs/administer/configure-exposed-environments-to-developer-portal.md b/en/developer-docs/docs/administer/configure-exposed-environments-to-developer-portal.md new file mode 100644 index 0000000000..b4910f2180 --- /dev/null +++ b/en/developer-docs/docs/administer/configure-exposed-environments-to-developer-portal.md @@ -0,0 +1,16 @@ +# Configure Exposed Environments to Developer Portal + +The Choreo Developer Portal enables external developers to discover and consume APIs published by your organization. Through the Choreo Console, you can manage which API environments are visible and accessible in the Developer Portal. + +Follow these steps to configure which environments are visible in the Developer Portal: + +!!! Note - + Organizations created after **April 24th, 2025**, will have the **Production** environment exposed by default. Organizations created before this date will continue to allow all environments visible in the Developer Portal. + +1. Sign in to [Choreo](https://console.choreo.dev/). + +2. In the Choreo Console, go to the top navigation menu and click **Organization**. Then select your organization. + +3. In the left navigation menu, click **Settings**. Under the **API Management** tab, go to **Developer Portal**. + +4. Expand the **Environments** section and configure the environments exposed to the Developer Portal. diff --git a/en/developer-docs/docs/administer/configure-identity-providers-for-developer-portal.md b/en/developer-docs/docs/administer/configure-identity-providers-for-developer-portal.md new file mode 100644 index 0000000000..de3b3ac93c --- /dev/null +++ b/en/developer-docs/docs/administer/configure-identity-providers-for-developer-portal.md @@ -0,0 +1,19 @@ +# Configure Identity Providers for Developer Portal + +You can configure the Identity Providers (IdPs) available for consumers to authenticate and generate API keys in the Developer Portal from the Choreo Console. + +!!! Note - + Organizations created after **April 24th, 2025**, will have the **Choreo Built-in Identity Provider** configured by default. Organizations created before this date will continue to allow all configured identity providers to be used in the Developer Portal. + +Follow these steps to configure Identity Providers: + +1. Sign in to [Choreo](https://console.choreo.dev/). + +2. In the Choreo Console, go to the top navigation menu and click **Organization**. Then select your organization. + +3. In the left navigation menu, click **Settings**. Under the **API Management** tab, go to **Developer Portal**. + +4. In the **Identity Providers** section, specify which identity providers should be used for both the **Sandbox** and **Production** environments of the Developer Portal. + +!!! Note - + Any identity provider configured for the Developer Portal's **Production** environment must also be enabled in the Choreo **Production** environment. diff --git a/en/developer-docs/docs/tutorials/expose-a-service-as-a-managed-api.md b/en/developer-docs/docs/tutorials/expose-a-service-as-a-managed-api.md index 9d0ecbf4b2..f83d2f528d 100644 --- a/en/developer-docs/docs/tutorials/expose-a-service-as-a-managed-api.md +++ b/en/developer-docs/docs/tutorials/expose-a-service-as-a-managed-api.md @@ -107,9 +107,8 @@ To generate credentials for the published API and invoke it via the Developer Po 2. Click **Generate Credentials**. Choreo generates new tokens and populates the **Consumer Key** and **Consumer Secret** fields. 3. Invoke the API: 1. In the Developer Portal left navigation menu, click **Try Out**. - 2. In the **Endpoint** list, select **Development** as the environment to try out the API. - 3. Click **Get Test Key**. This generates an access token. - 4. Expand the `GET /pet/findByStatus` operation and click **Try it out**. - 5. Select **available** as the status and click **Execute**. + 2. Click **Get Test Key**. This generates an access token. + 3. Expand the `GET /pet/findByStatus` operation and click **Try it out**. + 4. Select **available** as the status and click **Execute**. Now you have successfully created, deployed, tested, and published an API proxy using Choreo. diff --git a/en/developer-docs/mkdocs.yml b/en/developer-docs/mkdocs.yml index 041d5e666c..799e42b69e 100644 --- a/en/developer-docs/mkdocs.yml +++ b/en/developer-docs/mkdocs.yml @@ -244,6 +244,8 @@ nav: - Developer Portal: - Customize the Developer Portal: administer/customize-the-developer-portal.md - Configure Self-Sign-Up: administer/configure-self-sign-up.md + - Configure Identity Providers for Developer Portal: administer/configure-identity-providers-for-developer-portal.md + - Configure Exposed Environments to Developer Portal: administer/configure-exposed-environments-to-developer-portal.md - Manage Members of an Organization: administer/manage-members-of-an-organization.md - Control Egress Traffic for Your Organization: administer/control-egress-traffic-for-your-organization.md - References: diff --git a/en/pe-docs/docs/api-management/developer-portal/configure-exposed-environments-to-developer-portal.md b/en/pe-docs/docs/api-management/developer-portal/configure-exposed-environments-to-developer-portal.md new file mode 100644 index 0000000000..b4910f2180 --- /dev/null +++ b/en/pe-docs/docs/api-management/developer-portal/configure-exposed-environments-to-developer-portal.md @@ -0,0 +1,16 @@ +# Configure Exposed Environments to Developer Portal + +The Choreo Developer Portal enables external developers to discover and consume APIs published by your organization. Through the Choreo Console, you can manage which API environments are visible and accessible in the Developer Portal. + +Follow these steps to configure which environments are visible in the Developer Portal: + +!!! Note - + Organizations created after **April 24th, 2025**, will have the **Production** environment exposed by default. Organizations created before this date will continue to allow all environments visible in the Developer Portal. + +1. Sign in to [Choreo](https://console.choreo.dev/). + +2. In the Choreo Console, go to the top navigation menu and click **Organization**. Then select your organization. + +3. In the left navigation menu, click **Settings**. Under the **API Management** tab, go to **Developer Portal**. + +4. Expand the **Environments** section and configure the environments exposed to the Developer Portal. diff --git a/en/pe-docs/docs/api-management/developer-portal/configure-identity-providers-for-developer-portal.md b/en/pe-docs/docs/api-management/developer-portal/configure-identity-providers-for-developer-portal.md new file mode 100644 index 0000000000..de3b3ac93c --- /dev/null +++ b/en/pe-docs/docs/api-management/developer-portal/configure-identity-providers-for-developer-portal.md @@ -0,0 +1,19 @@ +# Configure Identity Providers for Developer Portal + +You can configure the Identity Providers (IdPs) available for consumers to authenticate and generate API keys in the Developer Portal from the Choreo Console. + +!!! Note - + Organizations created after **April 24th, 2025**, will have the **Choreo Built-in Identity Provider** configured by default. Organizations created before this date will continue to allow all configured identity providers to be used in the Developer Portal. + +Follow these steps to configure Identity Providers: + +1. Sign in to [Choreo](https://console.choreo.dev/). + +2. In the Choreo Console, go to the top navigation menu and click **Organization**. Then select your organization. + +3. In the left navigation menu, click **Settings**. Under the **API Management** tab, go to **Developer Portal**. + +4. In the **Identity Providers** section, specify which identity providers should be used for both the **Sandbox** and **Production** environments of the Developer Portal. + +!!! Note - + Any identity provider configured for the Developer Portal's **Production** environment must also be enabled in the Choreo **Production** environment. diff --git a/en/pe-docs/mkdocs.yml b/en/pe-docs/mkdocs.yml index e46c727064..e9c57d0f08 100644 --- a/en/pe-docs/mkdocs.yml +++ b/en/pe-docs/mkdocs.yml @@ -164,6 +164,8 @@ nav: - API Management: - Developer Portal: - Customize the Choreo Developer Portal: api-management/developer-portal/customize-the-developer-portal.md + - Configure Identity Providers for Developer Portal: api-management/developer-portal/configure-identity-providers-for-developer-portal.md + - Configure Exposed Environments to Developer Portal: api-management/developer-portal/configure-exposed-environments-to-developer-portal.md - API Analytics: - Integrate Choreo with Moesif for Analytics: api-management/api-analytics/integrate-choreo-with-moesif.md - Consumer IDPs: