diff --git a/sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py b/sdk/identity/azure-identity-broker/azure/identity/broker/_browser.py index d27ba143d3ef..affe1f3291ea 100644 --- 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 deleted file mode 100644 index 77255a310b49..000000000000 --- a/sdk/identity/azure-identity-broker/samples/pop_sample.py +++ /dev/null @@ -1,24 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ -""" -This sample is intended to show how to get a Proof-of-Possession (PoP) token. -""" - -from azure.identity.broker import PopTokenRequestOptions, InteractiveBrowserBrokerCredential - -nonce = "nonce" # needs to be a valid nonce -resource_request_url = "url" # needs to be a valid URL -resource_request_method = "GET" # needs to be a valid HTTP method -request_options = PopTokenRequestOptions( - { - "pop": { - "nonce": nonce, - "resource_request_url": resource_request_url, - "resource_request_method": resource_request_method, - } - } -) -cred = InteractiveBrowserBrokerCredential(parent_window_handle="window_handle") -pop_token = cred.get_token_info("scope", options=request_options)