Skip to content

Commit a8d50b9

Browse files
authored
Merge pull request #92 from keycardai/seriousben/improve-impersonation-explanation
docs: clarify background agent terminology in impersonation example
2 parents d73eb54 + 159feb8 commit a8d50b9

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

packages/oauth/examples/impersonation_token_exchange/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The landing page is a web application where users sign in and grant the backgrou
1515

1616
The same landing page can be used again when new resources need to be authorized.
1717

18-
### Background agent (repeatable, offline)
18+
### Background agent (repeatable, non-interactive)
1919

2020
The background agent is a confidential client (e.g. `client_secret_basic` or workload identity).
2121

@@ -74,7 +74,7 @@ Set up the following in Keycard Console:
7474
uv sync
7575
```
7676

77-
### Step 2: Landing page (interactive, one-time)
77+
### Step 2: Landing page
7878

7979
Starts the landing page where users sign in and grant the background agent access to resources. In production, this would be deployed as a hosted web application. Resources are determined by the application's dependencies configured in Keycard Console.
8080

@@ -99,7 +99,7 @@ Open `http://localhost:3000` in a browser and click "Continue with Keycard".
9999

100100
After the user signs in, find their identifier in Keycard Console under the Users section. The Provider can be configured to map claims (e.g. `email`, `sub`) to the user identifier on creation. The identifier can also be changed from Keycard Console at any time.
101101

102-
### Step 4: Run background agent (offline, repeatable)
102+
### Step 4: Run background agent
103103

104104
The background agent obtains a resource token for the user without any browser interaction.
105105

packages/oauth/examples/impersonation_token_exchange/background_agent.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def main() -> None:
7676
load_dotenv()
7777

7878
parser = argparse.ArgumentParser(
79-
description="Background Agent: obtain a resource token on behalf of a user (offline)",
79+
description="Background Agent: obtain a resource token on behalf of a user (non-interactive)",
8080
)
8181
parser.add_argument(
8282
"--zone-url",

0 commit comments

Comments
 (0)