UNPKG

ibm-cloud-sdk-core

Version:

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

55 lines (26 loc) 1.52 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; [McspAuthenticator](./ibm-cloud-sdk-core.mcspauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.mcspauthenticator._constructor_.md) ## McspAuthenticator.(constructor) Create a new McspAuthenticator instance. **Signature:** ```typescript constructor(options: Options); ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> options </td><td> Options </td><td> Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service </td></tr> </tbody></table> ## Exceptions Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.