Share via


AbstractAcquireTokenParameterBuilder<T>.WithTenantId(String) Method

Definition

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

T

The builder to chain the .With methods.

Exceptions

Thrown if tenantId is null or an empty string.

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

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