current_principal_details()

Learn how to use the current_principal_details() function to return the details of the principal running the query.

Returns details of the principal running the query.

Syntax

current_principal_details()

Returns

The details of the current principal as a dynamic. The following table describes the returned fields.

FieldDescription
UserPrincipalNameThe sign-in identifier for users. For more information, see UPN.
IdentityProviderThe source that validates the identity of the principal.
AuthorityThe Microsoft Entra tenant ID.
MfaIndicates the use of multifactor authentication. For more information, see Access token claims reference.
TypeThe category of the principal: aaduser, aadapp, or aadgroup.
DisplayNameThe user-friendly name for the principal that is displayed in the UI.
ObjectIdThe Microsoft Entra object ID for the principal.
FQNThe Fully Qualified Name (FQN) of the principal. Valuable for security role management commands. For more information, see Referencing security principals.
CountryThe user’s country or region. This property is returned if the information is present. The value is a standard two-letter country or region code, for example, FR, JP, and SZ.
TenantCountryThe resource tenant’s country or region, set at a tenant level by an admin. This property is returned if the information is present. The value is a standard two-letter country or region code, for example, FR, JP, and SZ.
TenantRegionThe region of the resource tenant. This property is returned if the information is present. The value is a standard two-letter country or region code, for example, FR, JP, and SZ.

Example

print details=current_principal_details()

Example output

details
{
“Country”: “DE”,
“TenantCountry”: “US”,
“TenantRegion”: “WW”,
“UserPrincipalName”: “user@fabrikam.com”,
“IdentityProvider”: “https://sts.windows.net”,
“Authority”: “aaaabbbb-0000-cccc-1111-dddd2222eeee”,
“Mfa”: “True”,
“Type”: “AadUser”,
“DisplayName”: “James Smith (upn: user@fabrikam.com)”,
“ObjectId”: “aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb”,
“FQN”: null,
“Notes”: null
}