Skip to content

Commit 60f5057

Browse files
Update README for credential management terminology
1 parent fbf9772 commit 60f5057

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ Vigilnz Security Plugin integrates comprehensive security scanning capabilities
88
## Features
99

1010
- 🔒 **Multiple Scan Types**: Support for CVE, SAST, SBOM, and more
11-
- 🔐 **Secure Credential Management**: Store and manage Vigilnz API tokens securely
11+
- 🔐 **Secure Credential Management**: Store and manage Vigilnz API credentials securely
1212
- 🚀 **Freestyle & Pipeline Support**: Works with both traditional and modern Jenkins jobs
1313
- 📊 **Detailed Results**: View scan results directly in the Jenkins build sidebar
1414
- ⚙️ **Flexible Configuration**: Select which scan types to run per build
15-
- 🔄 **Token Management**: Automatic token refresh and caching
15+
- 🔄 **Credential Management**: Automatic refresh and caching
1616

1717
## Requirements
1818

@@ -53,7 +53,7 @@ Vigilnz Security Plugin integrates comprehensive security scanning capabilities
5353
1. Create a new Freestyle project or edit an existing one
5454
2. In **Build Steps**, click **Add build step****Invoke Vigilnz Security Task**
5555
3. Configure:
56-
- **Token**: Select your Vigilnz credential
56+
- **Credentials**: Select your Vigilnz credential
5757
- **Target File**: (Optional) File or path to scan
5858
- **Scan Types**: Select at least one scan type (CVE, SAST, SBOM)
5959
4. Save and run the build
@@ -68,13 +68,14 @@ pipeline {
6868
stage('Security Scan') {
6969
steps {
7070
vigilnzScan(
71-
token: 'my-vigilnz-token',
72-
scanTypes: ['cve', 'sast', 'sbom']
71+
credentialsId: 'my-vigilnz-creds',
72+
scanTypes: 'cve,sast,sbom'
7373
)
7474
}
7575
}
7676
}
7777
}
78+
7879
```
7980

8081
## Configuration
@@ -100,7 +101,7 @@ After a build completes:
100101
```groovy
101102
vigilnzScan(
102103
token: 'my-vigilnz-token',
103-
scanTypes: ['cve']
104+
scanTypes: 'cve'
104105
)
105106
```
106107

@@ -109,7 +110,7 @@ vigilnzScan(
109110
```groovy
110111
vigilnzScan(
111112
token: 'my-vigilnz-token',
112-
scanTypes: ['cve', 'sast', 'sbom']
113+
scanTypes: 'cve,sast,sbom'
113114
)
114115
```
115116

@@ -125,7 +126,7 @@ pipeline {
125126
withCredentials([string(credentialsId: 'vigilnz-token', variable: 'VIGILNZ_TOKEN')]) {
126127
vigilnzScan(
127128
token: 'vigilnz-token',
128-
scanTypes: ['cve', 'sast']
129+
scanTypes: 'cve,sast'
129130
)
130131
}
131132
}

0 commit comments

Comments
 (0)