# @acoustic-content-sdk/cli-credentials

> Helper library to store and retrieve credentials for the CLI.

Latest version **9.0.10076** (published 2020-03-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @acoustic-content-sdk/cli-credentials
pnpm add @acoustic-content-sdk/cli-credentials
yarn add @acoustic-content-sdk/cli-credentials
bun add @acoustic-content-sdk/cli-credentials
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 9.0.10076 |
| Published | 2020-03-26 |
| First published | 2019-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 576.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Carsten Leue |
| Maintainers | carstenleue, daherbst, jim.patrick, joe.john, kevintap, mburati, neelkanthpatel, orenaksakal |
| Keywords | acoustic, acoustic-content, cli, sdk |

## Links

- npm: https://www.npmjs.com/package/@acoustic-content-sdk/cli-credentials
- npm.io page: https://npm.io/package/@acoustic-content-sdk/cli-credentials

## Dependencies (1)

- [@acoustic-content-sdk/api](https://npm.io/package/@acoustic-content-sdk/api.md) 9.0.10076

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 9.0.10076 (latest) — 2020-03-26
- 8.0.498 (beta) — 2019-11-30
- 9.0.10067 — 2020-03-25
- 9.0.10040 — 2020-03-20
- 9.0.10034 — 2020-03-20
- 9.0.495 — 2020-03-09
- 9.0.493 — 2020-03-08
- 9.0.462 — 2020-03-05
- 9.0.407 — 2020-02-28
- 9.0.384 — 2020-02-25
- 9.0.361 — 2020-02-21
- 9.0.360 — 2020-02-21
- 9.0.271 — 2020-02-11
- 9.0.270 — 2020-02-11
- 9.0.251 — 2020-02-07
- … 6 more at https://npm.io/package/@acoustic-content-sdk/cli-credentials/versions

## README

<a name="_6913f88f95c502a5676855704e294f758fbba43313d62473134fd06c5d88c386"></a>
[![npm](https://img.shields.io/npm/v/@acoustic-content-sdk/cli-credentials.svg?style=flat-square)](https://www.npmjs.com/package/@acoustic-content-sdk/cli-credentials)

# Credential Management for WCH CLI

Utility library to manage credentials for use with WCH CLI projects.

## Installation

Local install for use from an [NPM script](https://docs.npmjs.com/misc/scripts):

```bash
npm install --save-dev @acoustic-content-sdk/cli-credentials
```

## Class documentation

Refer to the [API documentation](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656).

## Credential Management

The credentials used to access a tenant can be stored securely on your development machine. Depending on the operating system, use one of the following options.

### Credential Management (Windows)

Under Windows use the [Credential Manager](https://support.microsoft.com/en-us/help/4026814/windows-accessing-credential-manager) to store your credentials for WCH. You can start the credential manager by navigating to `Control Panel\User Accounts and Family Safety\Credential Manager`. Create a new `Generic Credential`. As `Internet or network address` choose the API URL from WCH, make sure end the URL with a trailing slash. Enter your WCH username and password and hit `OK`.

### Credential Management (macOS)

Under macOS use the [Keychain Access](https://support.apple.com/en-gb/guide/keychain-access/what-is-keychain-access-kyca1083/mac) to store your credentials for WCH. Use the API URL from WCH as the name of the credenitial, this will automatically make it an `internet` credential. Enter your WCH username and password and hit `OK`.

### Credential Management (Linux)

Under Linux the credentials are read from the `${home}/.ibm-wch-sdk-cli/.credentials` file. Use the `store credentials` command to securely persist the credentials in this file.

## Credential Storage

Stores a user name and password WCH in the file `${home}/.ibm-wch-sdk-cli/.credentials`. The password is encrypted using the private SSH key found in `${home}/.ssh/id_rsa`. This command has been designed to work in a `Unix` environment, but it will also for for `Windows` provided an SSH key exists at the specified location. **Disclaimer** this method requires password free access to the SSH key.

### Note

If the file `${home}/.ssh/id_rsa` does not exist, you can create one using the following shell command:

```bash
ssh-keygen -t rsa -q -f ~/.ssh/id_rsa -P ""
```

## Usage

The module exports the following functions to work with credentials:

### wchGetCredentials

Reads the credentials for the given [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/).

```typescript
function wchGetCredentials(
  aApiUrl: string,
  aOptions?: Options
): Promise<Credentials>;
```

- `aApiUrl`: the [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/) for your tenant
- `aOptions`: optional options to control logging

### wchStoreCredentials

Stores the given credentials in the `${home}/.ibm-wch-sdk-cli/.credentials` file in every environment (including Windows).

```typescript
function wchStoreCredentials(
  aWchToolsOptions: WchToolsOptions,
  aOptions?: Options
): Promise<string>;
```

- `aWchToolsOptions`: credentials and [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/)
- `aOptions`: optional options to control logging

### wchRemoveCredentials

Removes the credentials for the given [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/) from the `${home}/.ibm-wch-sdk-cli/.credentials` file in every environment (including Windows).

```typescript
function wchRemoveCredentials(
  aApiUrl: string,
  aOptions?: Options
): Promise<string>;
```

- `aApiUrl`: the [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/) for your tenant
- `aOptions`: optional options to control logging

### isValidPassword

Checks if a password is valid syntactically

```typescript
function isValidPassword(aValue: any): aValue is string;
```

### isValidUrl

Checks if a URL is valid syntactically

```typescript
function isValidUrl(aValue: any): aValue is string;
```

### isValidUserName

Checks if a username is valid syntactically. This is the case if it is either an email or the term `apikey`.

```typescript
function isValidUserName(aValue: any): aValue is string;
```

### isValidCredentials

Checks if the credentials object is valid syntactically.

```typescript
function isValidCredentials(aCred: any): aCred is Credentials;
```

### isValidApiUrl

Checks if a string is a valid [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/) by trying to access well known API routes.

```typescript
function isValidApiUrl(aValue: any): Promise<boolean>;
```

### isValidWchToolsOptions

Checks if the `WchToolsOptions` combination of [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/), username and password is valid by trying to login to the targeted server.

```typescript
function isValidWchToolsOptions(
  aCredentials: WchToolsOptions
): Promise<boolean>;
```

<a name="_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656)

## cli-credentials package

## Functions

|  Function | Description |
|  --- | --- |
|  [isValidApiUrl(aValue)](#_d5bb491e54eb15af39f68462f84dcd950eb6279ec3fc305fecb8025885550002) | Checks if the URL is a valid WCH API URL by making a test call |
|  [isValidPassword(aValue)](#_cfb3c980a2317906d8372db1f1162558d0ada36cdb9d92687e121dffd266f389) | Checks if a password is valid |
|  [isValidUrl(aValue)](#_9be65a8a3ad1df45bddb87d9c1124446899530694a8c550b41b647eabd88f200) | Checks if the url is syntactically a valid URL |
|  [isValidUserName(aValue)](#_9f3f0fddd8d8a7a1ec082e7b46dae1bcb1b6f0ce54bdce05e270f09b73e816e6) | Checks if a username is valid, i.e. either an email or the term 'apikey' |
|  [isValidWchToolsOptions(aCredentials)](#_ecc718399010056af047539bab473463d49b954ceed0da2c9ccba022db78bfab) | Validates the credentials by trying to login |
|  [wchGetCredentials(aApiUrl, aOptions)](#_5f3a10b9cd72b336a4138cc471178a6d86d76afd3854adc9f5c3689f22e4ebe7) | Reads the credentials for the given API URL |
|  [wchRemoveCredentials(aApiUrl, aOptions)](#_fe9211e5aa25ba3ab5aebe9b39c5c11a21c0d139704ff47a12b493bc9b6dbd2d) |  |
|  [wchStoreCredentials(aWchToolsOptions, aOptions)](#_2f2193fbcd9ee00e6ada3f0fab8fee8f88d465e36907682ff11bef1292bf1fd5) |  |

## Interfaces

|  Interface | Description |
|  --- | --- |
|  [Credentials](#_47ff0fbea001491e26fe1823276c72bf2978db9036c79b900ae6bb351d1be50c) | WCH credentials |
|  [Options](#_f5ffcdc8f97b6f4074876f49cac0c5beb130d10dba494d64291627c3aa5b0dad) | Contextual options |
|  [WchToolsOptions](#_11ed0241cc6e68d635adddae119b32b7b94148e0fdd860829e02db1ae264dfd9) | Extension of the credentials to also carry the API URL that the credentials apply to |

## Variables

|  Variable | Description |
|  --- | --- |
|  [VERSION](#_692ccdffbcb28590df3ec7a88f9d64bb4a4b63581c93ef369bcf23ceef929aaf) | Version and build number of the package |

## Type Aliases

|  Type Alias | Description |
|  --- | --- |
|  [Logger](#_4aee3bbb0db1ac565c4389f7435cba9c7c7a9ece5eedd6f950a17d80b1c31aac) | Simple logger interface that this library used to print debug logs |


<a name="_6913f88f95c502a5676855704e294f758fbba43313d62473134fd06c5d88c386"></a>

<a name="_d5bb491e54eb15af39f68462f84dcd950eb6279ec3fc305fecb8025885550002"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [isValidApiUrl](#_d5bb491e54eb15af39f68462f84dcd950eb6279ec3fc305fecb8025885550002)

## isValidApiUrl() function

Checks if the URL is a valid WCH API URL by making a test call

<b>Signature:</b>

```typescript
export declare function isValidApiUrl(aValue: any): Promise<boolean>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aValue | <code>any</code> |  |

<b>Returns:</b>

`Promise<boolean>`

true if the URL is valid, else false


<a name="_cfb3c980a2317906d8372db1f1162558d0ada36cdb9d92687e121dffd266f389"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [isValidPassword](#_cfb3c980a2317906d8372db1f1162558d0ada36cdb9d92687e121dffd266f389)

## isValidPassword() function

Checks if a password is valid

<b>Signature:</b>

```typescript
export declare function isValidPassword(aValue: any): aValue is string;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aValue | <code>any</code> | the value to test |

<b>Returns:</b>

`aValue is string`

true if the password is valid, else false


<a name="_9be65a8a3ad1df45bddb87d9c1124446899530694a8c550b41b647eabd88f200"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [isValidUrl](#_9be65a8a3ad1df45bddb87d9c1124446899530694a8c550b41b647eabd88f200)

## isValidUrl() function

Checks if the url is syntactically a valid URL

<b>Signature:</b>

```typescript
export declare function isValidUrl(aValue: any): aValue is string;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aValue | <code>any</code> | the value |

<b>Returns:</b>

`aValue is string`

true if the value is a valid URL, else false


<a name="_9f3f0fddd8d8a7a1ec082e7b46dae1bcb1b6f0ce54bdce05e270f09b73e816e6"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [isValidUserName](#_9f3f0fddd8d8a7a1ec082e7b46dae1bcb1b6f0ce54bdce05e270f09b73e816e6)

## isValidUserName() function

Checks if a username is valid, i.e. either an email or the term 'apikey'

<b>Signature:</b>

```typescript
export declare function isValidUserName(aValue: any): aValue is string;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aValue | <code>any</code> | the value to test |

<b>Returns:</b>

`aValue is string`

true if the name is valid, else false


<a name="_ecc718399010056af047539bab473463d49b954ceed0da2c9ccba022db78bfab"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [isValidWchToolsOptions](#_ecc718399010056af047539bab473463d49b954ceed0da2c9ccba022db78bfab)

## isValidWchToolsOptions() function

Validates the credentials by trying to login

<b>Signature:</b>

```typescript
export declare function isValidWchToolsOptions(aCredentials: WchToolsOptions): Promise<boolean>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aCredentials | <code>WchToolsOptions</code> | the credentials |

<b>Returns:</b>

`Promise<boolean>`

true if the credentials were correct, else false


<a name="_5f3a10b9cd72b336a4138cc471178a6d86d76afd3854adc9f5c3689f22e4ebe7"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [wchGetCredentials](#_5f3a10b9cd72b336a4138cc471178a6d86d76afd3854adc9f5c3689f22e4ebe7)

## wchGetCredentials() function

Reads the credentials for the given API URL

<b>Signature:</b>

```typescript
export declare function wchGetCredentials(aApiUrl: string, aOptions?: Options): Promise<Credentials>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aApiUrl | <code>string</code> | the API URL |
|  aOptions | <code>Options</code> | options for debugging and logging |

<b>Returns:</b>

`Promise<Credentials>`

a promise of the loaded credentials


<a name="_fe9211e5aa25ba3ab5aebe9b39c5c11a21c0d139704ff47a12b493bc9b6dbd2d"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [wchRemoveCredentials](#_fe9211e5aa25ba3ab5aebe9b39c5c11a21c0d139704ff47a12b493bc9b6dbd2d)

## wchRemoveCredentials() function

<b>Signature:</b>

```typescript
declare function _removeCredentials(aApiUrl: string, aOptions?: Options): Promise<string>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aApiUrl | <code>string</code> |  |
|  aOptions | <code>Options</code> |  |

<b>Returns:</b>

`Promise<string>`


<a name="_2f2193fbcd9ee00e6ada3f0fab8fee8f88d465e36907682ff11bef1292bf1fd5"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [wchStoreCredentials](#_2f2193fbcd9ee00e6ada3f0fab8fee8f88d465e36907682ff11bef1292bf1fd5)

## wchStoreCredentials() function

<b>Signature:</b>

```typescript
declare function _writeCredentials(aWchToolsOptions: WchToolsOptions, aOptions?: Options): Promise<string>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  aWchToolsOptions | <code>WchToolsOptions</code> |  |
|  aOptions | <code>Options</code> |  |

<b>Returns:</b>

`Promise<string>`


<a name="_47ff0fbea001491e26fe1823276c72bf2978db9036c79b900ae6bb351d1be50c"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [Credentials](#_47ff0fbea001491e26fe1823276c72bf2978db9036c79b900ae6bb351d1be50c)

## Credentials interface

WCH credentials

<b>Signature:</b>

```typescript
export interface Credentials 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [password](#_a612dca6d235ed1781b8883d6921a208dd5b2ac7fc3f82b6fc4645dd98b32d12) | <code>string</code> | The WCH password |
|  [username](#_175451833f2a86afedee0510b7aef046cf014f973142bc950c422b7a0fe247ae) | <code>string</code> | The WCH username, typically an email or the string 'apikey' |


<a name="_f5ffcdc8f97b6f4074876f49cac0c5beb130d10dba494d64291627c3aa5b0dad"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [Options](#_f5ffcdc8f97b6f4074876f49cac0c5beb130d10dba494d64291627c3aa5b0dad)

## Options interface

Contextual options

<b>Signature:</b>

```typescript
export interface Options 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [debug](#_3242a3963089d83f6f015ee210ca823c3477b72971356b45b9fac37b942bfc01) | <code>boolean</code> | If set to true, print debug logs |
|  [logger](#_2eb2b5ac9db841b17715105925b1de3538c6e465ecfa34fe0120a622e95385f8) | <code>Logger</code> | If provided, the logger to be used to print debug logs |


<a name="_11ed0241cc6e68d635adddae119b32b7b94148e0fdd860829e02db1ae264dfd9"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [WchToolsOptions](#_11ed0241cc6e68d635adddae119b32b7b94148e0fdd860829e02db1ae264dfd9)

## WchToolsOptions interface

Extension of the credentials to also carry the API URL that the credentials apply to

<b>Signature:</b>

```typescript
export interface WchToolsOptions extends Credentials 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [baseUrl](#_c3fa356654fc2b6f73207c715b033485ae9576f7afcc393a06ae4ba553d22506) | <code>string</code> | The WCH AP URL |


<a name="_692ccdffbcb28590df3ec7a88f9d64bb4a4b63581c93ef369bcf23ceef929aaf"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [VERSION](#_692ccdffbcb28590df3ec7a88f9d64bb4a4b63581c93ef369bcf23ceef929aaf)

## VERSION variable

Version and build number of the package

<b>Signature:</b>

```typescript
VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}
```

<a name="_4aee3bbb0db1ac565c4389f7435cba9c7c7a9ece5eedd6f950a17d80b1c31aac"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [Logger](#_4aee3bbb0db1ac565c4389f7435cba9c7c7a9ece5eedd6f950a17d80b1c31aac)

## Logger type

Simple logger interface that this library used to print debug logs

<b>Signature:</b>

```typescript
export declare type Logger = (...optionalParams: any[]) => void;
```

<a name="_a612dca6d235ed1781b8883d6921a208dd5b2ac7fc3f82b6fc4645dd98b32d12"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [Credentials](#_47ff0fbea001491e26fe1823276c72bf2978db9036c79b900ae6bb351d1be50c) &gt; [password](#_a612dca6d235ed1781b8883d6921a208dd5b2ac7fc3f82b6fc4645dd98b32d12)

## Credentials.password property

The WCH password

<b>Signature:</b>

```typescript
password: string;
```

<a name="_175451833f2a86afedee0510b7aef046cf014f973142bc950c422b7a0fe247ae"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [Credentials](#_47ff0fbea001491e26fe1823276c72bf2978db9036c79b900ae6bb351d1be50c) &gt; [username](#_175451833f2a86afedee0510b7aef046cf014f973142bc950c422b7a0fe247ae)

## Credentials.username property

The WCH username, typically an email or the string 'apikey'

<b>Signature:</b>

```typescript
username: string;
```

<a name="_3242a3963089d83f6f015ee210ca823c3477b72971356b45b9fac37b942bfc01"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [Options](#_f5ffcdc8f97b6f4074876f49cac0c5beb130d10dba494d64291627c3aa5b0dad) &gt; [debug](#_3242a3963089d83f6f015ee210ca823c3477b72971356b45b9fac37b942bfc01)

## Options.debug property

If set to true, print debug logs

<b>Signature:</b>

```typescript
debug?: boolean;
```

<a name="_2eb2b5ac9db841b17715105925b1de3538c6e465ecfa34fe0120a622e95385f8"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [Options](#_f5ffcdc8f97b6f4074876f49cac0c5beb130d10dba494d64291627c3aa5b0dad) &gt; [logger](#_2eb2b5ac9db841b17715105925b1de3538c6e465ecfa34fe0120a622e95385f8)

## Options.logger property

If provided, the logger to be used to print debug logs

<b>Signature:</b>

```typescript
logger?: Logger;
```

<a name="_c3fa356654fc2b6f73207c715b033485ae9576f7afcc393a06ae4ba553d22506"></a>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](#_b8948d24104108ef10447d357132268ced167dcccd600deb93f829193b2dec9a) &gt; [@acoustic-content-sdk/cli-credentials](#_b16c5dd452369f7c0d63b1b0b32725e79034e805153879a70436037ac5f84656) &gt; [WchToolsOptions](#_11ed0241cc6e68d635adddae119b32b7b94148e0fdd860829e02db1ae264dfd9) &gt; [baseUrl](#_c3fa356654fc2b6f73207c715b033485ae9576f7afcc393a06ae4ba553d22506)

## WchToolsOptions.baseUrl property

The WCH AP URL

<b>Signature:</b>

```typescript
baseUrl: string;
```

---
_Source: https://npm.io/package/@acoustic-content-sdk/cli-credentials · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._