UNPKG

ibm-cloud-sdk-core

Version:

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

150 lines (68 loc) 2.23 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; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) ## CloudPakForDataAuthenticator class The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. The bearer token will be sent as an Authorization header in the form: Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt; **Signature:** ```typescript export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator ``` **Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) ## Constructors <table><thead><tr><th> Constructor </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td> [(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md) </td><td> </td><td> Create a new CloudPakForDataAuthenticator instance. </td></tr> </tbody></table> ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md) </td><td> `protected` </td><td> string\[\] </td><td> </td></tr> <tr><td> [tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md) </td><td> `protected` </td><td> [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) </td><td> </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td> [authenticationType()](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md) </td><td> </td><td> Returns the authenticator's type ('cp4d'). </td></tr> </tbody></table>