ibm-cloud-sdk-core 5.7.0 → 5.9.0

package/auth/authenticators/cloud-pak-for-data-authenticator.d.ts

@@ -25,6 +25,8 @@ export interface Options extends BaseOptions {
     apikey?: string;
     /** The URL representing the Cloud Pak for Data token service endpoint. */
     url: string;
+    /** The CP4D account ID used to obtain a bearer token [optional]. */
+    cp4dAccountId?: string;
 }
 /**
  * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain
@@ -40,6 +42,7 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
     private username;
     private password;
     private apikey;
+    private cp4dAccountId;
     /**
      * Create a new CloudPakForDataAuthenticator instance.
      *
@@ -49,6 +52,7 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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

package/auth/authenticators/cloud-pak-for-data-authenticator.js

@@ -53,6 +53,7 @@ var CloudPakForDataAuthenticator = /** @class */ (function (_super) {
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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
@@ -65,6 +66,7 @@ var CloudPakForDataAuthenticator = /** @class */ (function (_super) {
         _this.username = options.username;
         _this.password = options.password;
         _this.apikey = options.apikey;
+        _this.cp4dAccountId = options.cp4dAccountId;
         // the param names are shared between the authenticator and the token
         // manager so we can just pass along the options object.
         // also, the token manager will handle input validation

package/auth/token-managers/cp4d-token-manager.d.ts

@@ -24,6 +24,8 @@ interface Options extends JwtTokenManagerOptions {
     password?: string;
     /** The API key used to obtain a bearer token [required if password not specified]. */
     apikey?: string;
+    /** The CP4D account ID used to obtain a bearer token [optional]. */
+    cp4dAccountId?: string;
 }
 export interface CpdTokenData {
     username: string;
@@ -31,7 +33,7 @@ export interface CpdTokenData {
     permissions: string[];
     sub: string;
     iss: string;
-    aud: string;
+    aud: string | string[];
     uid: string;
     _messageCode_: string;
     message: string;
@@ -48,6 +50,7 @@ export declare class Cp4dTokenManager extends JwtTokenManager {
     private username;
     private password;
     private apikey;
+    private cp4dAccountId;
     /**
      * Create a new Cp4dTokenManager instance.
      *
@@ -57,6 +60,7 @@ export declare class Cp4dTokenManager extends JwtTokenManager {
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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

package/auth/token-managers/cp4d-token-manager.js

@@ -56,6 +56,7 @@ var Cp4dTokenManager = /** @class */ (function (_super) {
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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
@@ -78,6 +79,7 @@ var Cp4dTokenManager = /** @class */ (function (_super) {
         _this.username = options.username;
         _this.password = options.password;
         _this.apikey = options.apikey;
+        _this.cp4dAccountId = options.cp4dAccountId;
         _this.userAgent = (0, build_user_agent_1.buildUserAgent)('cp4d-authenticator');
         return _this;
     }
@@ -94,6 +96,7 @@ var Cp4dTokenManager = /** @class */ (function (_super) {
                     username: this.username,
                     password: this.password,
                     api_key: this.apikey,
+                    account_id: this.cp4dAccountId,
                 },
                 method: 'POST',
                 headers: (0, extend_1.default)(true, {}, this.headers, requiredHeaders),

package/docs/ibm-cloud-sdk-core.api.json

@@ -2131,7 +2131,7 @@
             {
               "kind": "Constructor",
               "canonicalReference": "ibm-cloud-sdk-core!CloudPakForDataAuthenticator:constructor(1)",
-              "docComment": "/**\n * Create a new CloudPakForDataAuthenticator instance.\n *\n * @param options - Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n *\n * @throws\n *\n * Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.\n */\n",
+              "docComment": "/**\n * Create a new CloudPakForDataAuthenticator instance.\n *\n * @param options - Configuration options for CloudPakForData authentication. This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token - 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 * @throws\n *\n * Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -3167,7 +3167,7 @@
             {
               "kind": "Constructor",
               "canonicalReference": "ibm-cloud-sdk-core!Cp4dTokenManager:constructor(1)",
-              "docComment": "/**\n * Create a new Cp4dTokenManager instance.\n *\n * @param options - Configuration options This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate should be disabled or not - headers: (optional) a set of HTTP headers to be sent with each request to the token service\n *\n * @throws\n *\n * Error: the configuration options were invalid.\n */\n",
+              "docComment": "/**\n * Create a new Cp4dTokenManager instance.\n *\n * @param options - Configuration options This should be an object containing these fields: - url: (required) the endpoint URL for the CloudPakForData token service - username: (required) the username used to obtain a bearer token - password: (optional) the password used to obtain a bearer token (required if apikey is not specified) - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified) - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token - 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 * @throws\n *\n * Error: the configuration options were invalid.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",

package/es/auth/authenticators/cloud-pak-for-data-authenticator.d.ts

@@ -25,6 +25,8 @@ export interface Options extends BaseOptions {
     apikey?: string;
     /** The URL representing the Cloud Pak for Data token service endpoint. */
     url: string;
+    /** The CP4D account ID used to obtain a bearer token [optional]. */
+    cp4dAccountId?: string;
 }
 /**
  * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain
@@ -40,6 +42,7 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
     private username;
     private password;
     private apikey;
+    private cp4dAccountId;
     /**
      * Create a new CloudPakForDataAuthenticator instance.
      *
@@ -49,6 +52,7 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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

package/es/auth/authenticators/cloud-pak-for-data-authenticator.js

@@ -34,6 +34,7 @@ export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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
@@ -46,6 +47,7 @@ export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator
         this.username = options.username;
         this.password = options.password;
         this.apikey = options.apikey;
+        this.cp4dAccountId = options.cp4dAccountId;
         // the param names are shared between the authenticator and the token
         // manager so we can just pass along the options object.
         // also, the token manager will handle input validation

package/es/auth/token-managers/cp4d-token-manager.d.ts

@@ -24,6 +24,8 @@ interface Options extends JwtTokenManagerOptions {
     password?: string;
     /** The API key used to obtain a bearer token [required if password not specified]. */
     apikey?: string;
+    /** The CP4D account ID used to obtain a bearer token [optional]. */
+    cp4dAccountId?: string;
 }
 export interface CpdTokenData {
     username: string;
@@ -31,7 +33,7 @@ export interface CpdTokenData {
     permissions: string[];
     sub: string;
     iss: string;
-    aud: string;
+    aud: string | string[];
     uid: string;
     _messageCode_: string;
     message: string;
@@ -48,6 +50,7 @@ export declare class Cp4dTokenManager extends JwtTokenManager {
     private username;
     private password;
     private apikey;
+    private cp4dAccountId;
     /**
      * Create a new Cp4dTokenManager instance.
      *
@@ -57,6 +60,7 @@ export declare class Cp4dTokenManager extends JwtTokenManager {
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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

package/es/auth/token-managers/cp4d-token-manager.js

@@ -34,6 +34,7 @@ export class Cp4dTokenManager extends JwtTokenManager {
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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
@@ -56,6 +57,7 @@ export class Cp4dTokenManager extends JwtTokenManager {
         this.username = options.username;
         this.password = options.password;
         this.apikey = options.apikey;
+        this.cp4dAccountId = options.cp4dAccountId;
         this.userAgent = buildUserAgent('cp4d-authenticator');
     }
     requestToken() {
@@ -71,6 +73,7 @@ export class Cp4dTokenManager extends JwtTokenManager {
                     username: this.username,
                     password: this.password,
                     api_key: this.apikey,
+                    account_id: this.cp4dAccountId,
                 },
                 method: 'POST',
                 headers: extend(true, {}, this.headers, requiredHeaders),

package/ibm-cloud-sdk-core.d.ts

@@ -361,6 +361,7 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
     private username;
     private password;
     private apikey;
+    private cp4dAccountId;
     /**
      * Create a new CloudPakForDataAuthenticator instance.
      *
@@ -370,6 +371,7 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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
@@ -572,6 +574,7 @@ export declare class Cp4dTokenManager extends JwtTokenManager {
     private username;
     private password;
     private apikey;
+    private cp4dAccountId;
     /**
      * Create a new Cp4dTokenManager instance.
      *
@@ -581,6 +584,7 @@ export declare class Cp4dTokenManager extends JwtTokenManager {
      * - username: (required) the username used to obtain a bearer token
      * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
      * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - cp4dAccountId: (optional) the CP4D account ID used to obtain a bearer token
      * - 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
@@ -1480,6 +1484,8 @@ declare interface Options_3 extends JwtTokenManagerOptions {
     password?: string;
     /** The API key used to obtain a bearer token [required if password not specified]. */
     apikey?: string;
+    /** The CP4D account ID used to obtain a bearer token [optional]. */
+    cp4dAccountId?: string;
 }
 
 /** Configuration options for CloudPakForData authentication. */
@@ -1492,6 +1498,8 @@ declare interface Options_4 extends BaseOptions {
     apikey?: string;
     /** The URL representing the Cloud Pak for Data token service endpoint. */
     url: string;
+    /** The CP4D account ID used to obtain a bearer token [optional]. */
+    cp4dAccountId?: string;
 }
 
 /** Configuration options for IAM token retrieval. */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ibm-cloud-sdk-core",
-    "version": "5.7.0",
+    "version": "5.9.0",
     "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
     "main": "./index.js",
     "typings": "./es/index.d.ts",