DownstreamApiOptionsReadOnlyHttpMethod Class

  • Reference

Definition

Namespace:
Microsoft.Identity.Abstractions
Assembly:
Microsoft.Identity.Abstractions.dll
Package:
Microsoft.Identity.Abstractions v7.1.0

Specialization of DownstreamApiOptions where the HttpMethod is not settable beyond it's construction.

public class DownstreamApiOptionsReadOnlyHttpMethod : Microsoft.Identity.Abstractions.DownstreamApiOptions
type DownstreamApiOptionsReadOnlyHttpMethod = class
    inherit DownstreamApiOptions
Public Class DownstreamApiOptionsReadOnlyHttpMethod
Inherits DownstreamApiOptions
Inheritance
Object
AuthorizationHeaderProviderOptions
DownstreamApiOptions
DownstreamApiOptionsReadOnlyHttpMethod

Remarks

This class is useful to provide a better developer experience on the specialized methods of IDownstreamApi where the HTTP method is provided already by the name of the method, and should not be overridden by the options. You shouldn't need to use it directly.

Constructors

DownstreamApiOptionsReadOnlyHttpMethod(DownstreamApiOptions, String)

Constructor fro a DownstreamApiOptions and an HTTP method.

Properties

AcceptHeader

The HTTP Accept header is used to inform that server about the content type that the client is expecting in the response.

(Inherited from DownstreamApiOptions)
AcquireTokenOptions

Options related to token acquisition.

(Inherited from AuthorizationHeaderProviderOptions)
BaseUrl

Base URL for the called downstream web API. For instance "https://graph.microsoft.com/beta/".

(Inherited from AuthorizationHeaderProviderOptions)
ContentType

Content type of the request body.

(Inherited from DownstreamApiOptions)
CustomizeHttpRequestMessage

Provides an opportunity for the caller app to customize the HttpRequestMessage. For example, to customize the headers. This is called after the message was formed, including the Authorization header, and just before the message is sent.

(Inherited from AuthorizationHeaderProviderOptions)
Deserializer

Optional de-serializer. Will de-serialize the output from the web API (if any). When not provided, the following is returned: JsonSerializer.Deserialize<TOutput>(content, new JsonSerializerOptions { PropertyNameCaseInsensitive = true });

(Inherited from DownstreamApiOptions)
HttpMethod

Http method only readable publicly.
ProtocolScheme

Name of the protocol scheme used to create the authorization header. By default: "Bearer".

(Inherited from AuthorizationHeaderProviderOptions)
RelativePath

Path relative to the BaseUrl (for instance "me").

(Inherited from AuthorizationHeaderProviderOptions)
RequestAppToken

Describes if the downstream API is called on behalf of the calling service itself (App token) or on behalf of a user processed by the service (user token). If true, the token is requested on behalf of the app. Otherwise, it on-behalf of the user.

(Inherited from AuthorizationHeaderProviderOptions)
Scopes

Scopes required to call the downstream web API. For instance "user.read mail.read". For Microsoft identity, in the case of application tokens (token requested by the app on behalf of itself), there should be only one scope, and it should end in "./default")

(Inherited from DownstreamApiOptions)
Serializer

Optional serializer. Will serialize the input to the web API (if any). By default, when not provided:

  • If the input derives from HttpInput, it's used as is
  • If the input is a string it's used as is an considered a media type json.
  • Otherwise, the object is serialized in JSON, with a UTF8 encoding, and a media type of application/json: 
    new StringContent(JsonSerializer.Serialize(input), Encoding.UTF8, "application/json")
(Inherited from DownstreamApiOptions)

Methods

Clone()

Clone the options
CloneInternal()

Clone the options (to be able to override them).
GetApiUrl()

Return the downstream web API URL.

(Inherited from AuthorizationHeaderProviderOptions)

Applies to