From 5513635f788f1e471adaf88e82be56dad9a49c71 Mon Sep 17 00:00:00 2001 From: KarishmaGhiya Date: Mon, 5 Aug 2024 12:59:16 -0700 Subject: [PATCH] [Identity] update docs for IDC and device code credentials (#30656) --- .../src/credentials/deviceCodeCredentialOptions.ts | 6 +++++- .../credentials/interactiveBrowserCredentialOptions.ts | 10 ++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/sdk/identity/identity/src/credentials/deviceCodeCredentialOptions.ts b/sdk/identity/identity/src/credentials/deviceCodeCredentialOptions.ts index 36d1a597ebb1..07969bb18c08 100644 --- a/sdk/identity/identity/src/credentials/deviceCodeCredentialOptions.ts +++ b/sdk/identity/identity/src/credentials/deviceCodeCredentialOptions.ts @@ -46,7 +46,11 @@ export interface DeviceCodeCredentialOptions */ tenantId?: string; /** - * The client (application) ID of an App Registration in the tenant. + * Client ID of the Microsoft Entra application that users will sign into. + * It is recommended that developers register their applications and assign appropriate roles. + * For more information, visit https://aka.ms/identity/AppRegistrationAndRoleAssignment. + * If not specified, users will authenticate to an Azure development application, + * which is not recommended for production scenarios. */ clientId?: string; /** diff --git a/sdk/identity/identity/src/credentials/interactiveBrowserCredentialOptions.ts b/sdk/identity/identity/src/credentials/interactiveBrowserCredentialOptions.ts index 0ef45bdb912d..c5074192bc8e 100644 --- a/sdk/identity/identity/src/credentials/interactiveBrowserCredentialOptions.ts +++ b/sdk/identity/identity/src/credentials/interactiveBrowserCredentialOptions.ts @@ -38,7 +38,11 @@ export interface InteractiveBrowserCredentialNodeOptions tenantId?: string; /** - * The client (application) ID of an App Registration in the tenant. + * The Client ID of the Microsoft Entra application that users will sign into. + * It is recommended that developers register their applications and assign appropriate roles. + * For more information, visit https://aka.ms/identity/AppRegistrationAndRoleAssignment. + * If not specified, users will authenticate to an Azure development application, + * which is not recommended for production scenarios. */ clientId?: string; @@ -66,8 +70,10 @@ export interface InteractiveBrowserCredentialInBrowserOptions extends Interactiv tenantId?: string; /** - * The client (application) ID of an App Registration in the tenant. + * The Client ID of the Microsoft Entra application that users will sign into. * This parameter is required on the browser. + * Developers need to register their applications and assign appropriate roles. + * For more information, visit https://aka.ms/identity/AppRegistrationAndRoleAssignment. */ clientId: string;