flip/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/DefinitelyTyped.git synced 2026-02-06 10:56:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[office-js, office-js-preview, office-runtime] change sso status from… (#46683)

Browse Source 
* [office-js, office-js-preview, office-runtime] change sso status from preview to release

* review changes

* aligning asterisks

* remove trailing whitespace

* review changes

* review change
This commit is contained in:
Rick-Kirkham 2020-08-12 11:40:20 -07:00 committed by GitHub
parent 15a0bbbffa
commit e9a1eb208a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 194 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
types/office-js-preview/index.d.ts vendored
View File

@ -1181,18 +1181,16 @@ declare namespace Office {
}
/**
* The Office Auth namespace, Office.context.auth, provides a method that allows the Office host to obtain an access token to the add-in's web application.
* The Office Auth namespace, `Office.context.auth`, provides a method that allows the Office client application to obtain an access token to the add-in's web application.
* Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
*
* @beta
*/
interface Auth {
/**
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
* Server side code can use this token to access Microsoft Graph for the add-in's web application by using the
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
* Server-side code can use this token to access Microsoft Graph for the add-in's web application by using the
* {@link https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}.
*
* Important: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* @remarks
*
@ -1200,22 +1198,20 @@ declare namespace Office {
*
* **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI}
*
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign-in with Organizational
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
*
* @param options - Optional. Accepts an AuthOptions object to define sign-on behaviors.
* @param callback - Optional. Accepts a callback method that can use parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
* If AsyncResult.status is "succeeded", then AsyncResult.value is the raw AAD v. 2.0-formatted access token.
*
* @beta
* @param options - Optional. Accepts an `AuthOptions object` to define sign-on behaviors.
* @param callback - Optional. Accepts a callback method that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
* If `AsyncResult.status` is "succeeded", then `AsyncResult.value` is the raw AAD v. 2.0-formatted access token.
*/
getAccessTokenAsync(options?: AuthOptions, callback?: (result: AsyncResult<string>) => void): void;
/**
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
* Server side code can use this token to access Microsoft Graph for the add-in's web application by using the
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
* Server-side code can use this token to access Microsoft Graph for the add-in's web application by using the
* {@link https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}.
*
* Important: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* @remarks
*
@ -1223,41 +1219,62 @@ declare namespace Office {
*
* **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI}
*
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign-in with Organizational
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
*
* @param callback - Optional. Accepts a callback method that can use parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
* If AsyncResult.status is "succeeded", then AsyncResult.value is the raw AAD v. 2.0-formatted access token.
*
* @beta
* @param callback - Optional. Accepts a callback method that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
* If `AsyncResult.status` is "succeeded", then `AsyncResult.value` is the raw AAD v. 2.0-formatted access token.
*/
getAccessTokenAsync(callback?: (result: AsyncResult<string>) => void): void;
}
/**
* Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2.0 with the getAccessTokenAsync method.
* Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2.0 with the `getAccessTokenAsync` method.
*/
interface AuthOptions {
/**
* Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or if the user's consent has
* been revoked.
* Allows Office to get an access token silently or through interactive consent, if one is required. Default value is `false`.
* If set to `false`, Office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
* If set to `true`, Office will show an interactive consent UI after it fails to silently get an access token.
* The prompt will only allow consent to the AAD profile scope, not to any Microsoft Graph scopes.
*/
forceConsent?: boolean,
allowConsentPrompt?: boolean;
/**
* Prompts the user to add their Office account (or to switch to it, if it is already added).
* Allows Office to get an access token silently provided consent is present or show interactive UI to sign in the user. Default value is `false`.
* If set to `false`, Office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
* If set to `true`, Office will show an interactive sign-in UI after it fails to silently get an access token.
*/
forceAddAccount?: boolean,
allowSignInPrompt?: boolean;
/**
* Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is `false`.
*
* @deprecated Use `allowSignInPrompt` instead.
*/
forceAddAccount?: boolean;
/**
* Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or if the user's consent has
* been revoked. Default value is `false`.
*
* @deprecated Use `allowConsentPrompt` instead.
*/
forceConsent?: boolean;
/**
* Causes Office to prompt the user to provide the additional factor when the tenancy being targeted by Microsoft Graph requires multifactor
* authentication. The string value identifies the type of additional factor that is required. In most cases, you won't know at development
* time whether the user's tenant requires an additional factor or what the string should be. So this option would be used in a "second try"
* call of getAccessTokenAsync after Microsoft Graph has sent an error requesting the additional factor and containing the string that should
* be used with the authChallenge option.
* call of `getAccessTokenAsync` after Microsoft Graph has sent an error requesting the additional factor and containing the string that should
* be used with the `authChallenge` option.
*/
authChallenge?: string
authChallenge?: string;
/**
* A user-defined item of any type that is returned, unchanged, in the asyncContext property of the AsyncResult object that is passed to a callback.
* A user-defined item of any type that is returned, unchanged, in the `asyncContext` property of the `AsyncResult` object that is passed to a callback.
*/
asyncContext?: any
asyncContext?: any;
/**
* Causes Office to return a descriptive error when the add-in wants to access Microsoft Graph and the user/admin has not granted consent to Graph scopes. Default value is `false`.
* Office only supports consent to Graph scopes when the add-in has been deployed by a tenant admin. This information will not be available during development.
* Setting this option to `true` will cause Office to inform your add-in beforehand (by returning a descriptive error) if Graph access will fail.
*/
forMSGraphAccess?: boolean;
}
/**
* Provides an option for preserving context data of any type, unchanged, for use in a callback.

97
types/office-js/index.d.ts vendored
View File

@ -1021,7 +1021,102 @@ declare namespace Office {
*/
asyncContext?: any
}
/**
* The Office Auth namespace, `Office.context.auth`, provides a method that allows the Office client application to obtain an access token to the add-in's web application.
* Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
*/
interface Auth {
/**
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
* Server-side code can use this token to access Microsoft Graph for the add-in's web application by using the
* {@link https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}.
*
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* @remarks
*
* **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
*
* **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI}
*
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
*
* @param options - Optional. Accepts an `AuthOptions object` to define sign-on behaviors.
* @param callback - Optional. Accepts a callback method that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
* If `AsyncResult.status` is "succeeded", then `AsyncResult.value` is the raw AAD v. 2.0-formatted access token.
*/
getAccessTokenAsync(options?: AuthOptions, callback?: (result: AsyncResult<string>) => void): void;
/**
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
* Server-side code can use this token to access Microsoft Graph for the add-in's web application by using the
* {@link https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}.
*
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* @remarks
*
* **Hosts**: Excel, OneNote, Outlook, PowerPoint, Word
*
* **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/identity-api-requirement-sets | IdentityAPI}
*
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
*
* @param callback - Optional. Accepts a callback method that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
* If `AsyncResult.status` is "succeeded", then `AsyncResult.value` is the raw AAD v. 2.0-formatted access token.
*/
getAccessTokenAsync(callback?: (result: AsyncResult<string>) => void): void;
}
/**
* Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2.0 with the `getAccessTokenAsync` method.
*/
interface AuthOptions {
/**
* Allows Office to get an access token silently or through interactive consent, if one is required. Default value is `false`.
* If set to `false`, Office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
* If set to `true`, Office will show an interactive consent UI after it fails to silently get an access token.
* The prompt will only allow consent to the AAD profile scope, not to any Microsoft Graph scopes.
*/
allowConsentPrompt?: boolean;
/**
* Allows Office to get an access token silently provided consent is present or show interactive UI to sign in the user. Default value is `false`.
* If set to `false`, Office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
* If set to `true`, Office will show an interactive sign-in UI after it fails to silently get an access token.
*/
allowSignInPrompt?: boolean;
/**
* Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is `false`.
*
* @deprecated Use `allowSignInPrompt` instead.
*/
forceAddAccount?: boolean;
/**
* Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or if the user's consent has
* been revoked. Default value is `false`.
*
* @deprecated Use `allowConsentPrompt` instead.
*/
forceConsent?: boolean;
/**
* Causes Office to prompt the user to provide the additional factor when the tenancy being targeted by Microsoft Graph requires multifactor
* authentication. The string value identifies the type of additional factor that is required. In most cases, you won't know at development
* time whether the user's tenant requires an additional factor or what the string should be. So this option would be used in a "second try"
* call of `getAccessTokenAsync` after Microsoft Graph has sent an error requesting the additional factor and containing the string that should
* be used with the `authChallenge` option.
*/
authChallenge?: string;
/**
* A user-defined item of any type that is returned, unchanged, in the `asyncContext` property of the `AsyncResult` object that is passed to a callback.
*/
asyncContext?: any;
/**
* Causes Office to return a descriptive error when the add-in wants to access Microsoft Graph and the user/admin has not granted consent to Graph scopes. Default value is `false`.
* Office only supports consent to Graph scopes when the add-in has been deployed by a tenant admin. This information will not be available during development.
* Setting this option to `true` will cause Office to inform your add-in beforehand (by returning a descriptive error) if Graph access will fail.
*/
forMSGraphAccess?: boolean;
}
/**
* Provides an option for preserving context data of any type, unchanged, for use in a callback.
*/

98
types/office-runtime/index.d.ts vendored
View File

@ -164,73 +164,75 @@ declare namespace OfficeRuntime {
}
/**
* Contains authorization related APIs.
* @beta
*/
const auth: Auth;
/**
* Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2.0 with the getAccessToken method.
* @beta
*/
interface AuthOptions {
/**
* Allows Office to get an access token silectly or through interactive consent, if one is required.
* If set to false, Office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
* If set to true, Office will show an interactive consent UI after it fails to silently get an access token.
* The prompt will only allow consent to the AAD profile scope, not to any Microsoft Graph scopes.
* Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2.0 with the `getAccessToken` method.
*/
allowConsentPrompt?: boolean;
/**
* Allows Office to get an access token silently provided consent is present or show interactive UI to sign in the user.
* If set to false, office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
* If set to true, Office will show an interactive sign-in UI after it fails to silently get an access token.
*/
allowSignInPrompt?: boolean;
/**
* Deprecated
* Prompts the user to add their Office account (or to switch to it, if it is already added).
*/
forceAddAccount?: boolean;
/**
* Causes Office to prompt the user to provide the additional factor when the tenancy being targeted by Microsoft Graph requires multifactor
* authentication. The string value identifies the type of additional factor that is required. In most cases, you won't know at development
* time whether the user's tenant requires an additional factor or what the string should be. So this option would be used in a "second try"
* call of getAccessToken after Microsoft Graph has sent an error requesting the additional factor and containing the string that should
* be used with the authChallenge option.
*/
authChallenge?: string;
/**
* A user-defined item of any type that is returned, unchanged, in the asyncContext property of the AsyncResult object that is passed to a callback.
*/
asyncContext?: any;
/**
* Causes Office to return descriptive error when the add-in wants to access MS Graph and the user/admin has not granted consent to MS Graph scopes.
* Office only supports consent to graph scopes when the add-in has been deployed by a tenant admin. This information will not be available during development.
* Setting this option to true will allow Office to inform your add-in beforehand if MS graph access will fail by returning back a descriptive error.
*/
forMSGraphAccess?: boolean;
interface AuthOptions {
/**
* Allows Office to get an access token silently or through interactive consent, if one is required. Default value is `false`.
* If set to `false`, Office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
* If set to `true`, Office will show an interactive consent UI after it fails to silently get an access token.
* The prompt will only allow consent to the AAD profile scope, not to any Microsoft Graph scopes.
*/
allowConsentPrompt?: boolean;
/**
* Allows Office to get an access token silently provided consent is present or show interactive UI to sign in the user. Default value is `false`.
* If set to `false`, Office will silently try to get an access token. If it fails to do so, Office will return a descriptive error.
* If set to `true`, Office will show an interactive sign-in UI after it fails to silently get an access token.
*/
allowSignInPrompt?: boolean;
/**
* Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is `false`.
*
* @deprecated Use `allowSignInPrompt` instead.
*/
forceAddAccount?: boolean;
/**
* Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or if the user's consent has
* been revoked. Default value is `false`.
*
* @deprecated Use `allowConsentPrompt` instead.
*/
forceConsent?: boolean;
/**
* Causes Office to prompt the user to provide the additional factor when the tenancy being targeted by Microsoft Graph requires multifactor
* authentication. The string value identifies the type of additional factor that is required. In most cases, you won't know at development
* time whether the user's tenant requires an additional factor or what the string should be. So this option would be used in a "second try"
* call of `getAccessToken` after Microsoft Graph has sent an error requesting the additional factor and containing the string that should
* be used with the `authChallenge` option.
*/
authChallenge?: string;
/**
* A user-defined item of any type that is returned, unchanged, in the `asyncContext` property of the `AsyncResult` object that is passed to a callback.
*/
asyncContext?: any;
/**
* Causes Office to return a descriptive error when the add-in wants to access Microsoft Graph and the user/admin has not granted consent to Graph scopes. Default value is `false`.
* Office only supports consent to Graph scopes when the add-in has been deployed by a tenant admin. This information will not be available during development.
* Setting this option to `true` will cause Office to inform your add-in beforehand (by returning a descriptive error) if Graph access will fail.
*/
forMSGraphAccess?: boolean;
}
/**
* Interface that contains authorization related APIs.
* @beta
*/
interface Auth {
/**
* Calls the Azure Active Directory V 2.0 endpoint to get an access token to your add-in's web application. Enables add-ins to identify users.
* Server side code can use this token to access Microsoft Graph for the add-in's web application by using the
* Server-side code can use this token to access Microsoft Graph for the add-in's web application by using the
* {@link https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of | "on behalf of" OAuth flow}.
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign-in with Organizational
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
*
* Important: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
* **Important**: In Outlook, this API is not supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
*
* @remarks
*
* **Hosts**: Excel, PowerPoint, Word
* **Hosts**: Excel, Outlook, PowerPoint, Word
*
* @beta
*
* @param options - Optional. Accepts an AuthOptions object to define sign-on behaviors.
* @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
* returns: Promise to the access token.
*/
getAccessToken(options?: AuthOptions): Promise<string>;