UNPKG

ibm-cloud-sdk-core

Version:

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

172 lines (75 loc) 2.22 kB
<!-- 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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) ## UserOptions interface Configuration values for a service. **Signature:** ```typescript export interface UserOptions ``` ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md) </td><td> </td><td> [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) </td><td> _(Optional)_ The Authenticator object used to authenticate requests to the service </td></tr> <tr><td> [disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md) </td><td> </td><td> boolean </td><td> _(Optional)_ Set to `true` to allow unauthorized requests - not recommended for production use. </td></tr> <tr><td> [headers?](./ibm-cloud-sdk-core.useroptions.headers.md) </td><td> </td><td> OutgoingHttpHeaders </td><td> _(Optional)_ Default headers that shall be included with every request to the service. </td></tr> <tr><td> [jar?](./ibm-cloud-sdk-core.useroptions.jar.md) </td><td> </td><td> CookieJar \| boolean </td><td> _(Optional)_ Set your own cookie jar object </td></tr> <tr><td> [serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md) </td><td> </td><td> string </td><td> _(Optional)_ The base url to use when contacting the service. The base url may differ between IBM Cloud regions. </td></tr> <tr><td> [url?](./ibm-cloud-sdk-core.useroptions.url.md) </td><td> </td><td> string </td><td> _(Optional)_ Deprecated. Use `serviceUrl` instead. </td></tr> <tr><td> [version?](./ibm-cloud-sdk-core.useroptions.version.md) </td><td> </td><td> string </td><td> _(Optional)_ The API version date to use with the service, in "YYYY-MM-DD" format. </td></tr> </tbody></table>