-
Notifications
You must be signed in to change notification settings - Fork 13
APIGOV-31593 - update for use of static auth token #767
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sbolosan
wants to merge
9
commits into
master
Choose a base branch
from
APIGOV-31593
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+72
−48
Open
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
e85d6a3
APIGOV-31593 - update for use of static auth token
sbolosan e54b18d
APIGOV-31593 - update for client id and client secret formatting
sbolosan 6902656
APIGOV-31593 - update to remove version confusion
sbolosan b186392
Update administration-operation.md
lbadenhop 4e0fa52
Update deploy-your-agents-with-amplify-cli.md
lbadenhop c585859
APIGOV-31593 - update based on PR comments
sbolosan 31eb515
APIGOV-31593 - update based on PR comments
sbolosan 7b9e4b4
APIGOV-31593 - update formatting and duplicates
sbolosan 25b285c
APIGOV-31593 - min is 5 minutes
sbolosan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,8 +16,8 @@ Each Sensedia Gateway is represented by an Amplify environment allowing you to b | |
| ### Minimum requirements | ||
|
|
||
| * [Amplify Platform Service Account](/docs/integrate_with_central/cli_central/cli_install/#option-2---authenticate-and-authorize-your-service-account) | ||
| * [Sensedia API Gateway with API Manager v5](https://docs.sensedia.com/en/api-platform-guide/4.14.x.x/index.html) | ||
| * Client ID and Client Secret credentials for Sensedia API authentication | ||
| * [Sensedia API Gateway with API Manager](https://docs.sensedia.com/en/api-platform-guide/4.14.x.x/index.html) | ||
| * Sensedia authentication credentials (either Client ID Client Secret for OAuth or static token) | ||
sbolosan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Docker environment for running the agents | ||
| * Network connectivity from agent host to Sensedia API Gateway and Amplify platform | ||
|
|
||
|
|
@@ -32,14 +32,20 @@ The Sensedia agents are delivered as Docker images and can be deployed in any Do | |
|
|
||
| ### Authentication and authorization | ||
|
|
||
| The Sensedia agents use OAuth 2.0 client credentials flow for authentication with the Sensedia platform: | ||
| The authentication method is automatically detected based on the configured credentials. Configure either `SENSEDIA_AUTH_CLIENTID` and `SENSEDIA_AUTH_CLIENTSECRET` for OAuth, or `SENSEDIA_AUTH_TOKEN` for Static Token Authentication. | ||
|
|
||
| 1. **Client Credentials**: The agent uses a configured Client ID and Client Secret | ||
| 2. **Token Endpoint**: Authentication requests are made to `/user-management/v1/oauth2/token` | ||
| 3. **Bearer Token**: All API calls use the obtained Bearer token | ||
| 4. **Token Refresh**: The agent automatically refreshes tokens when they expire | ||
| The Sensedia agents support two authentication methods: | ||
|
|
||
| The Bearer token includes tenant information, so no additional tenant configuration is required. | ||
| * **OAuth 2.0 Client Credentials** | ||
| 1. **Client Credentials**: The agent uses a configured Client ID and Client Secret | ||
| 2. **Token Endpoint**: Authentication requests are made to `/user-management/v1/oauth2/token` | ||
| 3. **Bearer Token**: All API calls use the obtained Bearer token with `Authorization: Bearer <token>` header | ||
| 4. **Token Refresh**: The agent automatically refreshes tokens when they expire | ||
|
|
||
| * **Static Token Authentication** | ||
| 1. **Static Token**: The agent uses a pre-configured authentication token | ||
| 2. **Header**: All API calls include the `Sensedia-Auth: <token>` header | ||
| 3. **No Refresh**: Static tokens do not expire and require no refresh mechanism | ||
|
|
||
| ## Discovery Agent features | ||
|
|
||
|
|
@@ -125,10 +131,11 @@ The Traceability Agent collects API call metrics from Sensedia environments and | |
| ### Environment variables | ||
|
|
||
| | Variable | Description | Required | Default | Example | | ||
| |----------|-------------|----------|---------|---------| | ||
| |----------|-------------|----------|---------|---------| | ||
| | `SENSEDIA_BASEURL` | Sensedia platform base URL | Yes | | `https://platform-production.sensedia.com` | | ||
| | `SENSEDIA_AUTH_CLIENTID` | Client ID for authentication | Yes | | `id` | | ||
| | `SENSEDIA_AUTH_CLIENTSECRET` | Client Secret for authentication | Yes | | `<secret>` | | ||
| | `SENSEDIA_AUTH_CLIENTID` | Client ID for OAuth authentication | No | | `id` | | ||
| | `SENSEDIA_AUTH_CLIENTSECRET` | Client Secret for OAuth authentication | No | | `<secret>` | | ||
| | `SENSEDIA_AUTH_TOKEN` | Static authentication token | No | | `your-static-token` | | ||
| | `SENSEDIA_DEVELOPEREMAIL` | Email for application creation (Discovery Agent only) | Yes | | `[email protected]` | | ||
| | `SENSEDIA_ENVIRONMENTS` | Comma-separated list of environments | No | `""` (all environments) | `Production,Development` | | ||
| | `SENSEDIA_FILTER` | API discovery filter expression | No | `""` (no filtering) | `tag.Axway_axway.Exists()` | | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.