OAuthDiscoveryResult

Definition

Assembly: Microsoft.OData.Mcp.Authentication.dll Namespace: Microsoft.OData.Mcp.Authentication.Outbound Inheritance: System.Object

Syntax

Microsoft.OData.Mcp.Authentication.Outbound.OAuthDiscoveryResult

Summary

Everything the outbound OAuth discovery algorithm learned about a protected OData service: the WWW-Authenticate challenge it started from, the RFC 9728 protected resource metadata it found (if any), the authorization server it selected, and the grants, scope, and RFC 8707 resource a grant needs.

Remarks

Produced exclusively by CancellationToken), which never returns an instance without an authorization server: discovery fails first rather than handing a caller a half-populated result. Per AUTH-13 the challenge client_id is reachable only as OAuthChallenge.ResourceClientId through OAuthDiscoveryResult.Challenge, so nothing on this type can be mistaken for the client id this process authenticates with.

Examples

var result = await discovery.DiscoverAsync(serviceRoot, wwwAuthenticate, 401, null, null, cancellationToken);

Console.WriteLine(result.AuthorizationServer.TokenEndpoint);
Console.WriteLine(result.Resource);
if (result.AdvertisedGrants.Contains(ODataMcpAuthConstants.DeviceCodeGrantType))
{
    // Start a device code grant against result.AuthorizationServer.
}

Constructors

.ctor

Initializes a new instance of the OAuthDiscoveryResult class.

Syntax

public OAuthDiscoveryResult(Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge challenge, ModelContextProtocol.Authentication.ProtectedResourceMetadata protectedResource, Microsoft.OData.Mcp.Authentication.Outbound.AuthorizationServerMetadata authorizationServer, System.Uri authorizationServerBase, System.Collections.Generic.IReadOnlyList<string> advertisedGrants, string challengeScope, System.Uri resource)

Parameters

Name	Type	Description
`challenge`	`Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge?`	The `Bearer` challenge discovery started from, or `null`.
`protectedResource`	`ModelContextProtocol.Authentication.ProtectedResourceMetadata?`	The RFC 9728 protected resource metadata document, or `null`.
`authorizationServer`	`Microsoft.OData.Mcp.Authentication.Outbound.AuthorizationServerMetadata`	The authorization server metadata document discovery selected.
`authorizationServerBase`	`System.Uri`	The candidate base URI authorizationServer was discovered from.
`advertisedGrants`	`System.Collections.Generic.IReadOnlyList<string>`	The grant types authorizationServer advertises.
`challengeScope`	`string?`	The `scope` the challenge asked for, or `null`.
`resource`	`System.Uri?`	The RFC 8707 resource indicator a token request should ask for, or `null` when it should carry none.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when authorizationServer, authorizationServerBase, or
advertisedGrants is `null`.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AdvertisedGrants

Gets the grant types OAuthDiscoveryResult.AuthorizationServer advertises, or an empty list when it advertises none.

Syntax

public System.Collections.Generic.IReadOnlyList<string> AdvertisedGrants { get; }

Property Value

Type: System.Collections.Generic.IReadOnlyList<string>

Remarks

Never null, so grant selection can enumerate it without a null check.

AuthorizationServer

Gets the authorization server metadata document discovery selected.

Syntax

public Microsoft.OData.Mcp.Authentication.Outbound.AuthorizationServerMetadata AuthorizationServer { get; }

Property Value

Type: Microsoft.OData.Mcp.Authentication.Outbound.AuthorizationServerMetadata

Remarks

Guaranteed to carry an absolute token_endpoint, because AuthorizationServerMetadataClient rejects a document without one.

AuthorizationServerBase

Gets the candidate base URI that OAuthDiscoveryResult.AuthorizationServer was discovered from.

Syntax

public System.Uri AuthorizationServerBase { get; }

Property Value

Type: System.Uri

Remarks

This is the operator’s --auth-server value, a protected resource metadata authorization_servers entry, or a remainder stripped from the challenge authorization_uri; it is not necessarily the issuer the document advertises.

Challenge

Gets the Bearer challenge discovery started from, or null when the response carried no Bearer challenge.

Syntax

public Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge Challenge { get; }

Property Value

Type: Microsoft.OData.Mcp.Authentication.Outbound.OAuthChallenge?

ChallengeScope

Gets the space-delimited scope the challenge asked for, or null when it asked for none.

Syntax

public string ChallengeScope { get; }

Property Value

Type: string?

Remarks

This is the highest priority input to scope resolution per step 8 of the discovery algorithm.

ProtectedResource

Gets the RFC 9728 protected resource metadata document, or null when every candidate was missing, unauthorized, or unparseable.

Syntax

public ModelContextProtocol.Authentication.ProtectedResourceMetadata ProtectedResource { get; }

Property Value

Type: ModelContextProtocol.Authentication.ProtectedResourceMetadata?

Remarks

A null value is normal and non-fatal per AUTH-14; it means discovery continued from the challenge and the operator’s overrides.

Resource

Gets the RFC 8707 resource indicator a token request should ask for, or null when no token request should carry one.

Syntax

public System.Uri Resource { get; }

Property Value

Type: System.Uri?

Remarks

Resolved per step 8b of the discovery algorithm: the protected resource metadata resource when it is absolute, else the operator’s --resource, else null. There is deliberately no origin fallback: RFC 8707 resource is only meaningful when the resource itself published it or the operator named it, and an invented audience is rejected by strict authorization servers that would otherwise have honored scope alone.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Remarks

​Examples

​Constructors

​ .ctor

​Syntax

​Parameters

​Exceptions

​ .ctor Inherited

​Syntax

​Properties

​ AdvertisedGrants

​Syntax

​Property Value

​Remarks

​ AuthorizationServer

​Syntax

​Property Value

​Remarks

​ AuthorizationServerBase

​Syntax

​Property Value

​Remarks

​ Challenge

​Syntax

​Property Value

​ ChallengeScope

​Syntax

​Property Value

​Remarks

​ ProtectedResource

​Syntax

​Property Value

​Remarks

​ Resource

​Syntax

​Property Value

​Remarks

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Remarks

Examples

Constructors

.ctor

Syntax

Parameters

Exceptions

.ctor Inherited

Syntax

Properties

AdvertisedGrants

Syntax

Property Value

Remarks

AuthorizationServer

Syntax

Property Value

Remarks

AuthorizationServerBase

Syntax

Property Value

Remarks

Challenge

Syntax

Property Value

ChallengeScope

Syntax

Property Value

Remarks

ProtectedResource

Syntax

Property Value

Remarks

Resource

Syntax

Property Value

Remarks

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns