Codeunit 9024 Azure AD Graph User
src/System Application/App/Azure AD User/src/AzureADGraphUser.Codeunit.al228 lines, Copyright (c) Microsoft Corporation. MIT
// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace System.Azure.Identity;using System;using System.Security.AccessControl;/// <summary>/// Exposes functionality to retrieve and update Microsoft Entra users./// </summary>codeunit 9024 "Azure AD Graph User"{ Access = Public; InherentEntitlements = X; InherentPermissions = X; var [NonDebuggable] AzureADGraphUserImpl: Codeunit "Azure AD Graph User Impl."; /// <summary> /// Gets the Microsoft Entra user with the given security ID. /// </summary> /// <param name="UserSecurityId">The user's security ID.</param> /// <param name="User">The Microsoft Entra user.</param> [Scope('OnPrem')] [TryFunction] [NonDebuggable] procedure GetGraphUser(UserSecurityId: Guid; var User: DotNet UserInfo) begin AzureADGraphUserImpl.GetGraphUser(UserSecurityId, false, User); end; /// <summary> /// Gets the Microsoft Entra user with the given security ID. /// </summary> /// <param name="UserSecurityId">The user's security ID.</param> /// <param name="ForceFetchFromGraph">Forces a graph call to get the latest details for the user.</param> /// <param name="User">The Microsoft Entra user.</param> [Scope('OnPrem')] [TryFunction] [NonDebuggable] procedure GetGraphUser(UserSecurityId: Guid; ForceFetchFromGraph: Boolean; var User: DotNet UserInfo) begin AzureADGraphUserImpl.GetGraphUser(UserSecurityId, ForceFetchFromGraph, User); end; /// <summary> /// Retrieves the user’s unique identifier, which is its object ID, from Microsoft Entra. /// </summary> /// <param name="UserSecurityId">The user's security ID.</param> /// <returns> /// The object ID of the Microsoft Entra user, or an empty string if the user cannot be found. /// </returns> [Scope('OnPrem')] [NonDebuggable] procedure GetObjectId(UserSecurityId: Guid): Text begin exit(AzureADGraphUserImpl.GetObjectId(UserSecurityId)); end; /// <summary> /// Gets the user's authentication object ID. /// </summary> /// <param name="UserSecurityId">The user's security ID.</param> /// <error>User with Security ID UserSecurityId does not exist.</error> /// <returns>The user's authentication object ID.</returns> [Scope('OnPrem')] [NonDebuggable] procedure GetUserAuthenticationObjectId(UserSecurityId: Guid): Text begin exit(AzureADGraphUserImpl.GetUserAuthenticationObjectId(UserSecurityId)); end; /// <summary> /// Tries to get the user's authentication object ID. /// </summary> /// <param name="UserSecurityId">The user's security ID.</param> /// <param name="AuthenticationObjectId">Var parameter that hold the user's authention object ID.</param> /// <returns>True if the call was successful; otherwise - false.</returns> [Scope('OnPrem')] [NonDebuggable] procedure TryGetUserAuthenticationObjectId(UserSecurityId: Guid; var AuthenticationObjectId: Text): Boolean begin exit(AzureADGraphUserImpl.TryGetUserAuthenticationObjectId(UserSecurityId, AuthenticationObjectId)); end; /// <summary> /// Gets the user from a given Authentication object ID. /// </summary> /// <param name="AuthenticationObjectID">The user's Authentication object ID.</param> /// <param name="User">The user that has provided Authentication object ID.</param> /// <returns>True if the user was found, false otherwise.</returns> [Scope('OnPrem')] [NonDebuggable] procedure GetUser(AuthenticationObjectID: Text; var User: Record User): Boolean begin exit(AzureADGraphUserImpl.GetUser(AuthenticationObjectID, User)); end; /// <summary> /// Returns whether the current user is Delegated Admin. /// </summary> /// <returns>True if the current user is Delegated Admin, false otherwise.</returns> [NonDebuggable] procedure IsUserDelegatedAdmin(): Boolean begin exit(AzureADGraphUserImpl.IsUserDelegatedAdmin()); end; /// <summary> /// Returns whether the current user is Delegated Helpdesk. /// </summary> /// <returns>True if the current user is Delegated Helpdesk, false otherwise.</returns> [NonDebuggable] procedure IsUserDelegatedHelpdesk(): Boolean begin exit(AzureADGraphUserImpl.IsUserDelegatedHelpdesk()); end; /// <summary> /// Returns whether the current user is delegated. /// </summary> /// <returns>True if the current user is delegated, false otherwise.</returns> [NonDebuggable] procedure IsUserDelegated(): Boolean begin exit(AzureADGraphUserImpl.IsUserDelegated()); end; /// <summary> /// Updates the user record with information from Microsoft Entra. /// </summary> /// <param name="User">The user record to update.</param> /// <param name="AzureADUser">The Microsoft Entra user.</param> /// <returns>True if the user record has been updated. Otherwise, false.</returns> [Scope('OnPrem')] [NonDebuggable] procedure UpdateUserFromAzureGraph(var User: Record User; var AzureADUser: DotNet UserInfo): Boolean begin exit(AzureADGraphUserImpl.UpdateUserFromAzureGraph(User, AzureADUser)); end; /// <summary> /// Gets the authentication email of the provided Graph user. /// </summary> /// <remarks>Authentication email corresponds to userPrincipalName property on the Graph user.</remarks> /// <param name="GraphUserInfo">The Microsoft Entra user.</param> /// <returns>The authentication email of the provided Graph user. Can be used to assign to "Authentication Email" field on the User table.</returns> [Scope('OnPrem')] [NonDebuggable] procedure GetAuthenticationEmail(GraphUserInfo: DotNet UserInfo): Text[250] begin exit(AzureADGraphUserImpl.GetAuthenticationEmail(GraphUserInfo)); end; /// <summary> /// Gets the display name of the provided Graph user. /// </summary> /// <remarks>Display name corresponds to displayName property on the Graph user.</remarks> /// <param name="GraphUserInfo">The Microsoft Entra user.</param> /// <returns>The display name of the provided Graph user. Can be used to assign to "User Name" field on the User table.</returns> [Scope('OnPrem')] [NonDebuggable] procedure GetDisplayName(GraphUserInfo: DotNet UserInfo): Text[50] begin exit(AzureADGraphUserImpl.GetDisplayName(GraphUserInfo)); end; /// <summary> /// Gets the contact email of the provided Graph user. /// </summary> /// <remarks>Contact email corresponds to Mail property on the Graph user.</remarks> /// <param name="GraphUserInfo">The Microsoft Entra user.</param> /// <returns>The contact email of the provided Graph user. Can be used to assign to "Contact Email" field on the User table.</returns> [Scope('OnPrem')] [NonDebuggable] procedure GetContactEmail(GraphUserInfo: DotNet UserInfo): Text[250] begin exit(AzureADGraphUserImpl.GetContactEmail(GraphUserInfo)); end; /// <summary> /// Gets the full name of the provided Graph user. /// </summary> /// <remarks>Full name is composed from the combination of givenName and surname properties on the Graph user.</remarks> /// <param name="GraphUserInfo">The Microsoft Entra user.</param> /// <returns>The full name of the provided Graph user. Can be used to assign to "Full Name" field on the User table.</returns> [Scope('OnPrem')] [NonDebuggable] procedure GetFullName(GraphUserInfo: DotNet UserInfo): Text[80] begin exit(AzureADGraphUserImpl.GetFullName(GraphUserInfo)); end; /// <summary> /// Gets the preferred language ID of the provided Graph user. /// </summary> /// <remarks> /// Preferred language ID is derived from preferredLanguage property on the Graph user. /// If the preferred language is not set or it is set to a language that is not supported in Business Central, the function returns 0. /// </remarks> /// <param name="GraphUserInfo">The Microsoft Entra user.</param> /// <returns>The preferred language ID of the provided Graph user. Can be used to set the preferred language using the Language module.</returns> [Scope('OnPrem')] [NonDebuggable] procedure GetPreferredLanguageID(GraphUserInfo: DotNet UserInfo): Integer begin exit(AzureADGraphUserImpl.GetPreferredLanguageID(GraphUserInfo)); end; /// <summary> /// Ensures that an email address specified for authorization is not already in use by another database user. /// If it is, all the database users with this authentication email address are updated and their email /// addresses are updated the ones that are specified in Microsoft Entra. /// </summary> /// <param name="AuthenticationEmail">The authentication email address.</param> [Scope('OnPrem')] [NonDebuggable] procedure EnsureAuthenticationEmailIsNotInUse(AuthenticationEmail: Text) begin AzureADGraphUserImpl.EnsureAuthenticationEmailIsNotInUse(AuthenticationEmail); end;}