Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 10, 2025

Description

This PR documents the new ClaimActions configuration feature for the Aspire dashboard's OpenID Connect authentication, introduced in dotnet/aspire#8396.

The ClaimActions configuration allows users to map custom claims from their OpenID Connect identity provider's user info endpoint to the dashboard user's claims identity. This is particularly useful for scenarios requiring role-based authentication or mapping custom claims that aren't included by default.

Changes

  • Added Dashboard:Frontend:OpenIdConnect:ClaimActions configuration option to the Frontend authentication table
  • Created a new "Claim actions" subsection with detailed documentation including:
    • Property reference table for all ClaimAction properties (ClaimType, JsonKey, SubKey, IsUnique, ValueType)
    • Complete JSON configuration example demonstrating role-based authentication
    • Environment variable configuration example
    • Advanced example showing nested JSON property mapping using SubKey
  • Updated ms.date to reflect the documentation update

Example Usage

JSON Configuration

{
  "Dashboard": {
    "Frontend": {
      "OpenIdConnect": {
        "ClaimActions": [
          {
            "ClaimType": "role",
            "JsonKey": "role"
          }
        ]
      }
    }
  }
}

Environment Variables

export Dashboard__Frontend__OpenIdConnect__ClaimActions__0__ClaimType="role"
export Dashboard__Frontend__OpenIdConnect__ClaimActions__0__JsonKey="role"

Fixes the documentation request from dotnet/aspire#8396.

Original prompt

Document configuring claims actions on the dashboard configuration page. See @dotnet/aspire/pull/8396 for details


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/fundamentals/dashboard/configuration.md docs/fundamentals/dashboard/configuration

Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Copilot AI changed the title [WIP] Document configuring claims actions on dashboard Document ClaimActions configuration for dashboard OpenID Connect authentication Oct 10, 2025
Copilot AI requested a review from JamesNK October 10, 2025 07:54
Copilot finished work on behalf of JamesNK October 10, 2025 07:54
@JamesNK JamesNK marked this pull request as ready for review October 10, 2025 08:01
@JamesNK JamesNK requested a review from IEvangelist as a code owner October 10, 2025 08:01
Copilot AI review requested due to automatic review settings October 10, 2025 08:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR documents the new ClaimActions configuration feature for the Aspire dashboard's OpenID Connect authentication. The documentation explains how users can map custom claims from their OpenID Connect identity provider's user info endpoint to the dashboard user's claims identity, which is particularly useful for role-based authentication scenarios.

Key changes include:

  • Added comprehensive documentation for the ClaimActions configuration option
  • Created a detailed "Claim actions" subsection with property reference and examples
  • Updated the documentation date to reflect the current changes

@JamesNK
Copy link
Member

JamesNK commented Oct 10, 2025

@IEvangelist Documentation for a vNext feature. Can you review and merge into the next major release branch.

@IEvangelist IEvangelist changed the base branch from main to release-13 October 10, 2025 13:04
@IEvangelist IEvangelist merged commit 5f42178 into release-13 Oct 13, 2025
10 checks passed
@IEvangelist IEvangelist deleted the copilot/document-claims-actions-configuration branch October 13, 2025 13:01
@IEvangelist IEvangelist added 🗺️ reQUEST Triggers an issue to be imported into Quest. area-docs labels Oct 13, 2025
@dotnetrepoman dotnetrepoman bot added the 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. label Oct 13, 2025
@dotnet-policy-service dotnet-policy-service bot removed the 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. label Oct 13, 2025
@IEvangelist IEvangelist added this to the 13.0 milestone Oct 13, 2025
IEvangelist added a commit that referenced this pull request Nov 11, 2025
* Document ClaimActions configuration for dashboard OpenID Connect authentication (#5192)

* Initial plan

* Document ClaimActions configuration for dashboard OIDC authentication

Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>

* Apply suggestion from @JamesNK

* Apply suggestion from @JamesNK

* Apply suggestion from @JamesNK

* Update configuration.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Co-authored-by: James Newton-King <james@newtonking.com>

* Document breaking change: DefaultAzureCredential defaults to ManagedIdentityCredential on ACA and App Service (#5303)

* Initial plan

* Add breaking change documentation for DefaultAzureCredential in 13.0

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Fix markdown linting error - add blank line before list

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update docs/compatibility/13.0/defaultazurecredential-managedidentity-default.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Update Azure AI Foundry and GitHub Models documentation to use strongly-typed model constants (#5302)

* Initial plan

* Update documentation to use AIFoundryModel and GitHubModel constants

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update compatibility matrix to use GitHubModel constant

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Update environment variable format to polyglot-friendly pattern (#5320)

* Initial plan

* Update environment variable format to polyglot-friendly pattern

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update AppHost project documentation for Aspire 13.0 SDK format (#5319)

* Initial plan

* Update AppHost project section to show new SDK format for Aspire 13.0

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md (#5318)

* Initial plan

* Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Apply suggestions from code review

* Update docs/fundamentals/app-host-overview.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Add breaking changes documentation for pipeline activity reporter API rename (PR #12137) (#5310)

* Initial plan

* Add breaking changes article for PR #12137 and update documentation

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Fix parameter naming consistency in breaking change examples

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Fix cross reference warnings by using inline code formatting

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Add documentation for ASPIREPIPELINES001, ASPIREPIPELINES002, and ASPIREPIPELINES003 diagnostics (#5359)

* Initial plan

* Add documentation for three new pipeline-related diagnostics

Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>

* Fix ms.date to reflect current date in diagnostic documentation

Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>

* Update diagnostic codes to use ASPIREPIPELINES001-003 instead of mixed naming scheme

Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>

* Add ASPIREPIPELINES001-003 diagnostics to TOC

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Add Aspire MCP docs (#5446)

* Update configuration

* Document deployment state caching (#5301)

* Initial plan

* Add local deployment state documentation

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Address feedback: Add intros, italicize paths, add CI/CD example

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Rename and relocate deployment state doc outside Azure section

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Clarify cache save behavior in GitHub Actions example

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Add certificate trust customization article for Aspire 13 (#5311)

* Initial plan

* Add certificate trust customization article

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Fix cross-reference title to match actual article title

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Address PR feedback: update API examples, add runtime callout, document default scopes

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update callback APIs to use async Task and simplified context objects

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Replace deprecated callback APIs with new simplified APIs

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update documentation for new polyglot environment variables (issue #5308) (#5313)

* Initial plan

* Update documentation with new polyglot environment variable format

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Add clarification about resource names in environment variables

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Improve clarity of note about connection name parameter

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update docs/fundamentals/app-host-overview.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Update documentation for Aspire 13 release

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: build

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Co-authored-by: James Newton-King <james@newtonking.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@cmastr cmastr moved this from 🔖 Ready to ✅ Done in dotnet/docs October 2025 sprint Nov 12, 2025
@dotnetrepoman dotnetrepoman bot added the 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. label Nov 12, 2025
@dotnet-policy-service dotnet-policy-service bot removed the 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. label Nov 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-docs 🗺️ reQUEST Triggers an issue to be imported into Quest.

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

3 participants