AbstractAcquireTokenParameterBuilder<T>.WithTenantId(String) Method

Reference

Definition

Namespace:: Microsoft.Identity.Client

Assembly:: Microsoft.Identity.Client.dll

Package:: Microsoft.Identity.Client v4.66.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overrides the tenant ID specified in the authority at the application level. This operation preserves the authority host (environment).

If an authority was not specified at the application level, the default used is https://login.microsoftonline.com/common.

public T WithTenantId (string tenantId);

member this.WithTenantId : string -> 'T

Public Function WithTenantId (tenantId As String) As T

Parameters

tenantId: String

Tenant ID of the Microsoft Entra ID tenant or a domain associated with this Microsoft Entra ID tenant, in order to sign-in a user of a specific organization only.

Returns

The builder to chain the .With methods.

Exceptions

ArgumentNullException

Thrown if tenantId is null or an empty string.

ArgumentException

Thrown if tenantId is not well-formatted (for example, has spaces).

MsalClientException

Thrown in more general exception scenarios (for ex. if the application was configured with an authority that does not allow tenants).

Remarks

The tenant should be more restrictive than the one configured at the application level, e.g. don't use "common". Does not affect authority validation, which is specified at the application level.

Applies to

通过