Skip to content

Commit 6d7fb8f

Browse files
docs: update readme and secrets baseline
1 parent f9cd926 commit 6d7fb8f

File tree

2 files changed

+40
-15
lines changed

2 files changed

+40
-15
lines changed

.secrets.baseline

Lines changed: 23 additions & 13 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": "2023-03-17T19:47:10Z",
6+
"generated_at": "2024-02-26T19:01:03Z",
77
"plugins_used": [
88
{
99
"name": "AWSKeyDetector"
@@ -70,15 +70,15 @@
7070
"hashed_secret": "d9e9019d9eb455a3d72a3bc252c26927bb148a10",
7171
"is_secret": false,
7272
"is_verified": false,
73-
"line_number": 119,
73+
"line_number": 118,
7474
"type": "Secret Keyword",
7575
"verified_result": null
7676
},
7777
{
7878
"hashed_secret": "32e8612d8ca77c7ea8374aa7918db8e5df9252ed",
7979
"is_secret": false,
8080
"is_verified": false,
81-
"line_number": 163,
81+
"line_number": 162,
8282
"type": "Secret Keyword",
8383
"verified_result": null
8484
}
@@ -98,15 +98,15 @@
9898
"hashed_secret": "e8fc807ce6fbcda13f91c5b64850173873de0cdc",
9999
"is_secret": false,
100100
"is_verified": false,
101-
"line_number": 5220,
101+
"line_number": 5683,
102102
"type": "Secret Keyword",
103103
"verified_result": null
104104
},
105105
{
106106
"hashed_secret": "fdee05598fdd57ff8e9ae29e92c25a04f2c52fa6",
107107
"is_secret": false,
108108
"is_verified": false,
109-
"line_number": 5221,
109+
"line_number": 5684,
110110
"type": "Secret Keyword",
111111
"verified_result": null
112112
}
@@ -136,15 +136,15 @@
136136
"hashed_secret": "d506bd5213c46bd49e16c634754ad70113408252",
137137
"is_secret": false,
138138
"is_verified": false,
139-
"line_number": 7661,
139+
"line_number": 7986,
140140
"type": "Secret Keyword",
141141
"verified_result": null
142142
},
143143
{
144144
"hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
145145
"is_secret": false,
146146
"is_verified": false,
147-
"line_number": 11192,
147+
"line_number": 11590,
148148
"type": "Secret Keyword",
149149
"verified_result": null
150150
}
@@ -154,15 +154,15 @@
154154
"hashed_secret": "d506bd5213c46bd49e16c634754ad70113408252",
155155
"is_secret": false,
156156
"is_verified": false,
157-
"line_number": 1333,
157+
"line_number": 1393,
158158
"type": "Secret Keyword",
159159
"verified_result": null
160160
},
161161
{
162162
"hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
163163
"is_secret": false,
164164
"is_verified": false,
165-
"line_number": 6510,
165+
"line_number": 8441,
166166
"type": "Secret Keyword",
167167
"verified_result": null
168168
}
@@ -172,33 +172,43 @@
172172
"hashed_secret": "8318df9ecda039deac9868adf1944a29a95c7114",
173173
"is_secret": false,
174174
"is_verified": false,
175-
"line_number": 6733,
175+
"line_number": 7053,
176176
"type": "Secret Keyword",
177177
"verified_result": null
178178
},
179179
{
180180
"hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
181181
"is_secret": false,
182182
"is_verified": false,
183-
"line_number": 7882,
183+
"line_number": 8245,
184184
"type": "Secret Keyword",
185185
"verified_result": null
186186
},
187187
{
188188
"hashed_secret": "b8e758b5ad59a72f146fcf065239d5c7b695a39a",
189189
"is_secret": false,
190190
"is_verified": false,
191-
"line_number": 10064,
191+
"line_number": 10479,
192192
"type": "Hex High Entropy String",
193193
"verified_result": null
194194
}
195195
],
196+
"test/unit/test_discovery_v2.py": [
197+
{
198+
"hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
199+
"is_secret": false,
200+
"is_verified": false,
201+
"line_number": 6882,
202+
"type": "Secret Keyword",
203+
"verified_result": null
204+
}
205+
],
196206
"test/unit/test_speech_to_text_v1.py": [
197207
{
198208
"hashed_secret": "b8473b86d4c2072ca9b08bd28e373e8253e865c4",
199209
"is_secret": false,
200210
"is_verified": false,
201-
"line_number": 411,
211+
"line_number": 432,
202212
"type": "Secret Keyword",
203213
"verified_result": null
204214
}

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ discovery = DiscoveryV1(version='2019-04-30',
176176
discovery.set_service_url('<url_as_per_region>')
177177
```
178178

179-
### Username and password
179+
#### Username and password
180180

181181
```python
182182
from ibm_watson import DiscoveryV1
@@ -187,7 +187,7 @@ discovery = DiscoveryV1(version='2019-04-30', authenticator=authenticator)
187187
discovery.set_service_url('<url_as_per_region>')
188188
```
189189

190-
### No Authentication
190+
#### No Authentication
191191

192192
```python
193193
from ibm_watson import DiscoveryV1
@@ -198,6 +198,21 @@ discovery = DiscoveryV1(version='2019-04-30', authenticator=authenticator)
198198
discovery.set_service_url('<url_as_per_region>')
199199
```
200200

201+
### MCSP
202+
203+
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.
204+
205+
```python
206+
from ibm_watson import AssistantV2
207+
from ibm_cloud_sdk_core.authenticators import MCSPAuthenticator
208+
209+
# In the constructor, letting the SDK manage the token
210+
authenticator = MCSPAuthenticator('apikey', 'token_service_endpoint')
211+
assistant = AssistantV2(version='2023-06-15',
212+
authenticator=authenticator)
213+
assistant.set_service_url('<url_as_per_region>')
214+
```
215+
201216
## Python version
202217

203218
Tested on Python 3.9, 3.10, and 3.11.

0 commit comments

Comments
 (0)