Skip to content

Commit 432bf66

Browse files
committed
CM-55782: Update README
1 parent 71f5eec commit 432bf66

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ To install the Cycode CLI application on your local machine, perform the followi
101101
./cycode
102102
```
103103

104-
3. Finally authenticate the CLI. There are three methods to set the Cycode client ID and client secret:
104+
3. Finally authenticate the CLI. There are three methods to set the Cycode client ID and credentials (client secret or OIDC ID token):
105105

106106
- [cycode auth](#using-the-auth-command) (**Recommended**)
107107
- [cycode configure](#using-the-configure-command)
@@ -164,11 +164,15 @@ To install the Cycode CLI application on your local machine, perform the followi
164164

165165
`Cycode Client ID []: 7fe5346b-xxxx-xxxx-xxxx-55157625c72d`
166166

167-
5. Enter your Cycode Client Secret value.
167+
5. Enter your Cycode Client Secret value (skip if you plan to use an OIDC ID token).
168168

169169
`Cycode Client Secret []: c1e24929-xxxx-xxxx-xxxx-8b08c1839a2e`
170170

171-
6. If the values were entered successfully, you'll see the following message:
171+
6. Enter your Cycode OIDC ID Token value (optional).
172+
173+
`Cycode ID Token []: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...`
174+
175+
7. If the values were entered successfully, you'll see the following message:
172176
173177
`Successfully configured CLI credentials!`
174178
@@ -193,6 +197,12 @@ and
193197
export CYCODE_CLIENT_SECRET={your Cycode Secret Key}
194198
```
195199

200+
If your organization uses OIDC authentication, you can provide the ID token instead (or in addition):
201+
202+
```bash
203+
export CYCODE_ID_TOKEN={your Cycode OIDC ID token}
204+
```
205+
196206
#### On Windows
197207

198208
1. From the Control Panel, navigate to the System menu:
@@ -207,7 +217,7 @@ export CYCODE_CLIENT_SECRET={your Cycode Secret Key}
207217

208218
<img height="30" src="https://raw.githubusercontent.com/cycodehq/cycode-cli/main/images/image3.png" alt="environments variables button"/>
209219

210-
4. Create `CYCODE_CLIENT_ID` and `CYCODE_CLIENT_SECRET` variables with values matching your ID and Secret Key, respectively:
220+
4. Create `CYCODE_CLIENT_ID` and `CYCODE_CLIENT_SECRET` variables with values matching your ID and Secret Key, respectively. If you authenticate via OIDC, add `CYCODE_ID_TOKEN` with your OIDC ID token value as well:
211221

212222
<img height="100" src="https://raw.githubusercontent.com/cycodehq/cycode-cli/main/images/image4.png" alt="environment variables window"/>
213223

@@ -321,6 +331,7 @@ The following are the options and commands available with the Cycode CLI applica
321331
| `-o`, `--output [rich\|text\|json\|table]` | Specify the output type. The default is `rich`. |
322332
| `--client-id TEXT` | Specify a Cycode client ID for this specific scan execution. |
323333
| `--client-secret TEXT` | Specify a Cycode client secret for this specific scan execution. |
334+
| `--id-token TEXT` | Specify a Cycode OIDC ID token for this specific scan execution. |
324335
| `--install-completion` | Install completion for the current shell.. |
325336
| `--show-completion [bash\|zsh\|fish\|powershell\|pwsh]` | Show completion for the specified shell, to copy it or customize the installation. |
326337
| `-h`, `--help` | Show options for given command. |

0 commit comments

Comments
 (0)