ScopeResolver - EasyAF.AI

Definition

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

Syntax

Microsoft.OData.Mcp.Authentication.Outbound.ScopeResolver

Summary

Resolves the space-delimited OAuth scope a token request should ask for, per step 8 of the discovery algorithm and matching the SDK 2.2 ScopeSelectorDelegate order exactly.

Remarks

Per Key Decision 9 of specs/v3/AUTHENTICATION.md, the base scope order is: the WWW-Authenticate challenge scope, then RFC 9728 protected resource metadata scopes_supported, then the operator’s --scopes, then no scope at all. offline_access is appended whenever the authorization server or protected resource metadata advertises it, or the authorization server advertises the refresh_token grant, so an interactive grant can refresh instead of re-prompting. Finally, OutboundOAuthOptions.ScopeSelector — the SDK’s ScopeSelectorDelegate reused as-is — runs last and may remove offline_access, which this type logs a warning about rather than silently accepting.

Examples

var resolver = new ScopeResolver(logger);
var scope = resolver.Resolve(discovery, options);

var device = await deviceCodeGrant.StartAsync(discovery.AuthorizationServer, clientId, scope, discovery.Resource, cancellationToken);

Constructors

.ctor

Initializes a new instance of the ScopeResolver class.

Syntax

public ScopeResolver(Microsoft.Extensions.Logging.ILogger<Microsoft.OData.Mcp.Authentication.Outbound.ScopeResolver> logger)

Parameters

Name	Type	Description
`logger`	`Microsoft.Extensions.Logging.ILogger<Microsoft.OData.Mcp.Authentication.Outbound.ScopeResolver>`	The logger this instance records the `offline_access` removal warning to.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when logger is `null`.

.ctor Inherited

Inherited from object

Syntax

public Object()

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

Resolve

Resolves the scope a token request should ask for, per step 8 of the discovery algorithm.

Syntax

public string Resolve(Microsoft.OData.Mcp.Authentication.Outbound.OAuthDiscoveryResult discovery, Microsoft.OData.Mcp.Authentication.Outbound.OutboundOAuthOptions options)

Parameters

Name	Type	Description
`discovery`	`Microsoft.OData.Mcp.Authentication.Outbound.OAuthDiscoveryResult`	The discovery result whose challenge scope, protected resource metadata, and authorization server are consulted.
`options`	`Microsoft.OData.Mcp.Authentication.Outbound.OutboundOAuthOptions`	The operator’s outbound OAuth settings, carrying the `--scopes` fallback and an optional scope selector.

Returns

Type: string? The resolved space-delimited scope, or null when nothing resolves to a non-empty scope.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when discovery or options is `null`.

Examples

var scope = resolver.Resolve(discovery, options); // "openid offline_access", or null

Remarks

OutboundOAuthOptions.ScopeSelector receives the individual scope tokens as an [IReadOnlyCollection1](https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlycollection-1) — exactly the SDK 2.2 ScopeSelectorDelegate` signature — and its returned scopes are re-joined with single spaces.

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

​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

​ Resolve

​Syntax

​Parameters

​Returns

​Exceptions

​Examples

​Remarks

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Remarks

Examples

Constructors

.ctor

Syntax

Parameters

Exceptions

.ctor Inherited

Syntax

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

Resolve

Syntax

Parameters

Returns

Exceptions

Examples

Remarks

ToString Inherited Virtual

Syntax

Returns