Edit

Share via

AzureActiveDirectoryInfo class

  • Reference
Package:
@microsoft/sp-page-context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This class is primarily used with the PageContext class. It provides information useful for communicating with Azure Active Directory.

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the AzureActiveDirectoryInfo class.

Properties

instanceUrl

This string returns the URL of the sign in page used to authenticate with Azure Active Directory.
tenantId

This Guid contains the Azure Active Directory's tenant id.
userId

This Guid contains the Azure Active Directory's user id.

Property Details

instanceUrl

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This string returns the URL of the sign in page used to authenticate with Azure Active Directory.

readonly instanceUrl: string;

Property Value

string

tenantId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This Guid contains the Azure Active Directory's tenant id.

readonly tenantId: Guid;

Property Value

Guid

userId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This Guid contains the Azure Active Directory's user id.

readonly userId: Guid;

Property Value

Guid