Skip to content

Commit 6d34fda

Browse files
docs: update readme and secrets baseline
1 parent 30d7009 commit 6d34fda

File tree

2 files changed

+72
-8
lines changed

2 files changed

+72
-8
lines changed

.secrets.baseline

Lines changed: 54 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"files": "package-lock.json|^.secrets.baseline$",
44
"lines": null
55
},
6-
"generated_at": "2022-08-16T19:52:06Z",
6+
"generated_at": "2024-02-26T18:58:05Z",
77
"plugins_used": [
88
{
99
"name": "AWSKeyDetector"
@@ -78,11 +78,47 @@
7878
],
7979
"results": {
8080
"README.md": [
81+
{
82+
"hashed_secret": "d4c3d66fd0c38547a3c7a4c6bdc29c36911bc030",
83+
"is_secret": false,
84+
"is_verified": false,
85+
"line_number": 155,
86+
"type": "Secret Keyword",
87+
"verified_result": null
88+
},
8189
{
8290
"hashed_secret": "32e8612d8ca77c7ea8374aa7918db8e5df9252ed",
8391
"is_secret": false,
8492
"is_verified": false,
85-
"line_number": 651,
93+
"line_number": 650,
94+
"type": "Secret Keyword",
95+
"verified_result": null
96+
}
97+
],
98+
"assistant/v2.ts": [
99+
{
100+
"hashed_secret": "4b28f8a2cf2d8920de88932ead405e6bddb15da2",
101+
"is_secret": false,
102+
"is_verified": false,
103+
"line_number": 3637,
104+
"type": "Secret Keyword",
105+
"verified_result": null
106+
}
107+
],
108+
"discovery/v1.ts": [
109+
{
110+
"hashed_secret": "e8fc807ce6fbcda13f91c5b64850173873de0cdc",
111+
"is_secret": false,
112+
"is_verified": false,
113+
"line_number": 5550,
114+
"type": "Secret Keyword",
115+
"verified_result": null
116+
},
117+
{
118+
"hashed_secret": "fdee05598fdd57ff8e9ae29e92c25a04f2c52fa6",
119+
"is_secret": false,
120+
"is_verified": false,
121+
"line_number": 5551,
86122
"type": "Secret Keyword",
87123
"verified_result": null
88124
}
@@ -138,7 +174,7 @@
138174
"hashed_secret": "1b214d8483f6b115656b6910c696e13e8881b66c",
139175
"is_secret": false,
140176
"is_verified": false,
141-
"line_number": 674,
177+
"line_number": 661,
142178
"type": "Secret Keyword",
143179
"verified_result": null
144180
}
@@ -148,15 +184,15 @@
148184
"hashed_secret": "789b49606c321c8cf228d17942608eff0ccc4171",
149185
"is_secret": false,
150186
"is_verified": false,
151-
"line_number": 224,
187+
"line_number": 221,
152188
"type": "Secret Keyword",
153189
"verified_result": null
154190
},
155191
{
156192
"hashed_secret": "6c475a361bc57d2e4e2f82a93d79efd8abc1c58b",
157193
"is_secret": false,
158194
"is_verified": false,
159-
"line_number": 257,
195+
"line_number": 254,
160196
"type": "Secret Keyword",
161197
"verified_result": null
162198
}
@@ -234,7 +270,17 @@
234270
"hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
235271
"is_secret": false,
236272
"is_verified": false,
237-
"line_number": 5973,
273+
"line_number": 5971,
274+
"type": "Secret Keyword",
275+
"verified_result": null
276+
}
277+
],
278+
"test/unit/discovery.v2.test.js": [
279+
{
280+
"hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
281+
"is_secret": false,
282+
"is_verified": false,
283+
"line_number": 3471,
238284
"type": "Secret Keyword",
239285
"verified_result": null
240286
}
@@ -264,13 +310,13 @@
264310
"hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
265311
"is_secret": false,
266312
"is_verified": false,
267-
"line_number": 435,
313+
"line_number": 436,
268314
"type": "Secret Keyword",
269315
"verified_result": null
270316
}
271317
]
272318
},
273-
"version": "0.13.1+ibm.50.dss",
319+
"version": "0.13.1+ibm.56.dss",
274320
"word_list": {
275321
"file": null,
276322
"hash": null

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,24 @@ To use IAM authentication, you must use an `IamAuthenticator` or a `BearerTokenA
141141

142142
To use the SDK in a Cloud Pak, use the `CloudPakForDataAuthenticator`. This will require a username, password, and URL.
143143

144+
##### MCSP
145+
146+
To use the SDK through a third party cloud provider (such as AWS), use the `MCSPAuthenticator`. This will require the base endpoint URL for the MCSP token service (e.g. https://iam.platform.saas.ibm.com) and an apikey.
147+
148+
```js
149+
import AssistantV2 from 'ibm-watson/assistant/v2'
150+
import { McspAuthenticator } from 'ibm-watson/auth';
151+
152+
# In the constructor, letting the SDK manage the token
153+
const authenticator = new McspAuthenticator({
154+
url: 'token_service_endpoint',
155+
apikey: 'apikey',
156+
})
157+
const assistant = AssistantV2(version='2023-06-15',
158+
authenticator=authenticator)
159+
assistant.setServiceUrl('<url_as_per_region>')
160+
```
161+
144162
### Cloud Authentication Prioritization
145163

146164
When uploading your application to IBM Cloud there is a certain priority Watson services will use when looking for proper credentials. The order is as follows:

0 commit comments

Comments
 (0)