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.
- package/.secrets.baseline +118 -14
- package/Authentication.md +146 -21
- package/CHANGELOG.md +14 -0
- package/README.md +4 -3
- package/auth/authenticators/authenticator.d.ts +1 -0
- package/auth/authenticators/authenticator.js +1 -0
- package/auth/authenticators/container-authenticator.d.ts +6 -0
- package/auth/authenticators/container-authenticator.js +8 -0
- package/auth/authenticators/iam-assume-authenticator.d.ts +82 -0
- package/auth/authenticators/iam-assume-authenticator.js +92 -0
- package/auth/authenticators/iam-authenticator.d.ts +6 -0
- package/auth/authenticators/iam-authenticator.js +8 -0
- package/auth/authenticators/iam-request-based-authenticator-immutable.d.ts +64 -0
- package/auth/authenticators/iam-request-based-authenticator-immutable.js +74 -0
- package/auth/authenticators/iam-request-based-authenticator.d.ts +19 -47
- package/auth/authenticators/iam-request-based-authenticator.js +28 -36
- package/auth/authenticators/index.d.ts +4 -1
- package/auth/authenticators/index.js +3 -1
- package/auth/authenticators/token-request-based-authenticator-immutable.d.ts +71 -0
- package/auth/authenticators/token-request-based-authenticator-immutable.js +91 -0
- package/auth/authenticators/token-request-based-authenticator.d.ts +4 -42
- package/auth/authenticators/token-request-based-authenticator.js +5 -43
- package/auth/token-managers/container-token-manager.d.ts +6 -0
- package/auth/token-managers/container-token-manager.js +18 -50
- package/auth/token-managers/iam-assume-token-manager.d.ts +101 -0
- package/auth/token-managers/iam-assume-token-manager.js +220 -0
- package/auth/token-managers/iam-request-based-token-manager.d.ts +3 -9
- package/auth/token-managers/iam-request-based-token-manager.js +0 -8
- package/auth/token-managers/iam-token-manager.d.ts +8 -2
- package/auth/token-managers/iam-token-manager.js +10 -2
- package/auth/token-managers/index.d.ts +4 -2
- package/auth/token-managers/index.js +6 -3
- package/auth/utils/get-authenticator-from-environment.js +3 -0
- package/auth/utils/helpers.d.ts +18 -23
- package/auth/utils/helpers.js +50 -30
- package/build/docs/ibm-cloud-sdk-core.atleastone.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.atmostone.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator._constructor_.md +18 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md +57 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_basic.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_container.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_cp4d.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam_assume.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_mcsp.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_noauth.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_unknown.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_vpc.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.authenticator.md +313 -0
- package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md +17 -0
- package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.md +50 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.baseoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.convertmodel.md +85 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.createrequestanddeserializeresponse.md +87 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_name.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_url.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.disableretries.md +17 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.gethttpclient.md +17 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.md +313 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authheader.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.md +165 -0
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.md +160 -0
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.buildrequestfileobject.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.checkcredentials.md +71 -0
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.md +149 -0
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.computebasicauthheader.md +71 -0
- package/build/docs/ibm-cloud-sdk-core.constructfilepath.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.constructserviceurl.md +87 -0
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.getrefreshtoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.md +186 -0
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.getcrtoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.getrefreshtoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.md +156 -0
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.requesttoken.md +17 -0
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.contenttype.md +14 -0
- package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.md +128 -0
- package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md +15 -0
- package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.fileexistsatpath.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.fileobject.md +80 -0
- package/build/docs/ibm-cloud-sdk-core.fileobject.options.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.fileobject.value.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.fileoptions.contenttype.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.fileoptions.filename.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.fileoptions.md +74 -0
- package/build/docs/ibm-cloud-sdk-core.filestream.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.filestream.path.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.filewithmetadata.contenttype.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.filewithmetadata.data.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.filewithmetadata.filename.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.filewithmetadata.md +87 -0
- package/build/docs/ibm-cloud-sdk-core.getauthenticatorfromenvironment.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.getcontenttype.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.getcurrenttime.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.getformat.md +69 -0
- package/build/docs/ibm-cloud-sdk-core.getmissingparams.md +73 -0
- package/build/docs/ibm-cloud-sdk-core.getnewlogger.md +59 -0
- package/build/docs/ibm-cloud-sdk-core.getqueryparam.md +71 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.md +130 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumeauthenticator.tokenmanager.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.md +200 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.requesttoken.md +17 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.savetokeninfo.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setclientidandsecret.md +69 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setdisablesslverification.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setheaders.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamassumetokenmanager.setscope.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.getrefreshtoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.md +163 -0
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.md +90 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md +69 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setdisablesslverification.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setheaders.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.clientid.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.clientsecret.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.istokenexpired.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md +264 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.scope.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md +69 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientid.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.md +96 -0
- package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.scope.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.getrefreshtoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.md +126 -0
- package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.isemptyobject.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.isfiledata.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.isfilewithmetadata.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.ishtml.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.isjsonmimetype.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager._constructor_.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.md +163 -0
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokenname.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanageroptions.md +15 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.md +145 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.mcspauthenticator.tokenmanager.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.md +128 -0
- package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.requesttoken.md +15 -0
- package/build/docs/ibm-cloud-sdk-core.mcsptokenmanager.requiredoptions.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.md +820 -0
- package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticate.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.md +60 -0
- package/build/docs/ibm-cloud-sdk-core.onlyone.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.qs.md +21 -0
- package/build/docs/ibm-cloud-sdk-core.readcredentialsfile.md +17 -0
- package/build/docs/ibm-cloud-sdk-core.readcrtokenfile.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.readexternalsources.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.removesuffix.md +71 -0
- package/build/docs/ibm-cloud-sdk-core.sdklogger.debug.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.sdklogger.error.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.sdklogger.info.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.sdklogger.md +121 -0
- package/build/docs/ibm-cloud-sdk-core.sdklogger.verbose.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.sdklogger.warn.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.streamtopromise.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.striptrailingslash.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager._constructor_.md +49 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.accesstoken.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.disablesslverification.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.expiretime.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md +17 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.headers.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.istokenexpired.md +17 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.md +352 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.refreshtime.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.requesttoken.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.url.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.useragent.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.tokenmanageroptions.md +18 -0
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md +66 -0
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.tolowerkeys.md +55 -0
- package/build/docs/ibm-cloud-sdk-core.useroptions.authenticator.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.useroptions.disablesslverification.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.useroptions.headers.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.useroptions.jar.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.useroptions.md +171 -0
- package/build/docs/ibm-cloud-sdk-core.useroptions.serviceurl.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.useroptions.url.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.useroptions.version.md +13 -0
- package/build/docs/ibm-cloud-sdk-core.validateinput.md +73 -0
- package/build/docs/ibm-cloud-sdk-core.validateparams.md +89 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.md +158 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md +11 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md +54 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.istokenexpired.md +19 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.md +126 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md +15 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md +53 -0
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md +53 -0
- package/build/docs/index.md +29 -0
- package/docs/ibm-cloud-sdk-core.api.json +787 -404
- package/es/auth/authenticators/authenticator.d.ts +1 -0
- package/es/auth/authenticators/authenticator.js +1 -0
- package/es/auth/authenticators/container-authenticator.d.ts +6 -0
- package/es/auth/authenticators/container-authenticator.js +8 -0
- package/es/auth/authenticators/iam-assume-authenticator.d.ts +82 -0
- package/es/auth/authenticators/iam-assume-authenticator.js +70 -0
- package/es/auth/authenticators/iam-authenticator.d.ts +6 -0
- package/es/auth/authenticators/iam-authenticator.js +8 -0
- package/es/auth/authenticators/iam-request-based-authenticator-immutable.d.ts +64 -0
- package/es/auth/authenticators/iam-request-based-authenticator-immutable.js +51 -0
- package/es/auth/authenticators/iam-request-based-authenticator.d.ts +19 -47
- package/es/auth/authenticators/iam-request-based-authenticator.js +26 -35
- package/es/auth/authenticators/index.d.ts +4 -1
- package/es/auth/authenticators/index.js +1 -0
- package/es/auth/authenticators/token-request-based-authenticator-immutable.d.ts +71 -0
- package/es/auth/authenticators/token-request-based-authenticator-immutable.js +65 -0
- package/es/auth/authenticators/token-request-based-authenticator.d.ts +4 -42
- package/es/auth/authenticators/token-request-based-authenticator.js +3 -39
- package/es/auth/token-managers/container-token-manager.d.ts +6 -0
- package/es/auth/token-managers/container-token-manager.js +18 -24
- package/es/auth/token-managers/iam-assume-token-manager.d.ts +101 -0
- package/es/auth/token-managers/iam-assume-token-manager.js +164 -0
- package/es/auth/token-managers/iam-request-based-token-manager.d.ts +3 -9
- package/es/auth/token-managers/iam-request-based-token-manager.js +0 -8
- package/es/auth/token-managers/iam-token-manager.d.ts +8 -2
- package/es/auth/token-managers/iam-token-manager.js +10 -2
- package/es/auth/token-managers/index.d.ts +4 -2
- package/es/auth/token-managers/index.js +4 -2
- package/es/auth/utils/get-authenticator-from-environment.js +4 -1
- package/es/auth/utils/helpers.d.ts +18 -23
- package/es/auth/utils/helpers.js +35 -27
- package/es/tsdoc-metadata.json +11 -0
- package/etc/ibm-cloud-sdk-core.api.md +46 -28
- package/ibm-cloud-sdk-core.d.ts +264 -68
- package/package.json +2 -2
- package/temp/ibm-cloud-sdk-core.api.json +8646 -0
- package/temp/ibm-cloud-sdk-core.api.md +505 -0
|
@@ -175,19 +175,11 @@
|
|
|
175
175
|
{
|
|
176
176
|
"kind": "Function",
|
|
177
177
|
"canonicalReference": "ibm-cloud-sdk-core!atLeastOne:function(1)",
|
|
178
|
-
"docComment": "/**\n * Checks for at least one of
|
|
178
|
+
"docComment": "/**\n * Checks for at least one of the given elements being defined.\n *\n * @param args - The spread of arguments to check\n *\n * @returns true if one or more are defined; false if all are undefined\n */\n",
|
|
179
179
|
"excerptTokens": [
|
|
180
180
|
{
|
|
181
181
|
"kind": "Content",
|
|
182
|
-
"text": "export declare function atLeastOne(
|
|
183
|
-
},
|
|
184
|
-
{
|
|
185
|
-
"kind": "Content",
|
|
186
|
-
"text": "any"
|
|
187
|
-
},
|
|
188
|
-
{
|
|
189
|
-
"kind": "Content",
|
|
190
|
-
"text": ", b: "
|
|
182
|
+
"text": "export declare function atLeastOne(...args: "
|
|
191
183
|
},
|
|
192
184
|
{
|
|
193
185
|
"kind": "Content",
|
|
@@ -208,27 +200,19 @@
|
|
|
208
200
|
],
|
|
209
201
|
"fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
|
|
210
202
|
"returnTypeTokenRange": {
|
|
211
|
-
"startIndex":
|
|
212
|
-
"endIndex":
|
|
203
|
+
"startIndex": 3,
|
|
204
|
+
"endIndex": 4
|
|
213
205
|
},
|
|
214
206
|
"releaseTag": "Public",
|
|
215
207
|
"overloadIndex": 1,
|
|
216
208
|
"parameters": [
|
|
217
209
|
{
|
|
218
|
-
"parameterName": "
|
|
210
|
+
"parameterName": "args",
|
|
219
211
|
"parameterTypeTokenRange": {
|
|
220
212
|
"startIndex": 1,
|
|
221
213
|
"endIndex": 2
|
|
222
214
|
},
|
|
223
215
|
"isOptional": false
|
|
224
|
-
},
|
|
225
|
-
{
|
|
226
|
-
"parameterName": "b",
|
|
227
|
-
"parameterTypeTokenRange": {
|
|
228
|
-
"startIndex": 3,
|
|
229
|
-
"endIndex": 4
|
|
230
|
-
},
|
|
231
|
-
"isOptional": false
|
|
232
216
|
}
|
|
233
217
|
],
|
|
234
218
|
"name": "atLeastOne"
|
|
@@ -236,19 +220,11 @@
|
|
|
236
220
|
{
|
|
237
221
|
"kind": "Function",
|
|
238
222
|
"canonicalReference": "ibm-cloud-sdk-core!atMostOne:function(1)",
|
|
239
|
-
"docComment": "/**\n * Verifies that
|
|
223
|
+
"docComment": "/**\n * Verifies that no more than one of the given elements are defined. Returns true if one or none are defined, and false otherwise.\n *\n * @param args - The spread of arguments to check\n *\n * @returns false if more than one elements are defined, true otherwise\n */\n",
|
|
240
224
|
"excerptTokens": [
|
|
241
225
|
{
|
|
242
226
|
"kind": "Content",
|
|
243
|
-
"text": "export declare function atMostOne(
|
|
244
|
-
},
|
|
245
|
-
{
|
|
246
|
-
"kind": "Content",
|
|
247
|
-
"text": "any"
|
|
248
|
-
},
|
|
249
|
-
{
|
|
250
|
-
"kind": "Content",
|
|
251
|
-
"text": ", b: "
|
|
227
|
+
"text": "export declare function atMostOne(...args: "
|
|
252
228
|
},
|
|
253
229
|
{
|
|
254
230
|
"kind": "Content",
|
|
@@ -269,27 +245,19 @@
|
|
|
269
245
|
],
|
|
270
246
|
"fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
|
|
271
247
|
"returnTypeTokenRange": {
|
|
272
|
-
"startIndex":
|
|
273
|
-
"endIndex":
|
|
248
|
+
"startIndex": 3,
|
|
249
|
+
"endIndex": 4
|
|
274
250
|
},
|
|
275
251
|
"releaseTag": "Public",
|
|
276
252
|
"overloadIndex": 1,
|
|
277
253
|
"parameters": [
|
|
278
254
|
{
|
|
279
|
-
"parameterName": "
|
|
255
|
+
"parameterName": "args",
|
|
280
256
|
"parameterTypeTokenRange": {
|
|
281
257
|
"startIndex": 1,
|
|
282
258
|
"endIndex": 2
|
|
283
259
|
},
|
|
284
260
|
"isOptional": false
|
|
285
|
-
},
|
|
286
|
-
{
|
|
287
|
-
"parameterName": "b",
|
|
288
|
-
"parameterTypeTokenRange": {
|
|
289
|
-
"startIndex": 3,
|
|
290
|
-
"endIndex": 4
|
|
291
|
-
},
|
|
292
|
-
"isOptional": false
|
|
293
261
|
}
|
|
294
262
|
],
|
|
295
263
|
"name": "atMostOne"
|
|
@@ -539,6 +507,36 @@
|
|
|
539
507
|
"isProtected": false,
|
|
540
508
|
"isAbstract": false
|
|
541
509
|
},
|
|
510
|
+
{
|
|
511
|
+
"kind": "Property",
|
|
512
|
+
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_IAM_ASSUME:member",
|
|
513
|
+
"docComment": "",
|
|
514
|
+
"excerptTokens": [
|
|
515
|
+
{
|
|
516
|
+
"kind": "Content",
|
|
517
|
+
"text": "static AUTHTYPE_IAM_ASSUME: "
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"kind": "Content",
|
|
521
|
+
"text": "string"
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
"kind": "Content",
|
|
525
|
+
"text": ";"
|
|
526
|
+
}
|
|
527
|
+
],
|
|
528
|
+
"isReadonly": false,
|
|
529
|
+
"isOptional": false,
|
|
530
|
+
"releaseTag": "Public",
|
|
531
|
+
"name": "AUTHTYPE_IAM_ASSUME",
|
|
532
|
+
"propertyTypeTokenRange": {
|
|
533
|
+
"startIndex": 1,
|
|
534
|
+
"endIndex": 2
|
|
535
|
+
},
|
|
536
|
+
"isStatic": true,
|
|
537
|
+
"isProtected": false,
|
|
538
|
+
"isAbstract": false
|
|
539
|
+
},
|
|
542
540
|
{
|
|
543
541
|
"kind": "Property",
|
|
544
542
|
"canonicalReference": "ibm-cloud-sdk-core!Authenticator.AUTHTYPE_IAM:member",
|
|
@@ -2498,6 +2496,37 @@
|
|
|
2498
2496
|
"isAbstract": false,
|
|
2499
2497
|
"name": "authenticationType"
|
|
2500
2498
|
},
|
|
2499
|
+
{
|
|
2500
|
+
"kind": "Method",
|
|
2501
|
+
"canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#getRefreshToken:member(1)",
|
|
2502
|
+
"docComment": "/**\n * Return the most recently stored refresh token.\n *\n * @returns the refresh token string\n */\n",
|
|
2503
|
+
"excerptTokens": [
|
|
2504
|
+
{
|
|
2505
|
+
"kind": "Content",
|
|
2506
|
+
"text": "getRefreshToken(): "
|
|
2507
|
+
},
|
|
2508
|
+
{
|
|
2509
|
+
"kind": "Content",
|
|
2510
|
+
"text": "string"
|
|
2511
|
+
},
|
|
2512
|
+
{
|
|
2513
|
+
"kind": "Content",
|
|
2514
|
+
"text": ";"
|
|
2515
|
+
}
|
|
2516
|
+
],
|
|
2517
|
+
"isStatic": false,
|
|
2518
|
+
"returnTypeTokenRange": {
|
|
2519
|
+
"startIndex": 1,
|
|
2520
|
+
"endIndex": 2
|
|
2521
|
+
},
|
|
2522
|
+
"releaseTag": "Public",
|
|
2523
|
+
"isProtected": false,
|
|
2524
|
+
"overloadIndex": 1,
|
|
2525
|
+
"parameters": [],
|
|
2526
|
+
"isOptional": false,
|
|
2527
|
+
"isAbstract": false,
|
|
2528
|
+
"name": "getRefreshToken"
|
|
2529
|
+
},
|
|
2501
2530
|
{
|
|
2502
2531
|
"kind": "Method",
|
|
2503
2532
|
"canonicalReference": "ibm-cloud-sdk-core!ContainerAuthenticator#setCrTokenFilename:member(1)",
|
|
@@ -2769,6 +2798,37 @@
|
|
|
2769
2798
|
"isAbstract": false,
|
|
2770
2799
|
"name": "getCrToken"
|
|
2771
2800
|
},
|
|
2801
|
+
{
|
|
2802
|
+
"kind": "Method",
|
|
2803
|
+
"canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#getRefreshToken:member(1)",
|
|
2804
|
+
"docComment": "/**\n * Returns the most recently stored refresh token.\n *\n * @returns the refresh token\n */\n",
|
|
2805
|
+
"excerptTokens": [
|
|
2806
|
+
{
|
|
2807
|
+
"kind": "Content",
|
|
2808
|
+
"text": "getRefreshToken(): "
|
|
2809
|
+
},
|
|
2810
|
+
{
|
|
2811
|
+
"kind": "Content",
|
|
2812
|
+
"text": "string"
|
|
2813
|
+
},
|
|
2814
|
+
{
|
|
2815
|
+
"kind": "Content",
|
|
2816
|
+
"text": ";"
|
|
2817
|
+
}
|
|
2818
|
+
],
|
|
2819
|
+
"isStatic": false,
|
|
2820
|
+
"returnTypeTokenRange": {
|
|
2821
|
+
"startIndex": 1,
|
|
2822
|
+
"endIndex": 2
|
|
2823
|
+
},
|
|
2824
|
+
"releaseTag": "Public",
|
|
2825
|
+
"isProtected": false,
|
|
2826
|
+
"overloadIndex": 1,
|
|
2827
|
+
"parameters": [],
|
|
2828
|
+
"isOptional": false,
|
|
2829
|
+
"isAbstract": false,
|
|
2830
|
+
"name": "getRefreshToken"
|
|
2831
|
+
},
|
|
2772
2832
|
{
|
|
2773
2833
|
"kind": "Method",
|
|
2774
2834
|
"canonicalReference": "ibm-cloud-sdk-core!ContainerTokenManager#requestToken:member(1)",
|
|
@@ -3911,33 +3971,33 @@
|
|
|
3911
3971
|
},
|
|
3912
3972
|
{
|
|
3913
3973
|
"kind": "Class",
|
|
3914
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
3915
|
-
"docComment": "/**\n * The
|
|
3974
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeAuthenticator:class",
|
|
3975
|
+
"docComment": "/**\n * The IamAssumeAuthenticator obtains an IAM access token using the IAM \"get-token\" operation's \"assume\" grant type. The authenticator obtains an initial IAM access token from a user-supplied apikey, then exchanges this initial IAM access token for another IAM access token that has \"assumed the identity\" of the specified trusted profile.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n */\n",
|
|
3916
3976
|
"excerptTokens": [
|
|
3917
3977
|
{
|
|
3918
3978
|
"kind": "Content",
|
|
3919
|
-
"text": "export declare class
|
|
3979
|
+
"text": "export declare class IamAssumeAuthenticator extends "
|
|
3920
3980
|
},
|
|
3921
3981
|
{
|
|
3922
3982
|
"kind": "Reference",
|
|
3923
|
-
"text": "
|
|
3924
|
-
"canonicalReference": "ibm-cloud-sdk-core
|
|
3983
|
+
"text": "IamRequestBasedAuthenticatorImmutable",
|
|
3984
|
+
"canonicalReference": "ibm-cloud-sdk-core!~IamRequestBasedAuthenticatorImmutable:class"
|
|
3925
3985
|
},
|
|
3926
3986
|
{
|
|
3927
3987
|
"kind": "Content",
|
|
3928
3988
|
"text": " "
|
|
3929
3989
|
}
|
|
3930
3990
|
],
|
|
3931
|
-
"fileUrlPath": "dist/es/auth/authenticators/iam-authenticator.d.ts",
|
|
3991
|
+
"fileUrlPath": "dist/es/auth/authenticators/iam-assume-authenticator.d.ts",
|
|
3932
3992
|
"releaseTag": "Public",
|
|
3933
3993
|
"isAbstract": false,
|
|
3934
|
-
"name": "
|
|
3994
|
+
"name": "IamAssumeAuthenticator",
|
|
3935
3995
|
"preserveMemberOrder": false,
|
|
3936
3996
|
"members": [
|
|
3937
3997
|
{
|
|
3938
3998
|
"kind": "Constructor",
|
|
3939
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
3940
|
-
"docComment": "/**\n * Create a new
|
|
3999
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeAuthenticator:constructor(1)",
|
|
4000
|
+
"docComment": "/**\n * Create a new IamAssumeAuthenticator instance.\n *\n * @param options - Configuration options for IAM authentication. This should be an object containing these fields: - apikey: (required) the IAM api key for initial token request - iamProfileId: (optional) the ID of the trusted profile to use - iamProfileCrn: (optional) the CRN of the trusted profile to use - iamProfileName: (optional) the name of the trusted profile to use (must be specified with iamAccountId) - iamAccountId: (optional) the ID of the account the trusted profile is in (must be specified with iamProfileName) - url: (optional) the endpoint URL for the token service - 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 - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the \"scope\" parameter to use when fetching the bearer token from the token service\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
|
|
3941
4001
|
"excerptTokens": [
|
|
3942
4002
|
{
|
|
3943
4003
|
"kind": "Content",
|
|
@@ -3946,7 +4006,7 @@
|
|
|
3946
4006
|
{
|
|
3947
4007
|
"kind": "Reference",
|
|
3948
4008
|
"text": "Options",
|
|
3949
|
-
"canonicalReference": "ibm-cloud-sdk-core!~
|
|
4009
|
+
"canonicalReference": "ibm-cloud-sdk-core!~Options_14:interface"
|
|
3950
4010
|
},
|
|
3951
4011
|
{
|
|
3952
4012
|
"kind": "Content",
|
|
@@ -3969,8 +4029,8 @@
|
|
|
3969
4029
|
},
|
|
3970
4030
|
{
|
|
3971
4031
|
"kind": "Method",
|
|
3972
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
3973
|
-
"docComment": "/**\n * Returns the authenticator's type ('
|
|
4032
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeAuthenticator#authenticationType:member(1)",
|
|
4033
|
+
"docComment": "/**\n * Returns the authenticator's type ('iamAssume').\n *\n * @returns a string that indicates the authenticator's type\n */\n",
|
|
3974
4034
|
"excerptTokens": [
|
|
3975
4035
|
{
|
|
3976
4036
|
"kind": "Content",
|
|
@@ -4000,37 +4060,7 @@
|
|
|
4000
4060
|
},
|
|
4001
4061
|
{
|
|
4002
4062
|
"kind": "Property",
|
|
4003
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4004
|
-
"docComment": "",
|
|
4005
|
-
"excerptTokens": [
|
|
4006
|
-
{
|
|
4007
|
-
"kind": "Content",
|
|
4008
|
-
"text": "protected requiredOptions: "
|
|
4009
|
-
},
|
|
4010
|
-
{
|
|
4011
|
-
"kind": "Content",
|
|
4012
|
-
"text": "string[]"
|
|
4013
|
-
},
|
|
4014
|
-
{
|
|
4015
|
-
"kind": "Content",
|
|
4016
|
-
"text": ";"
|
|
4017
|
-
}
|
|
4018
|
-
],
|
|
4019
|
-
"isReadonly": false,
|
|
4020
|
-
"isOptional": false,
|
|
4021
|
-
"releaseTag": "Public",
|
|
4022
|
-
"name": "requiredOptions",
|
|
4023
|
-
"propertyTypeTokenRange": {
|
|
4024
|
-
"startIndex": 1,
|
|
4025
|
-
"endIndex": 2
|
|
4026
|
-
},
|
|
4027
|
-
"isStatic": false,
|
|
4028
|
-
"isProtected": true,
|
|
4029
|
-
"isAbstract": false
|
|
4030
|
-
},
|
|
4031
|
-
{
|
|
4032
|
-
"kind": "Property",
|
|
4033
|
-
"canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#tokenManager:member",
|
|
4063
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeAuthenticator#tokenManager:member",
|
|
4034
4064
|
"docComment": "",
|
|
4035
4065
|
"excerptTokens": [
|
|
4036
4066
|
{
|
|
@@ -4039,8 +4069,8 @@
|
|
|
4039
4069
|
},
|
|
4040
4070
|
{
|
|
4041
4071
|
"kind": "Reference",
|
|
4042
|
-
"text": "
|
|
4043
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4072
|
+
"text": "IamAssumeTokenManager",
|
|
4073
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager:class"
|
|
4044
4074
|
},
|
|
4045
4075
|
{
|
|
4046
4076
|
"kind": "Content",
|
|
@@ -4068,33 +4098,33 @@
|
|
|
4068
4098
|
},
|
|
4069
4099
|
{
|
|
4070
4100
|
"kind": "Class",
|
|
4071
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4072
|
-
"docComment": "/**\n * The
|
|
4101
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager:class",
|
|
4102
|
+
"docComment": "/**\n * The IamAssumeTokenManager takes an api key, along with trusted profile information, and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token that \"assumes\" the identify of the trusted profile.\n */\n",
|
|
4073
4103
|
"excerptTokens": [
|
|
4074
4104
|
{
|
|
4075
4105
|
"kind": "Content",
|
|
4076
|
-
"text": "export declare class
|
|
4106
|
+
"text": "export declare class IamAssumeTokenManager extends "
|
|
4077
4107
|
},
|
|
4078
4108
|
{
|
|
4079
4109
|
"kind": "Reference",
|
|
4080
|
-
"text": "
|
|
4081
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4110
|
+
"text": "IamRequestBasedTokenManager",
|
|
4111
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager:class"
|
|
4082
4112
|
},
|
|
4083
4113
|
{
|
|
4084
4114
|
"kind": "Content",
|
|
4085
4115
|
"text": " "
|
|
4086
4116
|
}
|
|
4087
4117
|
],
|
|
4088
|
-
"fileUrlPath": "dist/es/auth/
|
|
4118
|
+
"fileUrlPath": "dist/es/auth/token-managers/iam-assume-token-manager.d.ts",
|
|
4089
4119
|
"releaseTag": "Public",
|
|
4090
4120
|
"isAbstract": false,
|
|
4091
|
-
"name": "
|
|
4121
|
+
"name": "IamAssumeTokenManager",
|
|
4092
4122
|
"preserveMemberOrder": false,
|
|
4093
4123
|
"members": [
|
|
4094
4124
|
{
|
|
4095
4125
|
"kind": "Constructor",
|
|
4096
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4097
|
-
"docComment": "/**\n * Create a new
|
|
4126
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager:constructor(1)",
|
|
4127
|
+
"docComment": "/**\n * Create a new IamAssumeTokenManager instance.\n *\n * @param options - Configuration options. This should be an object containing these fields: - apikey: (required) the IAM api key - iamProfileId: (optional) the ID of the trusted profile to use - iamProfileCrn: (optional) the CRN of the trusted profile to use - iamProfileName: (optional) the name of the trusted profile to use (must be specified with iamAccountId) - iamAccountId: (optional) the ID of the account the trusted profile is in (must be specified with iamProfileName) - url: (optional) the endpoint URL for the IAM token service (default value: \"https://iam.cloud.ibm.com\") - 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 - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the \"scope\" parameter to use when fetching the bearer token from the token service\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
|
|
4098
4128
|
"excerptTokens": [
|
|
4099
4129
|
{
|
|
4100
4130
|
"kind": "Content",
|
|
@@ -4102,8 +4132,8 @@
|
|
|
4102
4132
|
},
|
|
4103
4133
|
{
|
|
4104
4134
|
"kind": "Reference",
|
|
4105
|
-
"text": "
|
|
4106
|
-
"canonicalReference": "ibm-cloud-sdk-core!~
|
|
4135
|
+
"text": "Options",
|
|
4136
|
+
"canonicalReference": "ibm-cloud-sdk-core!~Options_13:interface"
|
|
4107
4137
|
},
|
|
4108
4138
|
{
|
|
4109
4139
|
"kind": "Content",
|
|
@@ -4125,47 +4155,53 @@
|
|
|
4125
4155
|
]
|
|
4126
4156
|
},
|
|
4127
4157
|
{
|
|
4128
|
-
"kind": "
|
|
4129
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4130
|
-
"docComment": "",
|
|
4158
|
+
"kind": "Method",
|
|
4159
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#requestToken:member(1)",
|
|
4160
|
+
"docComment": "/**\n * Request an IAM token using a standard access token and a trusted profile.\n */\n",
|
|
4131
4161
|
"excerptTokens": [
|
|
4132
4162
|
{
|
|
4133
4163
|
"kind": "Content",
|
|
4134
|
-
"text": "protected
|
|
4164
|
+
"text": "protected requestToken(): "
|
|
4165
|
+
},
|
|
4166
|
+
{
|
|
4167
|
+
"kind": "Reference",
|
|
4168
|
+
"text": "Promise",
|
|
4169
|
+
"canonicalReference": "!Promise:interface"
|
|
4135
4170
|
},
|
|
4136
4171
|
{
|
|
4137
4172
|
"kind": "Content",
|
|
4138
|
-
"text": "
|
|
4173
|
+
"text": "<any>"
|
|
4139
4174
|
},
|
|
4140
4175
|
{
|
|
4141
4176
|
"kind": "Content",
|
|
4142
4177
|
"text": ";"
|
|
4143
4178
|
}
|
|
4144
4179
|
],
|
|
4145
|
-
"
|
|
4146
|
-
"
|
|
4147
|
-
"releaseTag": "Public",
|
|
4148
|
-
"name": "clientId",
|
|
4149
|
-
"propertyTypeTokenRange": {
|
|
4180
|
+
"isStatic": false,
|
|
4181
|
+
"returnTypeTokenRange": {
|
|
4150
4182
|
"startIndex": 1,
|
|
4151
|
-
"endIndex":
|
|
4183
|
+
"endIndex": 3
|
|
4152
4184
|
},
|
|
4153
|
-
"
|
|
4185
|
+
"releaseTag": "Public",
|
|
4154
4186
|
"isProtected": true,
|
|
4155
|
-
"
|
|
4187
|
+
"overloadIndex": 1,
|
|
4188
|
+
"parameters": [],
|
|
4189
|
+
"isOptional": false,
|
|
4190
|
+
"isAbstract": false,
|
|
4191
|
+
"name": "requestToken"
|
|
4156
4192
|
},
|
|
4157
4193
|
{
|
|
4158
4194
|
"kind": "Property",
|
|
4159
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4195
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#requiredOptions:member",
|
|
4160
4196
|
"docComment": "",
|
|
4161
4197
|
"excerptTokens": [
|
|
4162
4198
|
{
|
|
4163
4199
|
"kind": "Content",
|
|
4164
|
-
"text": "protected
|
|
4200
|
+
"text": "protected requiredOptions: "
|
|
4165
4201
|
},
|
|
4166
4202
|
{
|
|
4167
4203
|
"kind": "Content",
|
|
4168
|
-
"text": "string"
|
|
4204
|
+
"text": "string[]"
|
|
4169
4205
|
},
|
|
4170
4206
|
{
|
|
4171
4207
|
"kind": "Content",
|
|
@@ -4175,7 +4211,7 @@
|
|
|
4175
4211
|
"isReadonly": false,
|
|
4176
4212
|
"isOptional": false,
|
|
4177
4213
|
"releaseTag": "Public",
|
|
4178
|
-
"name": "
|
|
4214
|
+
"name": "requiredOptions",
|
|
4179
4215
|
"propertyTypeTokenRange": {
|
|
4180
4216
|
"startIndex": 1,
|
|
4181
4217
|
"endIndex": 2
|
|
@@ -4186,16 +4222,24 @@
|
|
|
4186
4222
|
},
|
|
4187
4223
|
{
|
|
4188
4224
|
"kind": "Method",
|
|
4189
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4190
|
-
"docComment": "/**\n *
|
|
4225
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#saveTokenInfo:member(1)",
|
|
4226
|
+
"docComment": "/**\n * Extend this method from the parent class to erase the refresh token from the class - we do not want to expose it for IAM Assume authentication.\n *\n * @param tokenResponse - the response object from JWT service request\n */\n",
|
|
4191
4227
|
"excerptTokens": [
|
|
4192
4228
|
{
|
|
4193
4229
|
"kind": "Content",
|
|
4194
|
-
"text": "
|
|
4230
|
+
"text": "protected saveTokenInfo(tokenResponse: "
|
|
4195
4231
|
},
|
|
4196
4232
|
{
|
|
4197
4233
|
"kind": "Content",
|
|
4198
|
-
"text": "
|
|
4234
|
+
"text": "any"
|
|
4235
|
+
},
|
|
4236
|
+
{
|
|
4237
|
+
"kind": "Content",
|
|
4238
|
+
"text": "): "
|
|
4239
|
+
},
|
|
4240
|
+
{
|
|
4241
|
+
"kind": "Content",
|
|
4242
|
+
"text": "void"
|
|
4199
4243
|
},
|
|
4200
4244
|
{
|
|
4201
4245
|
"kind": "Content",
|
|
@@ -4204,25 +4248,34 @@
|
|
|
4204
4248
|
],
|
|
4205
4249
|
"isStatic": false,
|
|
4206
4250
|
"returnTypeTokenRange": {
|
|
4207
|
-
"startIndex":
|
|
4208
|
-
"endIndex":
|
|
4251
|
+
"startIndex": 3,
|
|
4252
|
+
"endIndex": 4
|
|
4209
4253
|
},
|
|
4210
4254
|
"releaseTag": "Public",
|
|
4211
|
-
"isProtected":
|
|
4255
|
+
"isProtected": true,
|
|
4212
4256
|
"overloadIndex": 1,
|
|
4213
|
-
"parameters": [
|
|
4257
|
+
"parameters": [
|
|
4258
|
+
{
|
|
4259
|
+
"parameterName": "tokenResponse",
|
|
4260
|
+
"parameterTypeTokenRange": {
|
|
4261
|
+
"startIndex": 1,
|
|
4262
|
+
"endIndex": 2
|
|
4263
|
+
},
|
|
4264
|
+
"isOptional": false
|
|
4265
|
+
}
|
|
4266
|
+
],
|
|
4214
4267
|
"isOptional": false,
|
|
4215
4268
|
"isAbstract": false,
|
|
4216
|
-
"name": "
|
|
4269
|
+
"name": "saveTokenInfo"
|
|
4217
4270
|
},
|
|
4218
4271
|
{
|
|
4219
|
-
"kind": "
|
|
4220
|
-
"canonicalReference": "ibm-cloud-sdk-core!
|
|
4221
|
-
"docComment": "",
|
|
4272
|
+
"kind": "Method",
|
|
4273
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#setClientIdAndSecret:member(1)",
|
|
4274
|
+
"docComment": "/**\n * Sets the IAM \"clientId\" and \"clientSecret\" values for the IAM delegate.\n *\n * @param clientId - the client id.\n *\n * @param clientSecret - the client secret.\n */\n",
|
|
4222
4275
|
"excerptTokens": [
|
|
4223
4276
|
{
|
|
4224
4277
|
"kind": "Content",
|
|
4225
|
-
"text": "
|
|
4278
|
+
"text": "setClientIdAndSecret(clientId: "
|
|
4226
4279
|
},
|
|
4227
4280
|
{
|
|
4228
4281
|
"kind": "Content",
|
|
@@ -4230,13 +4283,380 @@
|
|
|
4230
4283
|
},
|
|
4231
4284
|
{
|
|
4232
4285
|
"kind": "Content",
|
|
4233
|
-
"text": "
|
|
4234
|
-
}
|
|
4235
|
-
|
|
4236
|
-
|
|
4237
|
-
|
|
4286
|
+
"text": ", clientSecret: "
|
|
4287
|
+
},
|
|
4288
|
+
{
|
|
4289
|
+
"kind": "Content",
|
|
4290
|
+
"text": "string"
|
|
4291
|
+
},
|
|
4292
|
+
{
|
|
4293
|
+
"kind": "Content",
|
|
4294
|
+
"text": "): "
|
|
4295
|
+
},
|
|
4296
|
+
{
|
|
4297
|
+
"kind": "Content",
|
|
4298
|
+
"text": "void"
|
|
4299
|
+
},
|
|
4300
|
+
{
|
|
4301
|
+
"kind": "Content",
|
|
4302
|
+
"text": ";"
|
|
4303
|
+
}
|
|
4304
|
+
],
|
|
4305
|
+
"isStatic": false,
|
|
4306
|
+
"returnTypeTokenRange": {
|
|
4307
|
+
"startIndex": 5,
|
|
4308
|
+
"endIndex": 6
|
|
4309
|
+
},
|
|
4310
|
+
"releaseTag": "Public",
|
|
4311
|
+
"isProtected": false,
|
|
4312
|
+
"overloadIndex": 1,
|
|
4313
|
+
"parameters": [
|
|
4314
|
+
{
|
|
4315
|
+
"parameterName": "clientId",
|
|
4316
|
+
"parameterTypeTokenRange": {
|
|
4317
|
+
"startIndex": 1,
|
|
4318
|
+
"endIndex": 2
|
|
4319
|
+
},
|
|
4320
|
+
"isOptional": false
|
|
4321
|
+
},
|
|
4322
|
+
{
|
|
4323
|
+
"parameterName": "clientSecret",
|
|
4324
|
+
"parameterTypeTokenRange": {
|
|
4325
|
+
"startIndex": 3,
|
|
4326
|
+
"endIndex": 4
|
|
4327
|
+
},
|
|
4328
|
+
"isOptional": false
|
|
4329
|
+
}
|
|
4330
|
+
],
|
|
4331
|
+
"isOptional": false,
|
|
4332
|
+
"isAbstract": false,
|
|
4333
|
+
"name": "setClientIdAndSecret"
|
|
4334
|
+
},
|
|
4335
|
+
{
|
|
4336
|
+
"kind": "Method",
|
|
4337
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#setDisableSslVerification:member(1)",
|
|
4338
|
+
"docComment": "/**\n * Sets the \"disableSslVerification\" property for the IAM delegate.\n *\n * @param value - the new value for the disableSslVerification property\n */\n",
|
|
4339
|
+
"excerptTokens": [
|
|
4340
|
+
{
|
|
4341
|
+
"kind": "Content",
|
|
4342
|
+
"text": "setDisableSslVerification(value: "
|
|
4343
|
+
},
|
|
4344
|
+
{
|
|
4345
|
+
"kind": "Content",
|
|
4346
|
+
"text": "boolean"
|
|
4347
|
+
},
|
|
4348
|
+
{
|
|
4349
|
+
"kind": "Content",
|
|
4350
|
+
"text": "): "
|
|
4351
|
+
},
|
|
4352
|
+
{
|
|
4353
|
+
"kind": "Content",
|
|
4354
|
+
"text": "void"
|
|
4355
|
+
},
|
|
4356
|
+
{
|
|
4357
|
+
"kind": "Content",
|
|
4358
|
+
"text": ";"
|
|
4359
|
+
}
|
|
4360
|
+
],
|
|
4361
|
+
"isStatic": false,
|
|
4362
|
+
"returnTypeTokenRange": {
|
|
4363
|
+
"startIndex": 3,
|
|
4364
|
+
"endIndex": 4
|
|
4365
|
+
},
|
|
4366
|
+
"releaseTag": "Public",
|
|
4367
|
+
"isProtected": false,
|
|
4368
|
+
"overloadIndex": 1,
|
|
4369
|
+
"parameters": [
|
|
4370
|
+
{
|
|
4371
|
+
"parameterName": "value",
|
|
4372
|
+
"parameterTypeTokenRange": {
|
|
4373
|
+
"startIndex": 1,
|
|
4374
|
+
"endIndex": 2
|
|
4375
|
+
},
|
|
4376
|
+
"isOptional": false
|
|
4377
|
+
}
|
|
4378
|
+
],
|
|
4379
|
+
"isOptional": false,
|
|
4380
|
+
"isAbstract": false,
|
|
4381
|
+
"name": "setDisableSslVerification"
|
|
4382
|
+
},
|
|
4383
|
+
{
|
|
4384
|
+
"kind": "Method",
|
|
4385
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#setHeaders:member(1)",
|
|
4386
|
+
"docComment": "/**\n * Sets the headers to be included in the IAM delegate's requests.\n *\n * @param headers - the set of headers to send with each request to the token server\n */\n",
|
|
4387
|
+
"excerptTokens": [
|
|
4388
|
+
{
|
|
4389
|
+
"kind": "Content",
|
|
4390
|
+
"text": "setHeaders(headers: "
|
|
4391
|
+
},
|
|
4392
|
+
{
|
|
4393
|
+
"kind": "Reference",
|
|
4394
|
+
"text": "OutgoingHttpHeaders",
|
|
4395
|
+
"canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface"
|
|
4396
|
+
},
|
|
4397
|
+
{
|
|
4398
|
+
"kind": "Content",
|
|
4399
|
+
"text": "): "
|
|
4400
|
+
},
|
|
4401
|
+
{
|
|
4402
|
+
"kind": "Content",
|
|
4403
|
+
"text": "void"
|
|
4404
|
+
},
|
|
4405
|
+
{
|
|
4406
|
+
"kind": "Content",
|
|
4407
|
+
"text": ";"
|
|
4408
|
+
}
|
|
4409
|
+
],
|
|
4410
|
+
"isStatic": false,
|
|
4411
|
+
"returnTypeTokenRange": {
|
|
4412
|
+
"startIndex": 3,
|
|
4413
|
+
"endIndex": 4
|
|
4414
|
+
},
|
|
4415
|
+
"releaseTag": "Public",
|
|
4416
|
+
"isProtected": false,
|
|
4417
|
+
"overloadIndex": 1,
|
|
4418
|
+
"parameters": [
|
|
4419
|
+
{
|
|
4420
|
+
"parameterName": "headers",
|
|
4421
|
+
"parameterTypeTokenRange": {
|
|
4422
|
+
"startIndex": 1,
|
|
4423
|
+
"endIndex": 2
|
|
4424
|
+
},
|
|
4425
|
+
"isOptional": false
|
|
4426
|
+
}
|
|
4427
|
+
],
|
|
4428
|
+
"isOptional": false,
|
|
4429
|
+
"isAbstract": false,
|
|
4430
|
+
"name": "setHeaders"
|
|
4431
|
+
},
|
|
4432
|
+
{
|
|
4433
|
+
"kind": "Method",
|
|
4434
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAssumeTokenManager#setScope:member(1)",
|
|
4435
|
+
"docComment": "/**\n * Sets the IAM \"scope\" value. This value is sent as the \"scope\" form parameter in the IAM delegate request.\n *\n * @param scope - a space-separated string that contains one or more scope names\n */\n",
|
|
4436
|
+
"excerptTokens": [
|
|
4437
|
+
{
|
|
4438
|
+
"kind": "Content",
|
|
4439
|
+
"text": "setScope(scope: "
|
|
4440
|
+
},
|
|
4441
|
+
{
|
|
4442
|
+
"kind": "Content",
|
|
4443
|
+
"text": "string"
|
|
4444
|
+
},
|
|
4445
|
+
{
|
|
4446
|
+
"kind": "Content",
|
|
4447
|
+
"text": "): "
|
|
4448
|
+
},
|
|
4449
|
+
{
|
|
4450
|
+
"kind": "Content",
|
|
4451
|
+
"text": "void"
|
|
4452
|
+
},
|
|
4453
|
+
{
|
|
4454
|
+
"kind": "Content",
|
|
4455
|
+
"text": ";"
|
|
4456
|
+
}
|
|
4457
|
+
],
|
|
4458
|
+
"isStatic": false,
|
|
4459
|
+
"returnTypeTokenRange": {
|
|
4460
|
+
"startIndex": 3,
|
|
4461
|
+
"endIndex": 4
|
|
4462
|
+
},
|
|
4463
|
+
"releaseTag": "Public",
|
|
4464
|
+
"isProtected": false,
|
|
4465
|
+
"overloadIndex": 1,
|
|
4466
|
+
"parameters": [
|
|
4467
|
+
{
|
|
4468
|
+
"parameterName": "scope",
|
|
4469
|
+
"parameterTypeTokenRange": {
|
|
4470
|
+
"startIndex": 1,
|
|
4471
|
+
"endIndex": 2
|
|
4472
|
+
},
|
|
4473
|
+
"isOptional": false
|
|
4474
|
+
}
|
|
4475
|
+
],
|
|
4476
|
+
"isOptional": false,
|
|
4477
|
+
"isAbstract": false,
|
|
4478
|
+
"name": "setScope"
|
|
4479
|
+
}
|
|
4480
|
+
],
|
|
4481
|
+
"extendsTokenRange": {
|
|
4482
|
+
"startIndex": 1,
|
|
4483
|
+
"endIndex": 2
|
|
4484
|
+
},
|
|
4485
|
+
"implementsTokenRanges": []
|
|
4486
|
+
},
|
|
4487
|
+
{
|
|
4488
|
+
"kind": "Class",
|
|
4489
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator:class",
|
|
4490
|
+
"docComment": "/**\n * The IamAuthenticator will use the user-supplied `apikey` value to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive \"clientId\" and \"clientSecret\" pair can be used to influence rate-limiting for requests to the IAM token server.\n *\n * The bearer token will be sent as an Authorization header in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n */\n",
|
|
4491
|
+
"excerptTokens": [
|
|
4492
|
+
{
|
|
4493
|
+
"kind": "Content",
|
|
4494
|
+
"text": "export declare class IamAuthenticator extends "
|
|
4495
|
+
},
|
|
4496
|
+
{
|
|
4497
|
+
"kind": "Reference",
|
|
4498
|
+
"text": "IamRequestBasedAuthenticator",
|
|
4499
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator:class"
|
|
4500
|
+
},
|
|
4501
|
+
{
|
|
4502
|
+
"kind": "Content",
|
|
4503
|
+
"text": " "
|
|
4504
|
+
}
|
|
4505
|
+
],
|
|
4506
|
+
"fileUrlPath": "dist/es/auth/authenticators/iam-authenticator.d.ts",
|
|
4507
|
+
"releaseTag": "Public",
|
|
4508
|
+
"isAbstract": false,
|
|
4509
|
+
"name": "IamAuthenticator",
|
|
4510
|
+
"preserveMemberOrder": false,
|
|
4511
|
+
"members": [
|
|
4512
|
+
{
|
|
4513
|
+
"kind": "Constructor",
|
|
4514
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator:constructor(1)",
|
|
4515
|
+
"docComment": "/**\n * Create a new IamAuthenticator instance.\n *\n * @param options - Configuration options for IAM authentication. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - apikey: (required) the IAM api key - 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 - clientId: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - clientSecret: (optional) the \"clientId\" and \"clientSecret\" fields are used to form a Basic Authorization header to be included in each request to the token service - scope: (optional) the \"scope\" parameter to use when fetching the bearer token from the token service\n *\n * @throws\n *\n * Error: the configuration options are not valid.\n */\n",
|
|
4516
|
+
"excerptTokens": [
|
|
4517
|
+
{
|
|
4518
|
+
"kind": "Content",
|
|
4519
|
+
"text": "constructor(options: "
|
|
4520
|
+
},
|
|
4521
|
+
{
|
|
4522
|
+
"kind": "Reference",
|
|
4523
|
+
"text": "Options",
|
|
4524
|
+
"canonicalReference": "ibm-cloud-sdk-core!~Options_6:interface"
|
|
4525
|
+
},
|
|
4526
|
+
{
|
|
4527
|
+
"kind": "Content",
|
|
4528
|
+
"text": ");"
|
|
4529
|
+
}
|
|
4530
|
+
],
|
|
4531
|
+
"releaseTag": "Public",
|
|
4532
|
+
"isProtected": false,
|
|
4533
|
+
"overloadIndex": 1,
|
|
4534
|
+
"parameters": [
|
|
4535
|
+
{
|
|
4536
|
+
"parameterName": "options",
|
|
4537
|
+
"parameterTypeTokenRange": {
|
|
4538
|
+
"startIndex": 1,
|
|
4539
|
+
"endIndex": 2
|
|
4540
|
+
},
|
|
4541
|
+
"isOptional": false
|
|
4542
|
+
}
|
|
4543
|
+
]
|
|
4544
|
+
},
|
|
4545
|
+
{
|
|
4546
|
+
"kind": "Method",
|
|
4547
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#authenticationType:member(1)",
|
|
4548
|
+
"docComment": "/**\n * Returns the authenticator's type ('iam').\n *\n * @returns a string that indicates the authenticator's type\n */\n",
|
|
4549
|
+
"excerptTokens": [
|
|
4550
|
+
{
|
|
4551
|
+
"kind": "Content",
|
|
4552
|
+
"text": "authenticationType(): "
|
|
4553
|
+
},
|
|
4554
|
+
{
|
|
4555
|
+
"kind": "Content",
|
|
4556
|
+
"text": "string"
|
|
4557
|
+
},
|
|
4558
|
+
{
|
|
4559
|
+
"kind": "Content",
|
|
4560
|
+
"text": ";"
|
|
4561
|
+
}
|
|
4562
|
+
],
|
|
4563
|
+
"isStatic": false,
|
|
4564
|
+
"returnTypeTokenRange": {
|
|
4565
|
+
"startIndex": 1,
|
|
4566
|
+
"endIndex": 2
|
|
4567
|
+
},
|
|
4568
|
+
"releaseTag": "Public",
|
|
4569
|
+
"isProtected": false,
|
|
4570
|
+
"overloadIndex": 1,
|
|
4571
|
+
"parameters": [],
|
|
4572
|
+
"isOptional": false,
|
|
4573
|
+
"isAbstract": false,
|
|
4574
|
+
"name": "authenticationType"
|
|
4575
|
+
},
|
|
4576
|
+
{
|
|
4577
|
+
"kind": "Method",
|
|
4578
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#getRefreshToken:member(1)",
|
|
4579
|
+
"docComment": "/**\n * Return the most recently stored refresh token.\n *\n * @returns the refresh token string\n */\n",
|
|
4580
|
+
"excerptTokens": [
|
|
4581
|
+
{
|
|
4582
|
+
"kind": "Content",
|
|
4583
|
+
"text": "getRefreshToken(): "
|
|
4584
|
+
},
|
|
4585
|
+
{
|
|
4586
|
+
"kind": "Content",
|
|
4587
|
+
"text": "string"
|
|
4588
|
+
},
|
|
4589
|
+
{
|
|
4590
|
+
"kind": "Content",
|
|
4591
|
+
"text": ";"
|
|
4592
|
+
}
|
|
4593
|
+
],
|
|
4594
|
+
"isStatic": false,
|
|
4595
|
+
"returnTypeTokenRange": {
|
|
4596
|
+
"startIndex": 1,
|
|
4597
|
+
"endIndex": 2
|
|
4598
|
+
},
|
|
4599
|
+
"releaseTag": "Public",
|
|
4600
|
+
"isProtected": false,
|
|
4601
|
+
"overloadIndex": 1,
|
|
4602
|
+
"parameters": [],
|
|
4603
|
+
"isOptional": false,
|
|
4604
|
+
"isAbstract": false,
|
|
4605
|
+
"name": "getRefreshToken"
|
|
4606
|
+
},
|
|
4607
|
+
{
|
|
4608
|
+
"kind": "Property",
|
|
4609
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#requiredOptions:member",
|
|
4610
|
+
"docComment": "",
|
|
4611
|
+
"excerptTokens": [
|
|
4612
|
+
{
|
|
4613
|
+
"kind": "Content",
|
|
4614
|
+
"text": "protected requiredOptions: "
|
|
4615
|
+
},
|
|
4616
|
+
{
|
|
4617
|
+
"kind": "Content",
|
|
4618
|
+
"text": "string[]"
|
|
4619
|
+
},
|
|
4620
|
+
{
|
|
4621
|
+
"kind": "Content",
|
|
4622
|
+
"text": ";"
|
|
4623
|
+
}
|
|
4624
|
+
],
|
|
4625
|
+
"isReadonly": false,
|
|
4626
|
+
"isOptional": false,
|
|
4238
4627
|
"releaseTag": "Public",
|
|
4239
|
-
"name": "
|
|
4628
|
+
"name": "requiredOptions",
|
|
4629
|
+
"propertyTypeTokenRange": {
|
|
4630
|
+
"startIndex": 1,
|
|
4631
|
+
"endIndex": 2
|
|
4632
|
+
},
|
|
4633
|
+
"isStatic": false,
|
|
4634
|
+
"isProtected": true,
|
|
4635
|
+
"isAbstract": false
|
|
4636
|
+
},
|
|
4637
|
+
{
|
|
4638
|
+
"kind": "Property",
|
|
4639
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamAuthenticator#tokenManager:member",
|
|
4640
|
+
"docComment": "",
|
|
4641
|
+
"excerptTokens": [
|
|
4642
|
+
{
|
|
4643
|
+
"kind": "Content",
|
|
4644
|
+
"text": "protected tokenManager: "
|
|
4645
|
+
},
|
|
4646
|
+
{
|
|
4647
|
+
"kind": "Reference",
|
|
4648
|
+
"text": "IamTokenManager",
|
|
4649
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamTokenManager:class"
|
|
4650
|
+
},
|
|
4651
|
+
{
|
|
4652
|
+
"kind": "Content",
|
|
4653
|
+
"text": ";"
|
|
4654
|
+
}
|
|
4655
|
+
],
|
|
4656
|
+
"isReadonly": false,
|
|
4657
|
+
"isOptional": false,
|
|
4658
|
+
"releaseTag": "Public",
|
|
4659
|
+
"name": "tokenManager",
|
|
4240
4660
|
"propertyTypeTokenRange": {
|
|
4241
4661
|
"startIndex": 1,
|
|
4242
4662
|
"endIndex": 2
|
|
@@ -4244,7 +4664,39 @@
|
|
|
4244
4664
|
"isStatic": false,
|
|
4245
4665
|
"isProtected": true,
|
|
4246
4666
|
"isAbstract": false
|
|
4667
|
+
}
|
|
4668
|
+
],
|
|
4669
|
+
"extendsTokenRange": {
|
|
4670
|
+
"startIndex": 1,
|
|
4671
|
+
"endIndex": 2
|
|
4672
|
+
},
|
|
4673
|
+
"implementsTokenRanges": []
|
|
4674
|
+
},
|
|
4675
|
+
{
|
|
4676
|
+
"kind": "Class",
|
|
4677
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator:class",
|
|
4678
|
+
"docComment": "/**\n * The IamRequestBasedAuthenticator provides shared configuration and functionality for authenticators that interact with the IAM token service. This authenticator is not meant for use on its own.\n */\n",
|
|
4679
|
+
"excerptTokens": [
|
|
4680
|
+
{
|
|
4681
|
+
"kind": "Content",
|
|
4682
|
+
"text": "export declare class IamRequestBasedAuthenticator extends "
|
|
4683
|
+
},
|
|
4684
|
+
{
|
|
4685
|
+
"kind": "Reference",
|
|
4686
|
+
"text": "IamRequestBasedAuthenticatorImmutable",
|
|
4687
|
+
"canonicalReference": "ibm-cloud-sdk-core!~IamRequestBasedAuthenticatorImmutable:class"
|
|
4247
4688
|
},
|
|
4689
|
+
{
|
|
4690
|
+
"kind": "Content",
|
|
4691
|
+
"text": " "
|
|
4692
|
+
}
|
|
4693
|
+
],
|
|
4694
|
+
"fileUrlPath": "dist/es/auth/authenticators/iam-request-based-authenticator.d.ts",
|
|
4695
|
+
"releaseTag": "Public",
|
|
4696
|
+
"isAbstract": false,
|
|
4697
|
+
"name": "IamRequestBasedAuthenticator",
|
|
4698
|
+
"preserveMemberOrder": false,
|
|
4699
|
+
"members": [
|
|
4248
4700
|
{
|
|
4249
4701
|
"kind": "Method",
|
|
4250
4702
|
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setClientIdAndSecret:member(1)",
|
|
@@ -4311,16 +4763,16 @@
|
|
|
4311
4763
|
},
|
|
4312
4764
|
{
|
|
4313
4765
|
"kind": "Method",
|
|
4314
|
-
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#
|
|
4315
|
-
"docComment": "/**\n *
|
|
4766
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setDisableSslVerification:member(1)",
|
|
4767
|
+
"docComment": "/**\n * Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.\n *\n * @param value - a flag that indicates whether verification of the token server's SSL certificate should be disabled or not.\n */\n",
|
|
4316
4768
|
"excerptTokens": [
|
|
4317
4769
|
{
|
|
4318
4770
|
"kind": "Content",
|
|
4319
|
-
"text": "
|
|
4771
|
+
"text": "setDisableSslVerification(value: "
|
|
4320
4772
|
},
|
|
4321
4773
|
{
|
|
4322
4774
|
"kind": "Content",
|
|
4323
|
-
"text": "
|
|
4775
|
+
"text": "boolean"
|
|
4324
4776
|
},
|
|
4325
4777
|
{
|
|
4326
4778
|
"kind": "Content",
|
|
@@ -4345,7 +4797,7 @@
|
|
|
4345
4797
|
"overloadIndex": 1,
|
|
4346
4798
|
"parameters": [
|
|
4347
4799
|
{
|
|
4348
|
-
"parameterName": "
|
|
4800
|
+
"parameterName": "value",
|
|
4349
4801
|
"parameterTypeTokenRange": {
|
|
4350
4802
|
"startIndex": 1,
|
|
4351
4803
|
"endIndex": 2
|
|
@@ -4355,38 +4807,104 @@
|
|
|
4355
4807
|
],
|
|
4356
4808
|
"isOptional": false,
|
|
4357
4809
|
"isAbstract": false,
|
|
4358
|
-
"name": "
|
|
4810
|
+
"name": "setDisableSslVerification"
|
|
4359
4811
|
},
|
|
4360
4812
|
{
|
|
4361
|
-
"kind": "
|
|
4362
|
-
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#
|
|
4363
|
-
"docComment": "",
|
|
4813
|
+
"kind": "Method",
|
|
4814
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setHeaders:member(1)",
|
|
4815
|
+
"docComment": "/**\n * Set headers.\n *\n * @param headers - a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers.\n */\n",
|
|
4364
4816
|
"excerptTokens": [
|
|
4365
4817
|
{
|
|
4366
4818
|
"kind": "Content",
|
|
4367
|
-
"text": "
|
|
4819
|
+
"text": "setHeaders(headers: "
|
|
4368
4820
|
},
|
|
4369
4821
|
{
|
|
4370
4822
|
"kind": "Reference",
|
|
4371
|
-
"text": "
|
|
4372
|
-
"canonicalReference": "
|
|
4823
|
+
"text": "OutgoingHttpHeaders",
|
|
4824
|
+
"canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface"
|
|
4825
|
+
},
|
|
4826
|
+
{
|
|
4827
|
+
"kind": "Content",
|
|
4828
|
+
"text": "): "
|
|
4829
|
+
},
|
|
4830
|
+
{
|
|
4831
|
+
"kind": "Content",
|
|
4832
|
+
"text": "void"
|
|
4373
4833
|
},
|
|
4374
4834
|
{
|
|
4375
4835
|
"kind": "Content",
|
|
4376
4836
|
"text": ";"
|
|
4377
4837
|
}
|
|
4378
4838
|
],
|
|
4379
|
-
"
|
|
4380
|
-
"
|
|
4381
|
-
|
|
4382
|
-
|
|
4383
|
-
"propertyTypeTokenRange": {
|
|
4384
|
-
"startIndex": 1,
|
|
4385
|
-
"endIndex": 2
|
|
4839
|
+
"isStatic": false,
|
|
4840
|
+
"returnTypeTokenRange": {
|
|
4841
|
+
"startIndex": 3,
|
|
4842
|
+
"endIndex": 4
|
|
4386
4843
|
},
|
|
4844
|
+
"releaseTag": "Public",
|
|
4845
|
+
"isProtected": false,
|
|
4846
|
+
"overloadIndex": 1,
|
|
4847
|
+
"parameters": [
|
|
4848
|
+
{
|
|
4849
|
+
"parameterName": "headers",
|
|
4850
|
+
"parameterTypeTokenRange": {
|
|
4851
|
+
"startIndex": 1,
|
|
4852
|
+
"endIndex": 2
|
|
4853
|
+
},
|
|
4854
|
+
"isOptional": false
|
|
4855
|
+
}
|
|
4856
|
+
],
|
|
4857
|
+
"isOptional": false,
|
|
4858
|
+
"isAbstract": false,
|
|
4859
|
+
"name": "setHeaders"
|
|
4860
|
+
},
|
|
4861
|
+
{
|
|
4862
|
+
"kind": "Method",
|
|
4863
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedAuthenticator#setScope:member(1)",
|
|
4864
|
+
"docComment": "/**\n * Setter for the \"scope\" parameter to use when fetching the bearer token from the IAM token server.\n *\n * @param scope - (optional) a space-separated string that specifies one or more scopes to be associated with IAM token requests\n */\n",
|
|
4865
|
+
"excerptTokens": [
|
|
4866
|
+
{
|
|
4867
|
+
"kind": "Content",
|
|
4868
|
+
"text": "setScope(scope: "
|
|
4869
|
+
},
|
|
4870
|
+
{
|
|
4871
|
+
"kind": "Content",
|
|
4872
|
+
"text": "string"
|
|
4873
|
+
},
|
|
4874
|
+
{
|
|
4875
|
+
"kind": "Content",
|
|
4876
|
+
"text": "): "
|
|
4877
|
+
},
|
|
4878
|
+
{
|
|
4879
|
+
"kind": "Content",
|
|
4880
|
+
"text": "void"
|
|
4881
|
+
},
|
|
4882
|
+
{
|
|
4883
|
+
"kind": "Content",
|
|
4884
|
+
"text": ";"
|
|
4885
|
+
}
|
|
4886
|
+
],
|
|
4387
4887
|
"isStatic": false,
|
|
4388
|
-
"
|
|
4389
|
-
|
|
4888
|
+
"returnTypeTokenRange": {
|
|
4889
|
+
"startIndex": 3,
|
|
4890
|
+
"endIndex": 4
|
|
4891
|
+
},
|
|
4892
|
+
"releaseTag": "Public",
|
|
4893
|
+
"isProtected": false,
|
|
4894
|
+
"overloadIndex": 1,
|
|
4895
|
+
"parameters": [
|
|
4896
|
+
{
|
|
4897
|
+
"parameterName": "scope",
|
|
4898
|
+
"parameterTypeTokenRange": {
|
|
4899
|
+
"startIndex": 1,
|
|
4900
|
+
"endIndex": 2
|
|
4901
|
+
},
|
|
4902
|
+
"isOptional": false
|
|
4903
|
+
}
|
|
4904
|
+
],
|
|
4905
|
+
"isOptional": false,
|
|
4906
|
+
"isAbstract": false,
|
|
4907
|
+
"name": "setScope"
|
|
4390
4908
|
}
|
|
4391
4909
|
],
|
|
4392
4910
|
"extendsTokenRange": {
|
|
@@ -4455,16 +4973,16 @@
|
|
|
4455
4973
|
},
|
|
4456
4974
|
{
|
|
4457
4975
|
"kind": "Property",
|
|
4458
|
-
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#
|
|
4976
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#clientId:member",
|
|
4459
4977
|
"docComment": "",
|
|
4460
4978
|
"excerptTokens": [
|
|
4461
4979
|
{
|
|
4462
4980
|
"kind": "Content",
|
|
4463
|
-
"text": "protected
|
|
4981
|
+
"text": "protected clientId: "
|
|
4464
4982
|
},
|
|
4465
4983
|
{
|
|
4466
4984
|
"kind": "Content",
|
|
4467
|
-
"text": "
|
|
4985
|
+
"text": "string"
|
|
4468
4986
|
},
|
|
4469
4987
|
{
|
|
4470
4988
|
"kind": "Content",
|
|
@@ -4474,7 +4992,7 @@
|
|
|
4474
4992
|
"isReadonly": false,
|
|
4475
4993
|
"isOptional": false,
|
|
4476
4994
|
"releaseTag": "Public",
|
|
4477
|
-
"name": "
|
|
4995
|
+
"name": "clientId",
|
|
4478
4996
|
"propertyTypeTokenRange": {
|
|
4479
4997
|
"startIndex": 1,
|
|
4480
4998
|
"endIndex": 2
|
|
@@ -4484,13 +5002,13 @@
|
|
|
4484
5002
|
"isAbstract": false
|
|
4485
5003
|
},
|
|
4486
5004
|
{
|
|
4487
|
-
"kind": "
|
|
4488
|
-
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#
|
|
4489
|
-
"docComment": "
|
|
5005
|
+
"kind": "Property",
|
|
5006
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#clientSecret:member",
|
|
5007
|
+
"docComment": "",
|
|
4490
5008
|
"excerptTokens": [
|
|
4491
5009
|
{
|
|
4492
5010
|
"kind": "Content",
|
|
4493
|
-
"text": "
|
|
5011
|
+
"text": "protected clientSecret: "
|
|
4494
5012
|
},
|
|
4495
5013
|
{
|
|
4496
5014
|
"kind": "Content",
|
|
@@ -4501,18 +5019,47 @@
|
|
|
4501
5019
|
"text": ";"
|
|
4502
5020
|
}
|
|
4503
5021
|
],
|
|
4504
|
-
"
|
|
4505
|
-
"
|
|
5022
|
+
"isReadonly": false,
|
|
5023
|
+
"isOptional": false,
|
|
5024
|
+
"releaseTag": "Public",
|
|
5025
|
+
"name": "clientSecret",
|
|
5026
|
+
"propertyTypeTokenRange": {
|
|
4506
5027
|
"startIndex": 1,
|
|
4507
5028
|
"endIndex": 2
|
|
4508
5029
|
},
|
|
4509
|
-
"
|
|
4510
|
-
"isProtected":
|
|
4511
|
-
"
|
|
4512
|
-
|
|
5030
|
+
"isStatic": false,
|
|
5031
|
+
"isProtected": true,
|
|
5032
|
+
"isAbstract": false
|
|
5033
|
+
},
|
|
5034
|
+
{
|
|
5035
|
+
"kind": "Property",
|
|
5036
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#formData:member",
|
|
5037
|
+
"docComment": "",
|
|
5038
|
+
"excerptTokens": [
|
|
5039
|
+
{
|
|
5040
|
+
"kind": "Content",
|
|
5041
|
+
"text": "protected formData: "
|
|
5042
|
+
},
|
|
5043
|
+
{
|
|
5044
|
+
"kind": "Content",
|
|
5045
|
+
"text": "any"
|
|
5046
|
+
},
|
|
5047
|
+
{
|
|
5048
|
+
"kind": "Content",
|
|
5049
|
+
"text": ";"
|
|
5050
|
+
}
|
|
5051
|
+
],
|
|
5052
|
+
"isReadonly": false,
|
|
4513
5053
|
"isOptional": false,
|
|
4514
|
-
"
|
|
4515
|
-
"name": "
|
|
5054
|
+
"releaseTag": "Public",
|
|
5055
|
+
"name": "formData",
|
|
5056
|
+
"propertyTypeTokenRange": {
|
|
5057
|
+
"startIndex": 1,
|
|
5058
|
+
"endIndex": 2
|
|
5059
|
+
},
|
|
5060
|
+
"isStatic": false,
|
|
5061
|
+
"isProtected": true,
|
|
5062
|
+
"isAbstract": false
|
|
4516
5063
|
},
|
|
4517
5064
|
{
|
|
4518
5065
|
"kind": "Method",
|
|
@@ -4659,6 +5206,36 @@
|
|
|
4659
5206
|
"isAbstract": false,
|
|
4660
5207
|
"name": "saveTokenInfo"
|
|
4661
5208
|
},
|
|
5209
|
+
{
|
|
5210
|
+
"kind": "Property",
|
|
5211
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#scope:member",
|
|
5212
|
+
"docComment": "",
|
|
5213
|
+
"excerptTokens": [
|
|
5214
|
+
{
|
|
5215
|
+
"kind": "Content",
|
|
5216
|
+
"text": "protected scope: "
|
|
5217
|
+
},
|
|
5218
|
+
{
|
|
5219
|
+
"kind": "Content",
|
|
5220
|
+
"text": "string"
|
|
5221
|
+
},
|
|
5222
|
+
{
|
|
5223
|
+
"kind": "Content",
|
|
5224
|
+
"text": ";"
|
|
5225
|
+
}
|
|
5226
|
+
],
|
|
5227
|
+
"isReadonly": false,
|
|
5228
|
+
"isOptional": false,
|
|
5229
|
+
"releaseTag": "Public",
|
|
5230
|
+
"name": "scope",
|
|
5231
|
+
"propertyTypeTokenRange": {
|
|
5232
|
+
"startIndex": 1,
|
|
5233
|
+
"endIndex": 2
|
|
5234
|
+
},
|
|
5235
|
+
"isStatic": false,
|
|
5236
|
+
"isProtected": true,
|
|
5237
|
+
"isAbstract": false
|
|
5238
|
+
},
|
|
4662
5239
|
{
|
|
4663
5240
|
"kind": "Method",
|
|
4664
5241
|
"canonicalReference": "ibm-cloud-sdk-core!IamRequestBasedTokenManager#setClientIdAndSecret:member(1)",
|
|
@@ -4894,7 +5471,7 @@
|
|
|
4894
5471
|
{
|
|
4895
5472
|
"kind": "Class",
|
|
4896
5473
|
"canonicalReference": "ibm-cloud-sdk-core!IamTokenManager:class",
|
|
4897
|
-
"docComment": "/**\n * The
|
|
5474
|
+
"docComment": "/**\n * The IamTokenManager takes an api key and performs the necessary interactions with the IAM token service to obtain and store a suitable bearer token. Additionally, the IamTokenManager will retrieve bearer tokens via basic auth using a supplied \"clientId\" and \"clientSecret\" pair.\n */\n",
|
|
4898
5475
|
"excerptTokens": [
|
|
4899
5476
|
{
|
|
4900
5477
|
"kind": "Content",
|
|
@@ -4949,6 +5526,37 @@
|
|
|
4949
5526
|
}
|
|
4950
5527
|
]
|
|
4951
5528
|
},
|
|
5529
|
+
{
|
|
5530
|
+
"kind": "Method",
|
|
5531
|
+
"canonicalReference": "ibm-cloud-sdk-core!IamTokenManager#getRefreshToken:member(1)",
|
|
5532
|
+
"docComment": "/**\n * Returns the most recently stored refresh token.\n *\n * @returns the refresh token\n */\n",
|
|
5533
|
+
"excerptTokens": [
|
|
5534
|
+
{
|
|
5535
|
+
"kind": "Content",
|
|
5536
|
+
"text": "getRefreshToken(): "
|
|
5537
|
+
},
|
|
5538
|
+
{
|
|
5539
|
+
"kind": "Content",
|
|
5540
|
+
"text": "string"
|
|
5541
|
+
},
|
|
5542
|
+
{
|
|
5543
|
+
"kind": "Content",
|
|
5544
|
+
"text": ";"
|
|
5545
|
+
}
|
|
5546
|
+
],
|
|
5547
|
+
"isStatic": false,
|
|
5548
|
+
"returnTypeTokenRange": {
|
|
5549
|
+
"startIndex": 1,
|
|
5550
|
+
"endIndex": 2
|
|
5551
|
+
},
|
|
5552
|
+
"releaseTag": "Public",
|
|
5553
|
+
"isProtected": false,
|
|
5554
|
+
"overloadIndex": 1,
|
|
5555
|
+
"parameters": [],
|
|
5556
|
+
"isOptional": false,
|
|
5557
|
+
"isAbstract": false,
|
|
5558
|
+
"name": "getRefreshToken"
|
|
5559
|
+
},
|
|
4952
5560
|
{
|
|
4953
5561
|
"kind": "Property",
|
|
4954
5562
|
"canonicalReference": "ibm-cloud-sdk-core!IamTokenManager#requiredOptions:member",
|
|
@@ -5884,19 +6492,11 @@
|
|
|
5884
6492
|
{
|
|
5885
6493
|
"kind": "Function",
|
|
5886
6494
|
"canonicalReference": "ibm-cloud-sdk-core!onlyOne:function(1)",
|
|
5887
|
-
"docComment": "/**\n * Checks
|
|
6495
|
+
"docComment": "/**\n * Checks that exactly one of the arguments provided is defined. Returns true if one argument is defined. Returns false if no argument are defined or if 2 or more are defined.\n *\n * @param args - The spread of arguments to check\n *\n * @returns true if and only if exactly one argument is defined\n */\n",
|
|
5888
6496
|
"excerptTokens": [
|
|
5889
6497
|
{
|
|
5890
6498
|
"kind": "Content",
|
|
5891
|
-
"text": "export declare function onlyOne(
|
|
5892
|
-
},
|
|
5893
|
-
{
|
|
5894
|
-
"kind": "Content",
|
|
5895
|
-
"text": "any"
|
|
5896
|
-
},
|
|
5897
|
-
{
|
|
5898
|
-
"kind": "Content",
|
|
5899
|
-
"text": ", b: "
|
|
6499
|
+
"text": "export declare function onlyOne(...args: "
|
|
5900
6500
|
},
|
|
5901
6501
|
{
|
|
5902
6502
|
"kind": "Content",
|
|
@@ -5917,27 +6517,19 @@
|
|
|
5917
6517
|
],
|
|
5918
6518
|
"fileUrlPath": "dist/es/auth/utils/helpers.d.ts",
|
|
5919
6519
|
"returnTypeTokenRange": {
|
|
5920
|
-
"startIndex":
|
|
5921
|
-
"endIndex":
|
|
6520
|
+
"startIndex": 3,
|
|
6521
|
+
"endIndex": 4
|
|
5922
6522
|
},
|
|
5923
6523
|
"releaseTag": "Public",
|
|
5924
6524
|
"overloadIndex": 1,
|
|
5925
6525
|
"parameters": [
|
|
5926
6526
|
{
|
|
5927
|
-
"parameterName": "
|
|
6527
|
+
"parameterName": "args",
|
|
5928
6528
|
"parameterTypeTokenRange": {
|
|
5929
6529
|
"startIndex": 1,
|
|
5930
6530
|
"endIndex": 2
|
|
5931
6531
|
},
|
|
5932
6532
|
"isOptional": false
|
|
5933
|
-
},
|
|
5934
|
-
{
|
|
5935
|
-
"parameterName": "b",
|
|
5936
|
-
"parameterTypeTokenRange": {
|
|
5937
|
-
"startIndex": 3,
|
|
5938
|
-
"endIndex": 4
|
|
5939
|
-
},
|
|
5940
|
-
"isOptional": false
|
|
5941
6533
|
}
|
|
5942
6534
|
],
|
|
5943
6535
|
"name": "onlyOne"
|
|
@@ -7031,8 +7623,8 @@
|
|
|
7031
7623
|
},
|
|
7032
7624
|
{
|
|
7033
7625
|
"kind": "Reference",
|
|
7034
|
-
"text": "
|
|
7035
|
-
"canonicalReference": "ibm-cloud-sdk-core
|
|
7626
|
+
"text": "TokenRequestBasedAuthenticatorImmutable",
|
|
7627
|
+
"canonicalReference": "ibm-cloud-sdk-core!~TokenRequestBasedAuthenticatorImmutable:class"
|
|
7036
7628
|
},
|
|
7037
7629
|
{
|
|
7038
7630
|
"kind": "Content",
|
|
@@ -7045,154 +7637,6 @@
|
|
|
7045
7637
|
"name": "TokenRequestBasedAuthenticator",
|
|
7046
7638
|
"preserveMemberOrder": false,
|
|
7047
7639
|
"members": [
|
|
7048
|
-
{
|
|
7049
|
-
"kind": "Constructor",
|
|
7050
|
-
"canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator:constructor(1)",
|
|
7051
|
-
"docComment": "/**\n * Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.\n *\n * @param options - Configuration options. This should be an object containing these fields: - url: (optional) the endpoint URL for the token service - 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\n */\n",
|
|
7052
|
-
"excerptTokens": [
|
|
7053
|
-
{
|
|
7054
|
-
"kind": "Content",
|
|
7055
|
-
"text": "constructor(options: "
|
|
7056
|
-
},
|
|
7057
|
-
{
|
|
7058
|
-
"kind": "Reference",
|
|
7059
|
-
"text": "BaseOptions",
|
|
7060
|
-
"canonicalReference": "ibm-cloud-sdk-core!~BaseOptions:type"
|
|
7061
|
-
},
|
|
7062
|
-
{
|
|
7063
|
-
"kind": "Content",
|
|
7064
|
-
"text": ");"
|
|
7065
|
-
}
|
|
7066
|
-
],
|
|
7067
|
-
"releaseTag": "Public",
|
|
7068
|
-
"isProtected": false,
|
|
7069
|
-
"overloadIndex": 1,
|
|
7070
|
-
"parameters": [
|
|
7071
|
-
{
|
|
7072
|
-
"parameterName": "options",
|
|
7073
|
-
"parameterTypeTokenRange": {
|
|
7074
|
-
"startIndex": 1,
|
|
7075
|
-
"endIndex": 2
|
|
7076
|
-
},
|
|
7077
|
-
"isOptional": false
|
|
7078
|
-
}
|
|
7079
|
-
]
|
|
7080
|
-
},
|
|
7081
|
-
{
|
|
7082
|
-
"kind": "Method",
|
|
7083
|
-
"canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#authenticate:member(1)",
|
|
7084
|
-
"docComment": "/**\n * Adds bearer token information to \"requestOptions\". The bearer token information will be set in the Authorization property of \"requestOptions.headers\" in the form:\n *\n * Authorization: Bearer \\<bearer-token\\>\n *\n * @param requestOptions - The request to augment with authentication information.\n */\n",
|
|
7085
|
-
"excerptTokens": [
|
|
7086
|
-
{
|
|
7087
|
-
"kind": "Content",
|
|
7088
|
-
"text": "authenticate(requestOptions: "
|
|
7089
|
-
},
|
|
7090
|
-
{
|
|
7091
|
-
"kind": "Reference",
|
|
7092
|
-
"text": "AuthenticateOptions",
|
|
7093
|
-
"canonicalReference": "ibm-cloud-sdk-core!~AuthenticateOptions:interface"
|
|
7094
|
-
},
|
|
7095
|
-
{
|
|
7096
|
-
"kind": "Content",
|
|
7097
|
-
"text": "): "
|
|
7098
|
-
},
|
|
7099
|
-
{
|
|
7100
|
-
"kind": "Reference",
|
|
7101
|
-
"text": "Promise",
|
|
7102
|
-
"canonicalReference": "!Promise:interface"
|
|
7103
|
-
},
|
|
7104
|
-
{
|
|
7105
|
-
"kind": "Content",
|
|
7106
|
-
"text": "<void>"
|
|
7107
|
-
},
|
|
7108
|
-
{
|
|
7109
|
-
"kind": "Content",
|
|
7110
|
-
"text": ";"
|
|
7111
|
-
}
|
|
7112
|
-
],
|
|
7113
|
-
"isStatic": false,
|
|
7114
|
-
"returnTypeTokenRange": {
|
|
7115
|
-
"startIndex": 3,
|
|
7116
|
-
"endIndex": 5
|
|
7117
|
-
},
|
|
7118
|
-
"releaseTag": "Public",
|
|
7119
|
-
"isProtected": false,
|
|
7120
|
-
"overloadIndex": 1,
|
|
7121
|
-
"parameters": [
|
|
7122
|
-
{
|
|
7123
|
-
"parameterName": "requestOptions",
|
|
7124
|
-
"parameterTypeTokenRange": {
|
|
7125
|
-
"startIndex": 1,
|
|
7126
|
-
"endIndex": 2
|
|
7127
|
-
},
|
|
7128
|
-
"isOptional": false
|
|
7129
|
-
}
|
|
7130
|
-
],
|
|
7131
|
-
"isOptional": false,
|
|
7132
|
-
"isAbstract": false,
|
|
7133
|
-
"name": "authenticate"
|
|
7134
|
-
},
|
|
7135
|
-
{
|
|
7136
|
-
"kind": "Property",
|
|
7137
|
-
"canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#disableSslVerification:member",
|
|
7138
|
-
"docComment": "",
|
|
7139
|
-
"excerptTokens": [
|
|
7140
|
-
{
|
|
7141
|
-
"kind": "Content",
|
|
7142
|
-
"text": "protected disableSslVerification: "
|
|
7143
|
-
},
|
|
7144
|
-
{
|
|
7145
|
-
"kind": "Content",
|
|
7146
|
-
"text": "boolean"
|
|
7147
|
-
},
|
|
7148
|
-
{
|
|
7149
|
-
"kind": "Content",
|
|
7150
|
-
"text": ";"
|
|
7151
|
-
}
|
|
7152
|
-
],
|
|
7153
|
-
"isReadonly": false,
|
|
7154
|
-
"isOptional": false,
|
|
7155
|
-
"releaseTag": "Public",
|
|
7156
|
-
"name": "disableSslVerification",
|
|
7157
|
-
"propertyTypeTokenRange": {
|
|
7158
|
-
"startIndex": 1,
|
|
7159
|
-
"endIndex": 2
|
|
7160
|
-
},
|
|
7161
|
-
"isStatic": false,
|
|
7162
|
-
"isProtected": true,
|
|
7163
|
-
"isAbstract": false
|
|
7164
|
-
},
|
|
7165
|
-
{
|
|
7166
|
-
"kind": "Property",
|
|
7167
|
-
"canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#headers:member",
|
|
7168
|
-
"docComment": "",
|
|
7169
|
-
"excerptTokens": [
|
|
7170
|
-
{
|
|
7171
|
-
"kind": "Content",
|
|
7172
|
-
"text": "protected headers: "
|
|
7173
|
-
},
|
|
7174
|
-
{
|
|
7175
|
-
"kind": "Reference",
|
|
7176
|
-
"text": "OutgoingHttpHeaders",
|
|
7177
|
-
"canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface"
|
|
7178
|
-
},
|
|
7179
|
-
{
|
|
7180
|
-
"kind": "Content",
|
|
7181
|
-
"text": ";"
|
|
7182
|
-
}
|
|
7183
|
-
],
|
|
7184
|
-
"isReadonly": false,
|
|
7185
|
-
"isOptional": false,
|
|
7186
|
-
"releaseTag": "Public",
|
|
7187
|
-
"name": "headers",
|
|
7188
|
-
"propertyTypeTokenRange": {
|
|
7189
|
-
"startIndex": 1,
|
|
7190
|
-
"endIndex": 2
|
|
7191
|
-
},
|
|
7192
|
-
"isStatic": false,
|
|
7193
|
-
"isProtected": true,
|
|
7194
|
-
"isAbstract": false
|
|
7195
|
-
},
|
|
7196
7640
|
{
|
|
7197
7641
|
"kind": "Method",
|
|
7198
7642
|
"canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#setDisableSslVerification:member(1)",
|
|
@@ -7289,67 +7733,6 @@
|
|
|
7289
7733
|
"isOptional": false,
|
|
7290
7734
|
"isAbstract": false,
|
|
7291
7735
|
"name": "setHeaders"
|
|
7292
|
-
},
|
|
7293
|
-
{
|
|
7294
|
-
"kind": "Property",
|
|
7295
|
-
"canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#tokenManager:member",
|
|
7296
|
-
"docComment": "",
|
|
7297
|
-
"excerptTokens": [
|
|
7298
|
-
{
|
|
7299
|
-
"kind": "Content",
|
|
7300
|
-
"text": "protected tokenManager: "
|
|
7301
|
-
},
|
|
7302
|
-
{
|
|
7303
|
-
"kind": "Reference",
|
|
7304
|
-
"text": "JwtTokenManager",
|
|
7305
|
-
"canonicalReference": "ibm-cloud-sdk-core!JwtTokenManager:class"
|
|
7306
|
-
},
|
|
7307
|
-
{
|
|
7308
|
-
"kind": "Content",
|
|
7309
|
-
"text": ";"
|
|
7310
|
-
}
|
|
7311
|
-
],
|
|
7312
|
-
"isReadonly": false,
|
|
7313
|
-
"isOptional": false,
|
|
7314
|
-
"releaseTag": "Public",
|
|
7315
|
-
"name": "tokenManager",
|
|
7316
|
-
"propertyTypeTokenRange": {
|
|
7317
|
-
"startIndex": 1,
|
|
7318
|
-
"endIndex": 2
|
|
7319
|
-
},
|
|
7320
|
-
"isStatic": false,
|
|
7321
|
-
"isProtected": true,
|
|
7322
|
-
"isAbstract": false
|
|
7323
|
-
},
|
|
7324
|
-
{
|
|
7325
|
-
"kind": "Property",
|
|
7326
|
-
"canonicalReference": "ibm-cloud-sdk-core!TokenRequestBasedAuthenticator#url:member",
|
|
7327
|
-
"docComment": "",
|
|
7328
|
-
"excerptTokens": [
|
|
7329
|
-
{
|
|
7330
|
-
"kind": "Content",
|
|
7331
|
-
"text": "protected url: "
|
|
7332
|
-
},
|
|
7333
|
-
{
|
|
7334
|
-
"kind": "Content",
|
|
7335
|
-
"text": "string"
|
|
7336
|
-
},
|
|
7337
|
-
{
|
|
7338
|
-
"kind": "Content",
|
|
7339
|
-
"text": ";"
|
|
7340
|
-
}
|
|
7341
|
-
],
|
|
7342
|
-
"isReadonly": false,
|
|
7343
|
-
"isOptional": false,
|
|
7344
|
-
"releaseTag": "Public",
|
|
7345
|
-
"name": "url",
|
|
7346
|
-
"propertyTypeTokenRange": {
|
|
7347
|
-
"startIndex": 1,
|
|
7348
|
-
"endIndex": 2
|
|
7349
|
-
},
|
|
7350
|
-
"isStatic": false,
|
|
7351
|
-
"isProtected": true,
|
|
7352
|
-
"isAbstract": false
|
|
7353
7736
|
}
|
|
7354
7737
|
],
|
|
7355
7738
|
"extendsTokenRange": {
|