OutboundConsentRequest

Definition

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

Syntax

Microsoft.OData.Mcp.Authentication.Outbound.OutboundConsentRequest

Summary

The consent-request payload passed to OutboundOAuthOptions.ConsentPresenter, and carried by OAuthConsentRequiredException, when interactive sign-in is required to complete an outbound OAuth grant.

Remarks

Per AUTH-12 this type never carries a device_code, an access token, a refresh token, or a PKCE code_verifier — only what a human or an MCP client needs to complete sign-in out of band. Fields that must stay off this type (the pending grant’s device_code, interval, code_verifier, expected state, and live HttpListener) live instead on OutboundOAuthClient’s internal pending-grant state. Every URL on this type is server-controlled: it comes from an authorization server that a malicious protected resource could have named. Because a consent URL is handed to ShellExecute by the stdio presenter and to an MCP client as an elicitation URL, the constructor is the chokepoint that refuses any scheme other than https, or http on a loopback host, before either can happen.

Examples

var request = new OutboundConsentRequest(
    OutboundGrantKind.DeviceCode,
    new Uri("https://login.microsoftonline.com/common/oauth2/v2.0/devicecode"),
    "Sign in to continue.",
    userCode: "ABCD-EFGH",
    verificationUri: new Uri("https://microsoft.com/devicelogin"));

Constructors

.ctor

Initializes a new instance of the OutboundConsentRequest class.

Syntax

public OutboundConsentRequest(Microsoft.OData.Mcp.Authentication.Outbound.OutboundGrantKind kind, System.Uri url, string message, string userCode, System.Uri verificationUri, string elicitationId = null)

Parameters

Name	Type	Description
`kind`	`Microsoft.OData.Mcp.Authentication.Outbound.OutboundGrantKind?`	The grant kind this consent request is completing.
`url`	`System.Uri`	The absolute URL to open to complete sign-in.
`message`	`string`	The human-readable message describing what to do.
`userCode`	`string?`	The short code a human types at verificationUri, or `null`.
`verificationUri`	`System.Uri?`	The verification URI a human is directed to, or `null`.
`elicitationId`	`string?`	The correlation identifier, or `null` to generate a new `D`-format GUID.

Exceptions

Exception	Description
`ArgumentNullException`	Thrown when url is `null`.
`ArgumentException`	Thrown when url is not an absolute URI, when message is empty or
white space, or when elicitationId is non-`null` and empty or white space.
`OutboundDiscoveryException`	Thrown when url or verificationUri is neither an `https`
URI nor an `http` URI on a loopback host.

Remarks

The scheme check runs on both URLs and it runs here rather than at each presenter, because there is no presenter this instance is guaranteed to reach: it is also carried by OAuthConsentRequiredException to whatever host catches it.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

ElicitationId

Gets the identifier this consent request correlates an MCP elicitation to.

Syntax

public string ElicitationId { get; }

Property Value

Type: string

Kind

Gets the grant kind this consent request is completing.

Syntax

public Microsoft.OData.Mcp.Authentication.Outbound.OutboundGrantKind Kind { get; }

Property Value

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

Message

Gets the human-readable message describing what the operator or the LLM should do.

Syntax

public string Message { get; }

Property Value

Type: string

Url

Gets the absolute URL to open to complete sign-in: an authorization URI for interactive grants, or a device verification URI for the device code grant.

Syntax

public System.Uri Url { get; }

Property Value

Type: System.Uri

UserCode

Gets the short code a human types at OutboundConsentRequest.VerificationUri, or null when the grant kind does not use one.

Syntax

public string UserCode { get; }

Property Value

Type: string?

VerificationUri

Gets the verification URI a human is directed to enter OutboundConsentRequest.UserCode at, or null when the grant kind does not use one.

Syntax

public System.Uri VerificationUri { get; }

Property Value

Type: System.Uri?

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

​Remarks

​ .ctor Inherited

​Syntax

​Properties

​ ElicitationId

​Syntax

​Property Value

​ Kind

​Syntax

​Property Value

​ Message

​Syntax

​Property Value

​ Url

​Syntax

​Property Value

​ UserCode

​Syntax

​Property Value

​ VerificationUri

​Syntax

​Property Value

​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

Remarks

.ctor Inherited

Syntax

Properties

ElicitationId

Syntax

Property Value

Kind

Syntax

Property Value

Message

Syntax

Property Value

Url

Syntax

Property Value

UserCode

Syntax

Property Value

VerificationUri

Syntax

Property Value

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