What are we even calling these things these days? Apps for SharePoint Online? Apps for Office 365?
This article is about the apps we build using the new app model that was introduced along with SharePoint 2013. It’s the main way of developing functionality for SharePoint Online.
The apps are hosted in Azure (or on the hosting provider of your choosing)
When these Apps are created/installed a Client secret is used to ensure that communication between your externally hosted app and SharePoint Online is secure and not coming from an attacker.
Unfortunately these certificates expire.
The article below talks about replacing them.
We also opened a ticket with Microsoft Premier Support which revealed a few more tidbits.
- It takes like 24 hours for the new certificate to propogate through your system, leaving your app out of commission for at least that long if you don’t renew before it expires.
- The article above mentions, but does not give an example of, extending the date from the default 1 year to 3 years. I’ve copied some of the correspondence with Mustaq Patel from Microsoft, who helped us through the process (Thanks Mustaq!)
Note for the scripts below, you’ll need your clientID this is in the web.config of your website that’s hosted in Azure. As luck would have it, the person at our company who would have had this info was on vacation. Since it’s in the web.config of the running app, it made sense to just pull the actual web.config in use. I did this via FTP, using the steps in this article to configure an FTP account to gain access to the server:
Update: You can also find the clientID by going to any sharepoint site that uses the app, Site Settings->Site App Permissions.
It’ll be the guid between the last pipe symbol and the @ symbol
(thanks to Mustaq for pointing this out!)
- Connect to MSOnline using tenant admin user with below powershell in SharePoint 2013 powershell
import-module MSOnline $msolcred = get-credential connect-msolservice -credential $msolcred
Get ServicePrincipals and keys. Printing $keys will give 3 records, replace each KeyId in key1, key2 and key3. You can also see EndDate of each key. Confirm if your expired key shows there. Also note that clientId needs to match as per your clientId.
$clientId = "29b6b386-62a6-45c7-beda-abbaea6eecf2<< CHANGE THIS" $keys = Get-MsolServicePrincipalCredential -AppPrincipalId $clientId Remove-MsolServicePrincipalCredential -KeyIds @("key1","key2","key3") -AppPrincipalId $clientId
Generate new ClientSecret for this clientID. Please note it uses clientId set in #2. Also ClientSecret is valid for 3 years.
$bytes = New-Object Byte 32 $rand = [System.Security.Cryptography.RandomNumberGenerator]::Create() $rand.GetBytes($bytes) $rand.Dispose() $newClientSecret = [System.Convert]::ToBase64String($bytes) $dtStart = [System.DateTime]::Now $dtEnd = $dtStart.AddYears(3) New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Symmetric -Usage Sign -Value $newClientSecret -StartDate $dtStart –EndDate $dtEnd New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Symmetric -Usage Verify -Value $newClientSecret -StartDate $dtStart –EndDate $dtEnd New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Password -Usage Verify -Value $newClientSecret -StartDate $dtStart –EndDate $dtEnd $newClientSecret
Copy the output of $newClientSecret.
Replace the Web.config with this ClientId and ClientSecret. Please note we don’t need SecondaryClientSecret appsettings.
Wait for 24 hours to propagate ClientSecret to SPO