Sp-dev-docs: Can you please elaborate if we need to match the User-Agent's values to an Office 365 application?

Created on 27 Nov 2018  ·  6Comments  ·  Source: SharePoint/sp-dev-docs

Category

  • [x] Question

You say to decorate your web requests with the UserAgent string:

Enterprise application
NONISV|CompanyName|AppName/Version
Identify as NONISV and include Company Name, App Name separated by a pipe character and then adding Version number separated with a slash character

But you never mention whether or not the values in the User-Agent need to match an active Office 365 app key or not.

Does CompanyName, AppName and Version need to map to a valid Office365 application values?

Can someone provide an example / steps / a useful link to the steps we would follow to create such an office365 application with valid values?

ID: 9efe14fc-9d5d-a5fc-07ba-e013e89589e2
Version Independent ID: 5455b54e-997d-75e3-018a-0bf3f3b2180b
Content: Avoid getting throttled or blocked in SharePoint Online
Content Source: docs/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md
Service: sharepoint
GitHub Login: @spdevdocs
Microsoft Alias: spdevdocs

community help wanted question

All 6 comments

The above docs is for mainly for add-in but not the SPFx( There is no need to map to the other O365 application).
https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/register-sharepoint-add-ins

@Seiyasu so you are saying this user agent can be any string in the format like NONISV|RandomCompanyName|RandomAppName/123.0.456 and it will help prevent rate limiting? It does not have to match a app or add-in?

Hi. Pinging you again @Seiyasu to see if you have a chance to look at my follow up questions.

"If you have created an application, the recommendation is to register and use AppID and AppTitle – This will ensure the best overall experience and best path for any future issue resolution"

Not clear what the above means. What is AppID? is it the same as Client ID. And if we are already registering our app with ClientID/Secret, then there is nothing else to do which invoking the REST API's.

Is this the steps to follow to create this app?

First create an app-only principal, see:
https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azureacs

Here are the steps that I followed with our tenant:

Go to the sharepoint admin registration area:

https://xxxxxxxxxxx-admin.sharepoint.com/_layouts/15/appregnew.aspx

Click create on both Client ID and Client Secret and create a Title, etc.

Click create.

So is this then the app title ? What is the version? Why is this so vague!?

This issue is being closed as part of an issue list cleanup project. Issues with no activity in the past 6 months that aren't tracked by engineering as bugs were closed as part of this inititive. If this is still an issue, please follow the steps outlined to re-open the issue.

Was this page helpful?
0 / 5 - 0 ratings