[Identity] update docs for IDC and device code credentials (Azure#30656)

azure-sdk · Aug 5, 2024 · 5513635 · 5513635
1 parent 9646966
commit 5513635
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git 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
@@ -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;