'''MS graph permissions is a UMS backend requirement from version 8.5.203 which was released in June 2021"'''
'''MS graph permissions are required by these UMS modules'''
'''MS graph permissions are required by these UMS modules (OneNote, Sharepoint and MS Teams)'''
*'''LiveAtEdu'''
*'''OneNote'''
<br />
*'''SharePoint'''
*'''Office 365 Time blocks'''
*'''MS Teams'''
==Creating App Registration==
==Creating App Registration==
Go to [http://portal.azure.com Azure Portal] and login with you admin account.
When logged in go to Azure Active Directory:[[File:Graph1.jpg|left|thumb|832x832px]]
Go to [http://portal.azure.com Azure Portal] and login with you admin account( '''the same UMS uses''').
'''!!! ATTENTION !!! use service account that UMS uses'''
When logged in go to Azure Active Directory:
<br />
[[File:Graph1.jpg|left|thumb|832x832px]]
Line 48:
Line 23:
Give the new App a name ex. "UMSGraph", Choose "Web app / API" in Application type, set "Sign-on URL" to "http://localhost". After setting Application Permission values click "Create"
Give the new App a name ex. "UMSGraph", Choose "Web app / API" in Application type, set "Sign-on URL" to "http://localhost". After setting Application Permission values click "Create"
[[File:Graph43.jpg|none|thumb|913x913px]]
[[File:Graph43.jpg|none|thumb|913x913px]]
You will return to previous screen, here click "your new app"
You will return to previous screen, here click "your new app"
[[File:Grahp5.jpg|none|thumb|905x905px]]
[[File:Grahp5.jpg|none|thumb|905x905px]]
Line 60:
Line 37:
Click "Add"
Click "Add"
[[File:Graph6.jpg|none|thumb|908x908px]]
[[File:Graph6.jpg|none|thumb|908x908px]]
Line 65:
Line 43:
'''!!! ATTENTION !!! the key value will never be visible again so ensure to copy it.''' [[File:Graph7.png|none|thumb|790x790px]]
'''!!! ATTENTION !!! the key value will never be visible again so ensure to copy it.''' [[File:Graph7.png|none|thumb|790x790px]]
Line 83:
Line 62:
[[File:Graph8.png|none|thumb|780x780px]]
[[File:Graph8.png|none|thumb|780x780px]]
======API and Permissions======
==Setup SharePoint, OneNote Class Notebook or Onedrive provisioning==
'''You do not need to fill out the settings in UMS (This was done in the above text) when using OneDrive provisioning.''' Only the "Add SharePoint App permissions" chapter.
*Azure Active Directory Graph 17 (Delegated Permissions)
In the UMS Configurator go to Modules->Office 365 and click "SharePoint organization settings"
<span id="SharePointOrganizationSettings">Input</span> your "Tenant Name" ex. "cortenso'''.onmicrosoft.com'''", insert Application ID into "Client ID" field, insert "Client secret" and "Tenant ID" and click "Ok"
<span id="SharePointOrganizationSettings">Input</span> your "Tenant Name" ex. "cortenso'''.onmicrosoft.com'''", paste the previously copied Application ID into "Client ID" field and paste previously copied KEY into "Client secret" and click "Ok"
You are now all set to use the new MS Graph integration.
==Permissions overview==
==Permissions overview==
<br />
===Microsoft Graph===
{| class="wikitable sortable"
{| class="wikitable sortable"
|+Default permissions
|+Default permissions
Line 1,302:
Line 112:
!Used for
!Used for
!Used by
!Used by
|-
|Mail.Send
|Application
|Microsoft Graph
|Send mail from UMS programs
|All programs if selected under mail accounts
|-
|-
|User.ReadWrite.All
|User.ReadWrite.All
Line 1,345:
Line 161:
|Microsoft Graph
|Microsoft Graph
|Used to provision OneDrive for users
|Used to provision OneDrive for users
|Live_at_edu.exe
|-
|Mail.Send
|Application
|Microsoft Graph
|Used when sending mail from All UMS programs. If this is selected under service accounts and mail accounts
|
|-
|User.EnableDisableAccount.All
|Application
|Microsoft Graph
|Used for enabling and disabling users. Only applicable if not using Azure/Entra AD Sync
|Live_at_edu.exe
|Live_at_edu.exe
|}
|}
===Teams sync permissions===
{| class="wikitable sortable"
{| class="wikitable sortable"
|+Teams sync permissions
|+
!Permission name
!Permission name
!Permission type
!Permission type
Line 1,397:
Line 227:
|Live_at_edu.exe
|Live_at_edu.exe
|}
|}
__FORCETOC__
===Change Password when using Azure AD as login===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Directory.AccessAsUser.All
|Delegated
|Microsoft Graph
|
|UMS Web
|-
|User.Read
|Delegated
|Microsoft Graph
|
|UMS Web
|}
See also [[Password Change Azure AD]]
===Password Sync===
Go to "Microsoft Entra ID" -> "Roles and Administrators"
Note that this is not a graph permission.
{| class="wikitable"
|+
!Rolename
!Permission type
!API
!Used for
!Used by
|-
|Password Administrator
|ServicePrincipal
|Microsoft Graph
|Reset password for Users
|Password_Sync
|}
===SharePoint===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Sites.FullControl.All
|Application
|Microsoft Graph
|Have full control of all site collections
|Office365_SP_OneNote.exe
|-
|User.ReadWrite.All
|Application
|Microsoft Graph
|Read and write user profiles
|Office365_SP_OneNote.exe
|}
===OneNote===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Notes.ReadWrite.All
|Application
|Microsoft Graph
|
|Office365_SP_OneNote.exe
|}<br />
===Password Administrator===
To Add Password administrator roles. Click '''Roles and administrator'''
[[File:Passwordd.png|thumb|1167x1167px|none]]
*Click Add Assignments and Search for App Registrations name and Click Add.
[[File:Password1.png|1167x1167px|thumb|none]]
<br />
==FAQ :==
If you get this message when trying to reset password in Office365 using MS Graph Api. This is because user is global Admin and therefore MS graph can not Reset password
[[File:Passwordsync.png|none|thumb|1245x1245px]]The error message below, could indicate a user has roles in Azure/Entra meaning Graph cannot disable them, if the error still persists after removing all roles, it may be the result of Graph not having sufficient permissions, please make sure Graph has the User.EnableDisableAccount.All permission.
(DisableUsers) Error. Could not disable user - User - The user could have roles that does not allow this action. Insufficient privileges to complete the operation.
Latest revision as of 08:32, 5 November 2024
MS graph permissions are required by these UMS modules
Go to Azure Portal and login with you admin account.
When logged in go to Azure Active Directory:
Go to App registrations
Click on New application registration
Give the new App a name ex. "UMSGraph", Choose "Web app / API" in Application type, set "Sign-on URL" to "http://localhost". After setting Application Permission values click "Create"
You will return to previous screen, here click "your new app"
Click "Certificates & secrets"
Click "New Client Secret"
Enter a "Description" and set "Expires" to the interval that suits your needs.
Click "Add"
Copy "Value ID" We will use this later
!!! ATTENTION !!! the key value will never be visible again so ensure to copy it.
Copy the "VALUE Key into "UMS Configurator" field Client Secret
Copy the "Directory Tenant ID " into "UMS Configurator" Field Tenant ID
Copy the "Appplication Client ID " into "UMS Configurator" Field Client ID
Click "Api permissions"
Click "Add a permission"
Setup SharePoint, OneNote Class Notebook or Onedrive provisioning
You do not need to fill out the settings in UMS (This was done in the above text) when using OneDrive provisioning. Only the "Add SharePoint App permissions" chapter.
In the UMS Configurator go to Modules->Office 365 and click "SharePoint organization settings"
Choose your SharePoint organization setting and click "Edit..."
Input your "Tenant Name" ex. "cortenso.onmicrosoft.com", insert Application ID into "Client ID" field, insert "Client secret" and "Tenant ID" and click "Ok"
Add SharePoint App permissions
Go to https://<tenantname>-admin.sharepoint.com/_layouts/15/appinv.aspx
Enter app Id (AKA Client Id) and press lookup.
Copy paste the below text in Permission Request XML and save
Go to "Microsoft Entra ID" -> "Roles and Administrators"
Note that this is not a graph permission.
Rolename
Permission type
API
Used for
Used by
Password Administrator
ServicePrincipal
Microsoft Graph
Reset password for Users
Password_Sync
SharePoint
Permission name
Permission type
API
Used for
Used by
Sites.FullControl.All
Application
Microsoft Graph
Have full control of all site collections
Office365_SP_OneNote.exe
User.ReadWrite.All
Application
Microsoft Graph
Read and write user profiles
Office365_SP_OneNote.exe
OneNote
Permission name
Permission type
API
Used for
Used by
Notes.ReadWrite.All
Application
Microsoft Graph
Office365_SP_OneNote.exe
Password Administrator
To Add Password administrator roles. Click Roles and administrator
Click Add Assignments and Search for App Registrations name and Click Add.
FAQ :
If you get this message when trying to reset password in Office365 using MS Graph Api. This is because user is global Admin and therefore MS graph can not Reset password
The error message below, could indicate a user has roles in Azure/Entra meaning Graph cannot disable them, if the error still persists after removing all roles, it may be the result of Graph not having sufficient permissions, please make sure Graph has the User.EnableDisableAccount.All permission.
(DisableUsers) Error. Could not disable user - User - The user could have roles that does not allow this action. Insufficient privileges to complete the operation.