ibm-cloud-sdk-core 5.0.2 → 5.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (299) hide show
  1. package/.secrets.baseline +118 -14
  2. package/Authentication.md +146 -21
  3. package/CHANGELOG.md +14 -0
  4. package/README.md +4 -3
  5. package/auth/authenticators/authenticator.d.ts +1 -0
  6. package/auth/authenticators/authenticator.js +1 -0
  7. package/auth/authenticators/container-authenticator.d.ts +6 -0
  8. package/auth/authenticators/container-authenticator.js +8 -0
  9. package/auth/authenticators/iam-assume-authenticator.d.ts +82 -0
  10. package/auth/authenticators/iam-assume-authenticator.js +92 -0
  11. package/auth/authenticators/iam-authenticator.d.ts +6 -0
  12. package/auth/authenticators/iam-authenticator.js +8 -0
  13. package/auth/authenticators/iam-request-based-authenticator-immutable.d.ts +64 -0
  14. package/auth/authenticators/iam-request-based-authenticator-immutable.js +74 -0
  15. package/auth/authenticators/iam-request-based-authenticator.d.ts +19 -47
  16. package/auth/authenticators/iam-request-based-authenticator.js +28 -36
  17. package/auth/authenticators/index.d.ts +4 -1
  18. package/auth/authenticators/index.js +3 -1
  19. package/auth/authenticators/token-request-based-authenticator-immutable.d.ts +71 -0
  20. package/auth/authenticators/token-request-based-authenticator-immutable.js +91 -0
  21. package/auth/authenticators/token-request-based-authenticator.d.ts +4 -42
  22. package/auth/authenticators/token-request-based-authenticator.js +5 -43
  23. package/auth/token-managers/container-token-manager.d.ts +6 -0
  24. package/auth/token-managers/container-token-manager.js +18 -50
  25. package/auth/token-managers/iam-assume-token-manager.d.ts +101 -0
  26. package/auth/token-managers/iam-assume-token-manager.js +220 -0
  27. package/auth/token-managers/iam-request-based-token-manager.d.ts +3 -9
  28. package/auth/token-managers/iam-request-based-token-manager.js +0 -8
  29. package/auth/token-managers/iam-token-manager.d.ts +8 -2
  30. package/auth/token-managers/iam-token-manager.js +10 -2
  31. package/auth/token-managers/index.d.ts +4 -2
  32. package/auth/token-managers/index.js +6 -3
  33. package/auth/utils/get-authenticator-from-environment.js +3 -0
  34. package/auth/utils/helpers.d.ts +18 -23
  35. package/auth/utils/helpers.js +50 -30
  36. package/build/docs/ibm-cloud-sdk-core.atleastone.md +55 -0
  37. package/build/docs/ibm-cloud-sdk-core.atmostone.md +55 -0
  38. package/build/docs/ibm-cloud-sdk-core.authenticator._constructor_.md +18 -0
  39. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md +57 -0
  40. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.md +19 -0
  41. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_basic.md +13 -0
  42. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md +11 -0
  43. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_container.md +11 -0
  44. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_cp4d.md +11 -0
  45. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam.md +11 -0
  46. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam_assume.md +11 -0
  47. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_mcsp.md +11 -0
  48. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_noauth.md +11 -0
  49. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_unknown.md +11 -0
  50. package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_vpc.md +11 -0
  51. package/build/docs/ibm-cloud-sdk-core.authenticator.md +313 -0
  52. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md +53 -0
  53. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md +17 -0
  54. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.md +50 -0
  55. package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md +49 -0
  56. package/build/docs/ibm-cloud-sdk-core.baseservice.baseoptions.md +11 -0
  57. package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md +53 -0
  58. package/build/docs/ibm-cloud-sdk-core.baseservice.convertmodel.md +85 -0
  59. package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md +55 -0
  60. package/build/docs/ibm-cloud-sdk-core.baseservice.createrequestanddeserializeresponse.md +87 -0
  61. package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_name.md +11 -0
  62. package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_url.md +11 -0
  63. package/build/docs/ibm-cloud-sdk-core.baseservice.disableretries.md +17 -0
  64. package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md +53 -0
  65. package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md +19 -0
  66. package/build/docs/ibm-cloud-sdk-core.baseservice.gethttpclient.md +17 -0
  67. package/build/docs/ibm-cloud-sdk-core.baseservice.md +313 -0
  68. package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.md +53 -0
  69. package/build/docs/ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md +53 -0
  70. package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.md +53 -0
  71. package/build/docs/ibm-cloud-sdk-core.basicauthenticator._constructor_.md +54 -0
  72. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md +55 -0
  73. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md +19 -0
  74. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authheader.md +13 -0
  75. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.md +165 -0
  76. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md +11 -0
  77. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md +54 -0
  78. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md +55 -0
  79. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md +19 -0
  80. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.md +160 -0
  81. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md +11 -0
  82. package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md +53 -0
  83. package/build/docs/ibm-cloud-sdk-core.buildrequestfileobject.md +55 -0
  84. package/build/docs/ibm-cloud-sdk-core.checkcredentials.md +71 -0
  85. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md +54 -0
  86. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md +19 -0
  87. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.md +149 -0
  88. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md +11 -0
  89. package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md +11 -0
  90. package/build/docs/ibm-cloud-sdk-core.computebasicauthheader.md +71 -0
  91. package/build/docs/ibm-cloud-sdk-core.constructfilepath.md +49 -0
  92. package/build/docs/ibm-cloud-sdk-core.constructserviceurl.md +87 -0
  93. package/build/docs/ibm-cloud-sdk-core.containerauthenticator._constructor_.md +54 -0
  94. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md +19 -0
  95. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.getrefreshtoken.md +19 -0
  96. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.md +186 -0
  97. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md +53 -0
  98. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md +53 -0
  99. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md +53 -0
  100. package/build/docs/ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md +11 -0
  101. package/build/docs/ibm-cloud-sdk-core.containertokenmanager._constructor_.md +54 -0
  102. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.getcrtoken.md +19 -0
  103. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.getrefreshtoken.md +19 -0
  104. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.md +156 -0
  105. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.requesttoken.md +17 -0
  106. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md +53 -0
  107. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md +53 -0
  108. package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md +53 -0
  109. package/build/docs/ibm-cloud-sdk-core.contenttype.md +14 -0
  110. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md +54 -0
  111. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.md +128 -0
  112. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md +15 -0
  113. package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md +11 -0
  114. package/build/docs/ibm-cloud-sdk-core.fileexistsatpath.md +49 -0
  115. package/build/docs/ibm-cloud-sdk-core.fileobject.md +80 -0
  116. package/build/docs/ibm-cloud-sdk-core.fileobject.options.md +11 -0
  117. package/build/docs/ibm-cloud-sdk-core.fileobject.value.md +11 -0
  118. package/build/docs/ibm-cloud-sdk-core.fileoptions.contenttype.md +11 -0
  119. package/build/docs/ibm-cloud-sdk-core.fileoptions.filename.md +11 -0
  120. package/build/docs/ibm-cloud-sdk-core.fileoptions.md +74 -0
  121. package/build/docs/ibm-cloud-sdk-core.filestream.md +54 -0
  122. package/build/docs/ibm-cloud-sdk-core.filestream.path.md +11 -0
  123. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.contenttype.md +11 -0
  124. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.data.md +11 -0
  125. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.filename.md +11 -0
  126. package/build/docs/ibm-cloud-sdk-core.filewithmetadata.md +87 -0
  127. package/build/docs/ibm-cloud-sdk-core.getauthenticatorfromenvironment.md +55 -0
  128. package/build/docs/ibm-cloud-sdk-core.getcontenttype.md +55 -0
  129. package/build/docs/ibm-cloud-sdk-core.getcurrenttime.md +19 -0
  130. package/build/docs/ibm-cloud-sdk-core.getformat.md +69 -0
  131. package/build/docs/ibm-cloud-sdk-core.getmissingparams.md +73 -0
  132. package/build/docs/ibm-cloud-sdk-core.getnewlogger.md +59 -0
  133. package/build/docs/ibm-cloud-sdk-core.getqueryparam.md +71 -0
  134. package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator._constructor_.md +54 -0
  135. package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.authenticationtype.md +19 -0
  136. package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.md +130 -0
  137. package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.tokenmanager.md +11 -0
  138. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager._constructor_.md +54 -0
  139. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.md +200 -0
  140. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.requesttoken.md +17 -0
  141. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.requiredoptions.md +11 -0
  142. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.savetokeninfo.md +53 -0
  143. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setclientidandsecret.md +69 -0
  144. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setdisablesslverification.md +53 -0
  145. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setheaders.md +53 -0
  146. package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setscope.md +53 -0
  147. package/build/docs/ibm-cloud-sdk-core.iamauthenticator._constructor_.md +54 -0
  148. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md +19 -0
  149. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.getrefreshtoken.md +19 -0
  150. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.md +163 -0
  151. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md +11 -0
  152. package/build/docs/ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md +11 -0
  153. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.md +90 -0
  154. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md +69 -0
  155. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setdisablesslverification.md +53 -0
  156. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setheaders.md +53 -0
  157. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md +53 -0
  158. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md +54 -0
  159. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.clientid.md +11 -0
  160. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.clientsecret.md +11 -0
  161. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md +11 -0
  162. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.istokenexpired.md +19 -0
  163. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md +264 -0
  164. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md +11 -0
  165. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md +19 -0
  166. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md +53 -0
  167. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.scope.md +11 -0
  168. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md +69 -0
  169. package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md +53 -0
  170. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientid.md +11 -0
  171. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md +11 -0
  172. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.md +96 -0
  173. package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.scope.md +11 -0
  174. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._constructor_.md +54 -0
  175. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.getrefreshtoken.md +19 -0
  176. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.md +126 -0
  177. package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md +11 -0
  178. package/build/docs/ibm-cloud-sdk-core.isemptyobject.md +49 -0
  179. package/build/docs/ibm-cloud-sdk-core.isfiledata.md +49 -0
  180. package/build/docs/ibm-cloud-sdk-core.isfilewithmetadata.md +49 -0
  181. package/build/docs/ibm-cloud-sdk-core.ishtml.md +55 -0
  182. package/build/docs/ibm-cloud-sdk-core.isjsonmimetype.md +55 -0
  183. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager._constructor_.md +49 -0
  184. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.md +163 -0
  185. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md +19 -0
  186. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md +53 -0
  187. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md +11 -0
  188. package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokenname.md +11 -0
  189. package/build/docs/ibm-cloud-sdk-core.jwttokenmanageroptions.md +15 -0
  190. package/build/docs/ibm-cloud-sdk-core.mcspauthenticator._constructor_.md +54 -0
  191. package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.authenticationtype.md +19 -0
  192. package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.md +145 -0
  193. package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.requiredoptions.md +11 -0
  194. package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md +11 -0
  195. package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md +54 -0
  196. package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.md +128 -0
  197. package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.requesttoken.md +15 -0
  198. package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.requiredoptions.md +11 -0
  199. package/build/docs/ibm-cloud-sdk-core.md +820 -0
  200. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticate.md +49 -0
  201. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md +19 -0
  202. package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.md +60 -0
  203. package/build/docs/ibm-cloud-sdk-core.onlyone.md +55 -0
  204. package/build/docs/ibm-cloud-sdk-core.qs.md +21 -0
  205. package/build/docs/ibm-cloud-sdk-core.readcredentialsfile.md +17 -0
  206. package/build/docs/ibm-cloud-sdk-core.readcrtokenfile.md +49 -0
  207. package/build/docs/ibm-cloud-sdk-core.readexternalsources.md +55 -0
  208. package/build/docs/ibm-cloud-sdk-core.removesuffix.md +71 -0
  209. package/build/docs/ibm-cloud-sdk-core.sdklogger.debug.md +11 -0
  210. package/build/docs/ibm-cloud-sdk-core.sdklogger.error.md +11 -0
  211. package/build/docs/ibm-cloud-sdk-core.sdklogger.info.md +11 -0
  212. package/build/docs/ibm-cloud-sdk-core.sdklogger.md +121 -0
  213. package/build/docs/ibm-cloud-sdk-core.sdklogger.verbose.md +11 -0
  214. package/build/docs/ibm-cloud-sdk-core.sdklogger.warn.md +11 -0
  215. package/build/docs/ibm-cloud-sdk-core.streamtopromise.md +55 -0
  216. package/build/docs/ibm-cloud-sdk-core.striptrailingslash.md +55 -0
  217. package/build/docs/ibm-cloud-sdk-core.tokenmanager._constructor_.md +49 -0
  218. package/build/docs/ibm-cloud-sdk-core.tokenmanager.accesstoken.md +11 -0
  219. package/build/docs/ibm-cloud-sdk-core.tokenmanager.disablesslverification.md +11 -0
  220. package/build/docs/ibm-cloud-sdk-core.tokenmanager.expiretime.md +11 -0
  221. package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md +17 -0
  222. package/build/docs/ibm-cloud-sdk-core.tokenmanager.headers.md +11 -0
  223. package/build/docs/ibm-cloud-sdk-core.tokenmanager.istokenexpired.md +17 -0
  224. package/build/docs/ibm-cloud-sdk-core.tokenmanager.md +352 -0
  225. package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md +19 -0
  226. package/build/docs/ibm-cloud-sdk-core.tokenmanager.refreshtime.md +11 -0
  227. package/build/docs/ibm-cloud-sdk-core.tokenmanager.requesttoken.md +19 -0
  228. package/build/docs/ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md +11 -0
  229. package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md +53 -0
  230. package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md +53 -0
  231. package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md +53 -0
  232. package/build/docs/ibm-cloud-sdk-core.tokenmanager.url.md +11 -0
  233. package/build/docs/ibm-cloud-sdk-core.tokenmanager.useragent.md +11 -0
  234. package/build/docs/ibm-cloud-sdk-core.tokenmanageroptions.md +18 -0
  235. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md +66 -0
  236. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md +53 -0
  237. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md +53 -0
  238. package/build/docs/ibm-cloud-sdk-core.tolowerkeys.md +55 -0
  239. package/build/docs/ibm-cloud-sdk-core.useroptions.authenticator.md +13 -0
  240. package/build/docs/ibm-cloud-sdk-core.useroptions.disablesslverification.md +13 -0
  241. package/build/docs/ibm-cloud-sdk-core.useroptions.headers.md +13 -0
  242. package/build/docs/ibm-cloud-sdk-core.useroptions.jar.md +13 -0
  243. package/build/docs/ibm-cloud-sdk-core.useroptions.md +171 -0
  244. package/build/docs/ibm-cloud-sdk-core.useroptions.serviceurl.md +13 -0
  245. package/build/docs/ibm-cloud-sdk-core.useroptions.url.md +13 -0
  246. package/build/docs/ibm-cloud-sdk-core.useroptions.version.md +13 -0
  247. package/build/docs/ibm-cloud-sdk-core.validateinput.md +73 -0
  248. package/build/docs/ibm-cloud-sdk-core.validateparams.md +89 -0
  249. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md +54 -0
  250. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md +19 -0
  251. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.md +158 -0
  252. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md +53 -0
  253. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md +53 -0
  254. package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md +11 -0
  255. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md +54 -0
  256. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.istokenexpired.md +19 -0
  257. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.md +126 -0
  258. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md +15 -0
  259. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md +53 -0
  260. package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md +53 -0
  261. package/build/docs/index.md +29 -0
  262. package/docs/ibm-cloud-sdk-core.api.json +787 -404
  263. package/es/auth/authenticators/authenticator.d.ts +1 -0
  264. package/es/auth/authenticators/authenticator.js +1 -0
  265. package/es/auth/authenticators/container-authenticator.d.ts +6 -0
  266. package/es/auth/authenticators/container-authenticator.js +8 -0
  267. package/es/auth/authenticators/iam-assume-authenticator.d.ts +82 -0
  268. package/es/auth/authenticators/iam-assume-authenticator.js +70 -0
  269. package/es/auth/authenticators/iam-authenticator.d.ts +6 -0
  270. package/es/auth/authenticators/iam-authenticator.js +8 -0
  271. package/es/auth/authenticators/iam-request-based-authenticator-immutable.d.ts +64 -0
  272. package/es/auth/authenticators/iam-request-based-authenticator-immutable.js +51 -0
  273. package/es/auth/authenticators/iam-request-based-authenticator.d.ts +19 -47
  274. package/es/auth/authenticators/iam-request-based-authenticator.js +26 -35
  275. package/es/auth/authenticators/index.d.ts +4 -1
  276. package/es/auth/authenticators/index.js +1 -0
  277. package/es/auth/authenticators/token-request-based-authenticator-immutable.d.ts +71 -0
  278. package/es/auth/authenticators/token-request-based-authenticator-immutable.js +65 -0
  279. package/es/auth/authenticators/token-request-based-authenticator.d.ts +4 -42
  280. package/es/auth/authenticators/token-request-based-authenticator.js +3 -39
  281. package/es/auth/token-managers/container-token-manager.d.ts +6 -0
  282. package/es/auth/token-managers/container-token-manager.js +18 -24
  283. package/es/auth/token-managers/iam-assume-token-manager.d.ts +101 -0
  284. package/es/auth/token-managers/iam-assume-token-manager.js +164 -0
  285. package/es/auth/token-managers/iam-request-based-token-manager.d.ts +3 -9
  286. package/es/auth/token-managers/iam-request-based-token-manager.js +0 -8
  287. package/es/auth/token-managers/iam-token-manager.d.ts +8 -2
  288. package/es/auth/token-managers/iam-token-manager.js +10 -2
  289. package/es/auth/token-managers/index.d.ts +4 -2
  290. package/es/auth/token-managers/index.js +4 -2
  291. package/es/auth/utils/get-authenticator-from-environment.js +4 -1
  292. package/es/auth/utils/helpers.d.ts +18 -23
  293. package/es/auth/utils/helpers.js +35 -27
  294. package/es/tsdoc-metadata.json +11 -0
  295. package/etc/ibm-cloud-sdk-core.api.md +46 -28
  296. package/ibm-cloud-sdk-core.d.ts +264 -68
  297. package/package.json +2 -2
  298. package/temp/ibm-cloud-sdk-core.api.json +8646 -0
  299. package/temp/ibm-cloud-sdk-core.api.md +505 -0
@@ -28,9 +28,9 @@ export interface IamRequestOptions extends JwtTokenManagerOptions {
28
28
  * class be extended with specific implementations.
29
29
  */
30
30
  export declare class IamRequestBasedTokenManager extends JwtTokenManager {
31
- private clientId;
32
- private clientSecret;
33
- private scope;
31
+ protected clientId: string;
32
+ protected clientSecret: string;
33
+ protected scope: string;
34
34
  protected refreshToken: string;
35
35
  protected formData: any;
36
36
  /**
@@ -70,12 +70,6 @@ export declare class IamRequestBasedTokenManager extends JwtTokenManager {
70
70
  * @param clientSecret - the client secret.
71
71
  */
72
72
  setClientIdAndSecret(clientId: string, clientSecret: string): void;
73
- /**
74
- * Returns the most recently stored refresh token.
75
- *
76
- * @returns the refresh token
77
- */
78
- getRefreshToken(): string;
79
73
  /**
80
74
  * Extend this method from the parent class to extract the refresh token from
81
75
  * the request and save it.
@@ -120,14 +120,6 @@ var IamRequestBasedTokenManager = /** @class */ (function (_super) {
120
120
  logger_1.default.warn(CLIENT_ID_SECRET_WARNING);
121
121
  }
122
122
  };
123
- /**
124
- * Returns the most recently stored refresh token.
125
- *
126
- * @returns the refresh token
127
- */
128
- IamRequestBasedTokenManager.prototype.getRefreshToken = function () {
129
- return this.refreshToken;
130
- };
131
123
  /**
132
124
  * Extend this method from the parent class to extract the refresh token from
133
125
  * the request and save it.
@@ -19,8 +19,8 @@ interface Options extends IamRequestOptions {
19
19
  apikey: string;
20
20
  }
21
21
  /**
22
- * The IAMTokenManager takes an api key and performs the necessary interactions with
23
- * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
22
+ * The IamTokenManager takes an api key and performs the necessary interactions with
23
+ * the IAM token service to obtain and store a suitable bearer token. Additionally, the IamTokenManager
24
24
  * will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
25
25
  */
26
26
  export declare class IamTokenManager extends IamRequestBasedTokenManager {
@@ -46,5 +46,11 @@ export declare class IamTokenManager extends IamRequestBasedTokenManager {
46
46
  * @throws Error: the configuration options are not valid.
47
47
  */
48
48
  constructor(options: Options);
49
+ /**
50
+ * Returns the most recently stored refresh token.
51
+ *
52
+ * @returns the refresh token
53
+ */
54
+ getRefreshToken(): string;
49
55
  }
50
56
  export {};
@@ -35,8 +35,8 @@ var helpers_1 = require("../utils/helpers");
35
35
  var build_user_agent_1 = require("../../lib/build-user-agent");
36
36
  var iam_request_based_token_manager_1 = require("./iam-request-based-token-manager");
37
37
  /**
38
- * The IAMTokenManager takes an api key and performs the necessary interactions with
39
- * the IAM token service to obtain and store a suitable bearer token. Additionally, the IAMTokenManager
38
+ * The IamTokenManager takes an api key and performs the necessary interactions with
39
+ * the IAM token service to obtain and store a suitable bearer token. Additionally, the IamTokenManager
40
40
  * will retrieve bearer tokens via basic auth using a supplied "clientId" and "clientSecret" pair.
41
41
  */
42
42
  var IamTokenManager = /** @class */ (function (_super) {
@@ -72,6 +72,14 @@ var IamTokenManager = /** @class */ (function (_super) {
72
72
  _this.userAgent = (0, build_user_agent_1.buildUserAgent)('iam-authenticator');
73
73
  return _this;
74
74
  }
75
+ /**
76
+ * Returns the most recently stored refresh token.
77
+ *
78
+ * @returns the refresh token
79
+ */
80
+ IamTokenManager.prototype.getRefreshToken = function () {
81
+ return this.refreshToken;
82
+ };
75
83
  return IamTokenManager;
76
84
  }(iam_request_based_token_manager_1.IamRequestBasedTokenManager));
77
85
  exports.IamTokenManager = IamTokenManager;
@@ -16,8 +16,8 @@
16
16
  /**
17
17
  * @module token-managers
18
18
  * The ibm-cloud-sdk-core module supports the following types of token authentication:
19
- *
20
- * Identity and Access Management (IAM)
19
+ * Identity and Access Management (IAM, grant type: apikey)
20
+ * Identity and Access Management (IAM, grant type: assume)
21
21
  * Cloud Pak for Data
22
22
  * Container (IKS, etc)
23
23
  * VPC Instance
@@ -28,6 +28,7 @@
28
28
  *
29
29
  * classes:
30
30
  * IamTokenManager: Token Manager of IAM via apikey.
31
+ * IamAssumeTokenManager: Token Manager of IAM via apikey and trusted profile.
31
32
  * Cp4dTokenManager: Token Manager of CloudPak for data.
32
33
  * ContainerTokenManager: Token manager of IAM via compute resource token.
33
34
  * VpcInstanceTokenManager: Token manager of VPC Instance Metadata Service API tokens.
@@ -42,3 +43,4 @@ export { JwtTokenManager, JwtTokenManagerOptions } from './jwt-token-manager';
42
43
  export { TokenManager, TokenManagerOptions } from './token-manager';
43
44
  export { VpcInstanceTokenManager } from './vpc-instance-token-manager';
44
45
  export { McspTokenManager } from './mcsp-token-manager';
46
+ export { IamAssumeTokenManager } from './iam-assume-token-manager';
@@ -15,12 +15,12 @@
15
15
  * limitations under the License.
16
16
  */
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.McspTokenManager = exports.VpcInstanceTokenManager = exports.TokenManager = exports.JwtTokenManager = exports.IamRequestBasedTokenManager = exports.ContainerTokenManager = exports.Cp4dTokenManager = exports.IamTokenManager = void 0;
18
+ exports.IamAssumeTokenManager = exports.McspTokenManager = exports.VpcInstanceTokenManager = exports.TokenManager = exports.JwtTokenManager = exports.IamRequestBasedTokenManager = exports.ContainerTokenManager = exports.Cp4dTokenManager = exports.IamTokenManager = void 0;
19
19
  /**
20
20
  * @module token-managers
21
21
  * The ibm-cloud-sdk-core module supports the following types of token authentication:
22
- *
23
- * Identity and Access Management (IAM)
22
+ * Identity and Access Management (IAM, grant type: apikey)
23
+ * Identity and Access Management (IAM, grant type: assume)
24
24
  * Cloud Pak for Data
25
25
  * Container (IKS, etc)
26
26
  * VPC Instance
@@ -31,6 +31,7 @@ exports.McspTokenManager = exports.VpcInstanceTokenManager = exports.TokenManage
31
31
  *
32
32
  * classes:
33
33
  * IamTokenManager: Token Manager of IAM via apikey.
34
+ * IamAssumeTokenManager: Token Manager of IAM via apikey and trusted profile.
34
35
  * Cp4dTokenManager: Token Manager of CloudPak for data.
35
36
  * ContainerTokenManager: Token manager of IAM via compute resource token.
36
37
  * VpcInstanceTokenManager: Token manager of VPC Instance Metadata Service API tokens.
@@ -53,3 +54,5 @@ var vpc_instance_token_manager_1 = require("./vpc-instance-token-manager");
53
54
  Object.defineProperty(exports, "VpcInstanceTokenManager", { enumerable: true, get: function () { return vpc_instance_token_manager_1.VpcInstanceTokenManager; } });
54
55
  var mcsp_token_manager_1 = require("./mcsp-token-manager");
55
56
  Object.defineProperty(exports, "McspTokenManager", { enumerable: true, get: function () { return mcsp_token_manager_1.McspTokenManager; } });
57
+ var iam_assume_token_manager_1 = require("./iam-assume-token-manager");
58
+ Object.defineProperty(exports, "IamAssumeTokenManager", { enumerable: true, get: function () { return iam_assume_token_manager_1.IamAssumeTokenManager; } });
@@ -81,6 +81,9 @@ function getAuthenticatorFromEnvironment(serviceName) {
81
81
  else if (authType === authenticators_1.Authenticator.AUTHTYPE_IAM.toLowerCase()) {
82
82
  authenticator = new authenticators_1.IamAuthenticator(credentials);
83
83
  }
84
+ else if (authType === authenticators_1.Authenticator.AUTHTYPE_IAM_ASSUME.toLowerCase()) {
85
+ authenticator = new authenticators_1.IamAssumeAuthenticator(credentials);
86
+ }
84
87
  else if (authType === authenticators_1.Authenticator.AUTHTYPE_CONTAINER.toLowerCase()) {
85
88
  authenticator = new authenticators_1.ContainerAuthenticator(credentials);
86
89
  }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * (C) Copyright IBM Corp. 2019, 2022.
2
+ * (C) Copyright IBM Corp. 2019, 2024.
3
3
  *
4
4
  * Licensed under the Apache License, Version 2.0 (the "License");
5
5
  * you may not use this file except in compliance with the License.
@@ -43,17 +43,6 @@ export declare function validateInput(options: any, requiredOptions: string[]):
43
43
  * @returns the current time in seconds.
44
44
  */
45
45
  export declare function getCurrentTime(): number;
46
- /**
47
- * Checks for only one of two elements being defined.
48
- * Returns true if a is defined and b is undefined,
49
- * or vice versa. Returns false if both are defined
50
- * or both are undefined.
51
- *
52
- * @param a - The first object
53
- * @param b - The second object
54
- * @returns true if and only if exactly one of a or b is defined
55
- */
56
- export declare function onlyOne(a: any, b: any): boolean;
57
46
  /**
58
47
  * Removes a given suffix if it exists.
59
48
  *
@@ -64,20 +53,26 @@ export declare function onlyOne(a: any, b: any): boolean;
64
53
  */
65
54
  export declare function removeSuffix(str: string, suffix: string): string;
66
55
  /**
67
- * Checks for at least one of two elements being defined.
56
+ * Checks that exactly one of the arguments provided is defined.
57
+ * Returns true if one argument is defined. Returns false if no
58
+ * argument are defined or if 2 or more are defined.
68
59
  *
69
- * @param a - the first object
70
- * @param b - the second object
71
- * @returns true if a or b is defined; false if both are undefined
60
+ * @param args - The spread of arguments to check
61
+ * @returns true if and only if exactly one argument is defined
72
62
  */
73
- export declare function atLeastOne(a: any, b: any): boolean;
63
+ export declare function onlyOne(...args: any): boolean;
74
64
  /**
75
- * Verifies that both properties are not specified.
65
+ * Checks for at least one of the given elements being defined.
76
66
  *
77
- * @param a - The first object
78
- * @param b - The second object
67
+ * @param args - The spread of arguments to check
68
+ * @returns true if one or more are defined; false if all are undefined
69
+ */
70
+ export declare function atLeastOne(...args: any): boolean;
71
+ /**
72
+ * Verifies that no more than one of the given elements are defined.
73
+ * Returns true if one or none are defined, and false otherwise.
79
74
  *
80
- * @returns false if a and b are both defined, true otherwise
81
-
75
+ * @param args - The spread of arguments to check
76
+ * @returns false if more than one elements are defined, true otherwise
82
77
  */
83
- export declare function atMostOne(a: any, b: any): boolean;
78
+ export declare function atMostOne(...args: any): boolean;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  /**
3
- * (C) Copyright IBM Corp. 2019, 2022.
3
+ * (C) Copyright IBM Corp. 2019, 2024.
4
4
  *
5
5
  * Licensed under the Apache License, Version 2.0 (the "License");
6
6
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
15
15
  * limitations under the License.
16
16
  */
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
- exports.atMostOne = exports.atLeastOne = exports.removeSuffix = exports.onlyOne = exports.getCurrentTime = exports.validateInput = exports.checkCredentials = exports.computeBasicAuthHeader = void 0;
18
+ exports.atMostOne = exports.atLeastOne = exports.onlyOne = exports.removeSuffix = exports.getCurrentTime = exports.validateInput = exports.checkCredentials = exports.computeBasicAuthHeader = void 0;
19
19
  var helper_1 = require("../../lib/helper");
20
20
  /**
21
21
  * Compute and return a Basic Authorization header from a username and password.
@@ -87,20 +87,6 @@ function getCurrentTime() {
87
87
  return Math.floor(Date.now() / 1000);
88
88
  }
89
89
  exports.getCurrentTime = getCurrentTime;
90
- /**
91
- * Checks for only one of two elements being defined.
92
- * Returns true if a is defined and b is undefined,
93
- * or vice versa. Returns false if both are defined
94
- * or both are undefined.
95
- *
96
- * @param a - The first object
97
- * @param b - The second object
98
- * @returns true if and only if exactly one of a or b is defined
99
- */
100
- function onlyOne(a, b) {
101
- return Boolean((a && !b) || (b && !a));
102
- }
103
- exports.onlyOne = onlyOne;
104
90
  /**
105
91
  * Removes a given suffix if it exists.
106
92
  *
@@ -117,26 +103,60 @@ function removeSuffix(str, suffix) {
117
103
  }
118
104
  exports.removeSuffix = removeSuffix;
119
105
  /**
120
- * Checks for at least one of two elements being defined.
106
+ * Checks that exactly one of the arguments provided is defined.
107
+ * Returns true if one argument is defined. Returns false if no
108
+ * argument are defined or if 2 or more are defined.
121
109
  *
122
- * @param a - the first object
123
- * @param b - the second object
124
- * @returns true if a or b is defined; false if both are undefined
110
+ * @param args - The spread of arguments to check
111
+ * @returns true if and only if exactly one argument is defined
125
112
  */
126
- function atLeastOne(a, b) {
127
- return Boolean(a || b);
113
+ function onlyOne() {
114
+ var args = [];
115
+ for (var _i = 0; _i < arguments.length; _i++) {
116
+ args[_i] = arguments[_i];
117
+ }
118
+ return countDefinedArgs(args) === 1;
128
119
  }
129
- exports.atLeastOne = atLeastOne;
120
+ exports.onlyOne = onlyOne;
130
121
  /**
131
- * Verifies that both properties are not specified.
122
+ * Checks for at least one of the given elements being defined.
132
123
  *
133
- * @param a - The first object
134
- * @param b - The second object
124
+ * @param args - The spread of arguments to check
125
+ * @returns true if one or more are defined; false if all are undefined
126
+ */
127
+ function atLeastOne() {
128
+ var args = [];
129
+ for (var _i = 0; _i < arguments.length; _i++) {
130
+ args[_i] = arguments[_i];
131
+ }
132
+ return countDefinedArgs(args) >= 1;
133
+ }
134
+ exports.atLeastOne = atLeastOne;
135
+ /**
136
+ * Verifies that no more than one of the given elements are defined.
137
+ * Returns true if one or none are defined, and false otherwise.
135
138
  *
136
- * @returns false if a and b are both defined, true otherwise
137
-
139
+ * @param args - The spread of arguments to check
140
+ * @returns false if more than one elements are defined, true otherwise
138
141
  */
139
- function atMostOne(a, b) {
140
- return Boolean(!(a && b));
142
+ function atMostOne() {
143
+ var args = [];
144
+ for (var _i = 0; _i < arguments.length; _i++) {
145
+ args[_i] = arguments[_i];
146
+ }
147
+ return countDefinedArgs(args) <= 1;
141
148
  }
142
149
  exports.atMostOne = atMostOne;
150
+ /**
151
+ * Takes a list of anything (intended to be the arguments passed to one of the
152
+ * argument checking functions above) and returns how many elements in that
153
+ * list are not undefined.
154
+ */
155
+ function countDefinedArgs(args) {
156
+ return args.reduce(function (total, arg) {
157
+ if (arg) {
158
+ total += 1;
159
+ }
160
+ return total;
161
+ }, 0);
162
+ }
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [atLeastOne](./ibm-cloud-sdk-core.atleastone.md)
4
+
5
+ ## atLeastOne() function
6
+
7
+ Checks for at least one of the given elements being defined.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function atLeastOne(...args: any): boolean;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ args
36
+
37
+
38
+ </td><td>
39
+
40
+ any
41
+
42
+
43
+ </td><td>
44
+
45
+ The spread of arguments to check
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ boolean
53
+
54
+ true if one or more are defined; false if all are undefined
55
+
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [atMostOne](./ibm-cloud-sdk-core.atmostone.md)
4
+
5
+ ## atMostOne() function
6
+
7
+ Verifies that no more than one of the given elements are defined. Returns true if one or none are defined, and false otherwise.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function atMostOne(...args: any): boolean;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ args
36
+
37
+
38
+ </td><td>
39
+
40
+ any
41
+
42
+
43
+ </td><td>
44
+
45
+ The spread of arguments to check
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ boolean
53
+
54
+ false if more than one elements are defined, true otherwise
55
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.authenticator._constructor_.md)
4
+
5
+ ## Authenticator.(constructor)
6
+
7
+ Create a new Authenticator instance.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ constructor();
13
+ ```
14
+
15
+ ## Exceptions
16
+
17
+ Error: the "new" keyword was not used to construct the authenticator.
18
+
@@ -0,0 +1,57 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.authenticator.authenticate.md)
4
+
5
+ ## Authenticator.authenticate() method
6
+
7
+ Augment the request with authentication information.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ requestOptions
36
+
37
+
38
+ </td><td>
39
+
40
+ AuthenticateOptions
41
+
42
+
43
+ </td><td>
44
+
45
+ The request to augment with authentication information.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ Promise&lt;void&gt;
53
+
54
+ ## Exceptions
55
+
56
+ Error: The authenticate method was not implemented by a subclass.
57
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)
4
+
5
+ ## Authenticator.authenticationType() method
6
+
7
+ Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the &lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ authenticationType(): string;
13
+ ```
14
+ **Returns:**
15
+
16
+ string
17
+
18
+ a string that indicates the authenticator's type
19
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_BASIC property
6
+
7
+ Constants that define the various authenticator types.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ static AUTHTYPE_BASIC: string;
13
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_BEARERTOKEN property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ static AUTHTYPE_BEARERTOKEN: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_CONTAINER property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ static AUTHTYPE_CONTAINER: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_CP4D property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ static AUTHTYPE_CP4D: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_IAM property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ static AUTHTYPE_IAM: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_IAM\_ASSUME](./ibm-cloud-sdk-core.authenticator.authtype_iam_assume.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_IAM\_ASSUME property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ static AUTHTYPE_IAM_ASSUME: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_MCSP](./ibm-cloud-sdk-core.authenticator.authtype_mcsp.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_MCSP property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ static AUTHTYPE_MCSP: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_NOAUTH property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ static AUTHTYPE_NOAUTH: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md)
4
+
5
+ ## Authenticator.AUTHTYPE\_UNKNOWN property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ static AUTHTYPE_UNKNOWN: string;
11
+ ```