Update parameter comments for token audience to reflect accepting URLs
This commit is contained in:
Родитель
af44747e04
Коммит
fe03b464f5
|
@ -13,8 +13,8 @@ class ApplicationTokenCredentials extends tokenCredentialsBase_1.TokenCredential
|
|||
* @param {string} clientId The active directory application client id.
|
||||
* @param {string} domain The domain or tenant id containing this application.
|
||||
* @param {string} secret The authentication secret for the application.
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with.
|
||||
* @param {object} [tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
*/
|
||||
|
|
|
@ -16,8 +16,8 @@ class DeviceTokenCredentials extends tokenCredentialsBase_1.TokenCredentialsBase
|
|||
* @param {string} [clientId] The active directory application client id.
|
||||
* @param {string} [domain] The domain or tenant id containing this application. Default value is "common"
|
||||
* @param {string} [username] The user name for account in the form: "user@example.com".
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
|
||||
* for an example.
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with. Default environment is "Azure" popularly known as "Public Azure Cloud".
|
||||
|
|
|
@ -22,8 +22,8 @@ class UserTokenCredentials extends tokenCredentialsBase_1.TokenCredentialsBase {
|
|||
* @param {string} domain The domain or tenant id containing this application.
|
||||
* @param {string} username The user name for the Organization Id account.
|
||||
* @param {string} password The password for the Organization Id account.
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with.
|
||||
* @param {object} [tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
*/
|
||||
|
|
|
@ -46,8 +46,8 @@ if (process.env["AZURE_ADAL_LOGGING_ENABLED"]) {
|
|||
* @param {string} [options.clientId] The active directory application client id.
|
||||
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
|
||||
* for an example.
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.domain] The domain or tenant id containing this application. Default value "common".
|
||||
* @param {AzureEnvironment} [options.environment] The azure environment to authenticate with.
|
||||
* @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
|
|
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
@ -16,8 +16,8 @@ export class ApplicationTokenCredentials extends TokenCredentialsBase {
|
|||
* @param {string} clientId The active directory application client id.
|
||||
* @param {string} domain The domain or tenant id containing this application.
|
||||
* @param {string} secret The authentication secret for the application.
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with.
|
||||
* @param {object} [tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
*/
|
||||
|
|
|
@ -20,8 +20,8 @@ export class DeviceTokenCredentials extends TokenCredentialsBase {
|
|||
* @param {string} [clientId] The active directory application client id.
|
||||
* @param {string} [domain] The domain or tenant id containing this application. Default value is "common"
|
||||
* @param {string} [username] The user name for account in the form: "user@example.com".
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
|
||||
* for an example.
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with. Default environment is "Azure" popularly known as "Public Azure Cloud".
|
||||
|
|
|
@ -20,8 +20,8 @@ export class UserTokenCredentials extends TokenCredentialsBase {
|
|||
* @param {string} domain The domain or tenant id containing this application.
|
||||
* @param {string} username The user name for the Organization Id account.
|
||||
* @param {string} password The password for the Organization Id account.
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with.
|
||||
* @param {object} [tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
*/
|
||||
|
|
13
lib/login.ts
13
lib/login.ts
|
@ -37,9 +37,8 @@ if (process.env["AZURE_ADAL_LOGGING_ENABLED"]) {
|
|||
*/
|
||||
export interface AzureTokenCredentialsOptions {
|
||||
/**
|
||||
* @property {TokenAudience} [tokenAudience] - The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant.
|
||||
* It must be a string (preferrably in a guid format).
|
||||
* @property {TokenAudience} [tokenAudience] - The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
*/
|
||||
tokenAudience?: TokenAudience;
|
||||
/**
|
||||
|
@ -144,8 +143,8 @@ export interface LoginWithMSIOptions {
|
|||
* @param {string} [options.clientId] The active directory application client id.
|
||||
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
|
||||
* for an example.
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.domain] The domain or tenant id containing this application. Default value "common".
|
||||
* @param {AzureEnvironment} [options.environment] The azure environment to authenticate with.
|
||||
* @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
|
@ -647,8 +646,8 @@ export function withServicePrincipalSecret(clientId: string, secret: string, dom
|
|||
* @param {string} [options.clientId] The active directory application client id.
|
||||
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
|
||||
* for an example.
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.domain] The domain or tenant id containing this application. Default value "common".
|
||||
* @param {AzureEnvironment} [options.environment] The azure environment to authenticate with.
|
||||
* @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
|
|
|
@ -11,8 +11,8 @@ export declare class ApplicationTokenCredentials extends TokenCredentialsBase {
|
|||
* @param {string} clientId The active directory application client id.
|
||||
* @param {string} domain The domain or tenant id containing this application.
|
||||
* @param {string} secret The authentication secret for the application.
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with.
|
||||
* @param {object} [tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
*/
|
||||
|
|
|
@ -14,8 +14,8 @@ export declare class DeviceTokenCredentials extends TokenCredentialsBase {
|
|||
* @param {string} [clientId] The active directory application client id.
|
||||
* @param {string} [domain] The domain or tenant id containing this application. Default value is "common"
|
||||
* @param {string} [username] The user name for account in the form: "user@example.com".
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
|
||||
* for an example.
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with. Default environment is "Azure" popularly known as "Public Azure Cloud".
|
||||
|
|
|
@ -14,8 +14,8 @@ export declare class UserTokenCredentials extends TokenCredentialsBase {
|
|||
* @param {string} domain The domain or tenant id containing this application.
|
||||
* @param {string} username The user name for the Organization Id account.
|
||||
* @param {string} password The password for the Organization Id account.
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {AzureEnvironment} [environment] The azure environment to authenticate with.
|
||||
* @param {object} [tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
*/
|
||||
|
|
|
@ -11,9 +11,8 @@ import { MSITokenResponse } from "./credentials/msiTokenCredentials";
|
|||
*/
|
||||
export interface AzureTokenCredentialsOptions {
|
||||
/**
|
||||
* @property {TokenAudience} [tokenAudience] - The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant.
|
||||
* It must be a string (preferrably in a guid format).
|
||||
* @property {TokenAudience} [tokenAudience] - The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
*/
|
||||
tokenAudience?: TokenAudience;
|
||||
/**
|
||||
|
@ -112,8 +111,8 @@ export interface LoginWithMSIOptions {
|
|||
* @param {string} [options.clientId] The active directory application client id.
|
||||
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
|
||||
* for an example.
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.domain] The domain or tenant id containing this application. Default value "common".
|
||||
* @param {AzureEnvironment} [options.environment] The azure environment to authenticate with.
|
||||
* @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
|
@ -303,8 +302,8 @@ export declare function withServicePrincipalSecret(clientId: string, secret: str
|
|||
* @param {string} [options.clientId] The active directory application client id.
|
||||
* See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
|
||||
* for an example.
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid value is "graph". If tokenAudience is provided
|
||||
* then domain should also be provided and its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph' or any other resource like 'https://vault.azure.com/'.
|
||||
* If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
|
||||
* @param {string} [options.domain] The domain or tenant id containing this application. Default value "common".
|
||||
* @param {AzureEnvironment} [options.environment] The azure environment to authenticate with.
|
||||
* @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
|
||||
|
|
Загрузка…
Ссылка в новой задаче