Add doc for pop request options (#37584)

* Add doc for pop request options * delete pop sample * Update sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py Co-authored-by: Paul Van Eck <[email protected]> * Update sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py Co-authored-by: Paul Van Eck <[email protected]> --------- Co-authored-by: Paul Van Eck <[email protected]>
Azure · Oct 1, 2024 · e1e2e0f · e1e2e0f
1 parent 295c432
commit e1e2e0f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 25 deletions.
diff --git a/sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py b/sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py
@@ -17,9 +17,16 @@
 
 
 class PopTokenRequestOptions(TokenRequestOptions):
-    """Options to use for pop token requests."""
+    """Options to use for Proof-of-Possession (PoP) token requests."""
 
     pop: Union[bool, Mapping[str, str]]
+    """PoP token request options.
+
+    - If not specified or False, a non-PoP token request is made.
+    - If True, an mTLS PoP token request is made.
+    - If a dict, a Signed HTTP Request (SHR) PoP token request is made. The dict
+      must contain the "resource_request_method", "resource_request_url", and "nonce" keys.
+    """
 
 
 class InteractiveBrowserBrokerCredential(_InteractiveBrowserCredential):

diff --git a/sdk/identity/azure-identity-broker/samples/pop_sample.py b/sdk/identity/azure-identity-broker/samples/pop_sample.py