Skip to content

Commit 5102384

Browse files
committed
Update docs
1 parent 62f35c1 commit 5102384

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

jfrog-applications/jfrog-cli/get-started/configurations/jfrog-platform-configuration.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@ OIDC access tokens are not renewable. They are intended for one-time use during
100100

101101
This functionality is primarily designed for CI/CD pipelines use.
102102

103-
##### Example (non-interactive-only):
103+
##### Example :
104+
⚠️ **OIDC authentication must be used in non-interactive mode. Ensure --interactive=false is set.**
104105
```
105106
jf c add \
106107
--url=https://platform.jfrog.io \
@@ -221,7 +222,7 @@ refer to the [JFrog OIDC Integration](https://jfrog.com/help/r/jfrog-platform-ad
221222
OIDC tokens are short-lived and ⚠️**do not support refresh**⚠️.
222223
OIDC access tokens are not renewable. They are intended for one-time use during CI pipelines and do not have an automatic refresh mechanism like other tokens. Consequently, the authentication will only be valid for the duration of the pipeline or until the token expires.
223224

224-
The command is primarily designed for internal use, but it is available to allow users the flexibility to generate new OIDC tokens on demand.
225+
✅ This command can be used independently, or indirectly through `jf c add` when the required environment variables are set.
225226

226227
| | |
227228
|-------------------|----------------------------------------------------------------------------------|
@@ -230,7 +231,7 @@ The command is primarily designed for internal use, but it is available to allow
230231
| **Command arguments:** | |
231232
| `platformUrl` | <p>[Mandatory]</p><p>The URL of the JFrog Platform instance.</p> |
232233
| `oidc-provider-name`| <p>[Mandatory]</p><p>The name of the OIDC provider.</p> |
233-
| `oidc-token-id` | <p>[Mandatory]</p><p>The token ID from the OIDC provider.</p> |
234+
| `oidc-token-id` | <p>[Mandatory]</p><p>The OIDC token (JWT) issued by the CI provider. This is typically retrieved from a CI environment variable such as GitHub’s `ACTIONS_ID_TOKEN`.</p> |
234235
| **Command options:** | |
235236
| `--oidc-audience` | <p>[Optional]</p><p>The audience for the OIDC token.</p> |
236237
| `--oidc-provider-type`| <p>[Optional, default: GitHub]</p><p>The type of provider (e.g. GitHub).</p>|
@@ -241,14 +242,15 @@ The command is primarily designed for internal use, but it is available to allow
241242
### Example
242243

243244
```
244-
jf eot https://platform.jfrog.io \
245-
$JFROG_CLI_OIDC_EXCHANGE_TOKEN_ID \
246-
my-intergraion-name \
247-
--oidc-audience=my-audience \
248-
--oidc-provider-type=GitHub \
249-
--application-key=my-app-key \
250-
--project=my-project \
251-
--repository=my-repo
245+
jf eot \
246+
https://platform.jfrog.io \
247+
$JFROG_CLI_OIDC_EXCHANGE_TOKEN_ID \
248+
my-integration-name \
249+
--oidc-audience=my-audience \
250+
--oidc-provider-type=GitHub \
251+
--application-key=my-app-key \
252+
--project=my-project \
253+
--repository=my-repo
252254
```
253255
254256
### Sample Output

0 commit comments

Comments
 (0)