ibm-cloud-sdk-core/build/docs/ibm-cloud-sdk-core.checkcredentials.md

Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [checkCredentials](./ibm-cloud-sdk-core.checkcredentials.md)

## checkCredentials() function

Checks credentials for common user mistakes of copying {<!-- -->, }<!-- -->, or " characters from the documentation

**Signature:**

```typescript
export declare function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

obj


</td><td>

any


</td><td>

the options object holding credentials


</td></tr>
<tr><td>

credsToCheck


</td><td>

string\[\]


</td><td>

an array containing the keys of the credentials to check for problems


</td></tr>
</tbody></table>
**Returns:**

Error \| null

a string with the error message if there were problems, null if not