@wazo/sdk 0.37.36 → 0.37.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -224,7 +224,7 @@ Wazo.Auth.fetchOptions({
224
224
  - Options passed to all the `fetch` requests of the SDK.
225
225
 
226
226
  ### Authenticating an user
227
- ```
227
+ ```js
228
228
  const session = await Wazo.Auth.logIn(username, password);
229
229
  ```
230
230
 
@@ -233,7 +233,12 @@ const session = await Wazo.Auth.logIn(username, password);
233
233
 
234
234
  - `password`: string
235
235
  - User's password
236
-
236
+
237
+ - `backend`: string
238
+ - Optional string. If omitted, defaults to wazo_user
239
+
240
+ - `tenantId`: string
241
+ - Optional string. The tenant identifier (uuid or slug). Needed when backend is external (not wazo_user)
237
242
  Returns as `Wazo.domain.Session`. This object contains, among other information, the user's token.
238
243
 
239
244
  Note: you need to set `clientId` in your WazoAPIClient in order to get a refresh token in the returned `Session`.