ibm-cloud-sdk-core 5.3.2 → 5.4.1

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

@@ -55,6 +55,7 @@ export declare class Authenticator implements AuthenticatorInterface {
     static AUTHTYPE_NOAUTH: string;
     static AUTHTYPE_VPC: string;
     static AUTHTYPE_MCSP: string;
+    static AUTHTYPE_MCSPV2: string;
     static AUTHTYPE_UNKNOWN: string;
     /**
      * Create a new Authenticator instance.
@@ -739,7 +740,7 @@ export declare class IamAssumeAuthenticator extends IamRequestBasedAuthenticator
      *
      * @throws Error: the configuration options are not valid.
      */
-    constructor(options: Options_14);
+    constructor(options: Options_16);
     /**
      * Returns the authenticator's type ('iamAssume').
      *
@@ -783,7 +784,7 @@ export declare class IamAssumeTokenManager extends IamRequestBasedTokenManager {
      *
      * @throws Error: the configuration options are not valid.
      */
-    constructor(options: Options_13);
+    constructor(options: Options_15);
     /**
      * Request an IAM token using a standard access token and a trusted profile.
      */
@@ -1148,8 +1149,6 @@ export declare class McspAuthenticator extends TokenRequestBasedAuthenticator {
      * @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
@@ -1159,7 +1158,7 @@ export declare class McspAuthenticator extends TokenRequestBasedAuthenticator {
      */
     constructor(options: Options_12);
     /**
-     * Returns the authenticator's type ('cp4d').
+     * Returns the authenticator's type ('mcsp').
      *
      * @returns a string that indicates the authenticator's type
      */
@@ -1192,6 +1191,95 @@ export declare class McspTokenManager extends JwtTokenManager {
     protected requestToken(): Promise<any>;
 }
 
+/**
+ * The McspV2Authenticator invokes the MCSP v2 token-exchange operation (POST /api/2.0/\{scopeCollectionType\}/\{scopeId\}/apikeys/token)
+ * to obtain an access token for an apikey, and adds the access token to requests via an Authorization header
+ * of the form:  "Authorization: Bearer <access-token>"
+ */
+export declare class McspV2Authenticator extends TokenRequestBasedAuthenticator {
+    protected tokenManager: McspV2TokenManager;
+    /**
+     * Create a new McspV2Authenticator instance.
+     *
+     * @param options - Configuration options for MCSP v2 authentication.
+     * This should be an object containing these fields:
+     * - url: (required) the endpoint URL for the CloudPakForData token service.
+     * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified).
+     * - scopeCollectionType: (required) The scope collection type of item(s). Valid values are: "accounts", "subscriptions", "services".
+     * - scopeId: (required) the scope identifier of item(s).
+     * - includeBuiltinActions: (optional) a flag to include builtin actions in the "actions" claim in the MCSP access token (default: false).
+     * - includeCustomActions: (optional) a flag to include custom actions in the "actions" claim in the MCSP access token (default: false).
+     * - includeRoles: (optional) a flag to include the "roles" claim in the MCSP access token (default: true).
+     * - prefixRoles: (optional) a flag to add a prefix with the scope level where the role is defined in the "roles" claim (default: false).
+     * - callerExtClaim: (optional) a map (object) containing keys and values to be injected into the access token as the "callerExt" claim.
+     *     The keys used in this map must be enabled in the apikey by setting the "callerExtClaimNames" property when the apikey is created.
+     *     This property is typically only used in scenarios involving an apikey with identityType `SERVICEID`.
+     * - disableSslVerification: (optional) a flag to disable verification of the token server's SSL certificate; defaults to false.
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service.
+     *
+     * @throws Error: the input configuration failed validation
+     */
+    constructor(options: Options_14);
+    /**
+     * Returns the authenticator's type ('mcspv2').
+     *
+     * @returns a string that indicates the authenticator's type
+     */
+    authenticationType(): string;
+}
+
+/**
+ * Token Manager for Multi-Cloud Saas Platform (MCSP) V2 authentication.
+ *
+ * The McspV2TokenManager will invoke the MCSP token service's 'POST /api/2.0/\{scopeCollectionType\}/\{scopeId\}/apikeys/token'
+ * operation to obtain an MCSP access token for an apikey.
+ */
+export declare class McspV2TokenManager extends JwtTokenManager {
+    protected requiredOptions: string[];
+    private apikey;
+    private scopeCollectionType;
+    private scopeId;
+    private includeBuiltinActions;
+    private includeCustomActions;
+    private includeRoles;
+    private prefixRoles;
+    private callerExtClaim;
+    /**
+     * Create a new McspV2TokenManager instance.
+     *
+     * @param options - Configuration options.
+     * This should be an object containing these fields:
+     * - url: (required) the endpoint URL for the CloudPakForData token service.
+     * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified).
+     * - scopeCollectionType: (required) The scope collection type of item(s). Valid values are: "accounts", "subscriptions", "services".
+     * - scopeId: (required) the scope identifier of item(s).
+     * - includeBuiltinActions: (optional) a flag to include builtin actions in the "actions" claim in the MCSP access token (default: false).
+     * - includeCustomActions: (optional) a flag to include custom actions in the "actions" claim in the MCSP access token (default: false).
+     * - includeRoles: (optional) a flag to include the "roles" claim in the MCSP access token (default: true).
+     * - prefixRoles: (optional) a flag to add a prefix with the scope level where the role is defined in the "roles" claim (default: false).
+     * - callerExtClaim: (optional) a map (object) containing keys and values to be injected into the access token as the "callerExt" claim.
+     *     The keys used in this map must be enabled in the apikey by setting the "callerExtClaimNames" property when the apikey is created.
+     *     This property is typically only used in scenarios involving an apikey with identityType `SERVICEID`.
+     * - disableSslVerification: (optional) a flag to disable verification of the token server's SSL certificate; defaults to false.
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service.
+     *
+     * @throws Error: the input configuration failed validation
+     */
+    constructor(options: Options_13);
+    private PATH_TEMPLATE;
+    protected requestToken(): Promise<any>;
+    /**
+     * Parses the Options configuration property named by 'fieldName' as a boolean value.
+     * The value in the Options object could be either boolean or string and this function
+     * will do its best to parse it correctly.
+     * @param options - the Options object containing the configuration
+     * @param fieldName - the name of the field to parse as a boolean
+     * @param defaultValue - the default value to use in case the specified field is not present in Options
+     * @returns boolean the boolean value to be used for the configuration property
+     */
+    private static parseBoolean;
+}
+
 /**
  * NoAuthAuthenticator is a placeholder authenticator implementation which
  * performs no authentication of outgoing REST API requests. It might be
@@ -1251,8 +1339,96 @@ declare interface Options_12 extends BaseOptions {
     url: string;
 }
 
+/**
+ * Configuration options for MCSP v2 token retrieval.
+ */
+declare interface Options_13 extends JwtTokenManagerOptions {
+    /**
+     * (required) The API key used to obtain an MCSP access token.
+     */
+    apikey: string;
+    /**
+     * (required) The URL representing the MCSP token service endpoint.
+     */
+    url: string;
+    /**
+     * (required) The scope collection type of item(s).
+     * Valid values are: "accounts", "subscriptions", "services".
+     */
+    scopeCollectionType: string;
+    /**
+     * (required) The scope identifier of item(s).
+     */
+    scopeId: string;
+    /**
+     * (optional) A flag to include builtin actions in the "actions" claim in the MCSP access token (default: false).
+     */
+    includeBuiltinActions?: boolean;
+    /**
+     * (optional) A flag to include custom actions in the "actions" claim in the MCSP access token (default: false).
+     */
+    includeCustomActions?: boolean;
+    /**
+     * (optional) A flag to include the "roles" claim in the MCSP access token (default: true).
+     */
+    includeRoles?: boolean;
+    /**
+     * (optional) A flag to add a prefix with the scope level where the role is defined in the "roles" claim (default: false).
+     */
+    prefixRoles?: boolean;
+    /**
+     * (optional) A map (object) containing keys and values to be injected into the access token as the "callerExt" claim.
+     * The keys used in this map must be enabled in the apikey by setting the "callerExtClaimNames" property when the apikey is created.
+     * This property is typically only used in scenarios involving an apikey with identityType `SERVICEID`.
+     */
+    callerExtClaim?: object;
+}
+
+/** Configuration options for Multi-Cloud Saas Platform (MCSP) v2 authentication. */
+declare interface Options_14 extends BaseOptions {
+    /**
+     * (required) The API key used to obtain an MCSP access token.
+     */
+    apikey: string;
+    /**
+     * (required) The URL representing the MCSP token service endpoint.
+     */
+    url: string;
+    /**
+     * (required) The scope collection type of item(s).
+     * Valid values are: "accounts", "subscriptions", "services".
+     */
+    scopeCollectionType: string;
+    /**
+     * (required) The scope identifier of item(s).
+     */
+    scopeId: string;
+    /**
+     * (optional) A flag to include builtin actions in the "actions" claim in the MCSP access token (default: false).
+     */
+    includeBuiltinActions?: boolean;
+    /**
+     * (optional) A flag to include custom actions in the "actions" claim in the MCSP access token (default: false).
+     */
+    includeCustomActions?: boolean;
+    /**
+     * (optional) A flag to include the "roles" claim in the MCSP access token (default: true).
+     */
+    includeRoles?: boolean;
+    /**
+     * (optional) A flag to add a prefix with the scope level where the role is defined in the "roles" claim (default: false).
+     */
+    prefixRoles?: boolean;
+    /**
+     * (optional) A map (object) containing keys and values to be injected into the access token as the "callerExt" claim.
+     * The keys used in this map must be enabled in the apikey by setting the "callerExtClaimNames" property when the apikey is created.
+     * This property is typically only used in scenarios involving an apikey with identityType `SERVICEID`.
+     */
+    callerExtClaim?: object;
+}
+
 /** Configuration options for IAM Assume token retrieval. */
-declare interface Options_13 extends IamRequestOptions {
+declare interface Options_15 extends IamRequestOptions {
     apikey: string;
     iamProfileId?: string;
     iamProfileCrn?: string;
@@ -1261,7 +1437,7 @@ declare interface Options_13 extends IamRequestOptions {
 }
 
 /** Configuration options for IAM Assume authentication. */
-declare interface Options_14 extends IamRequestOptions_2 {
+declare interface Options_16 extends IamRequestOptions_2 {
     /** The IAM api key */
     apikey: string;
     /**

package/lib/request-wrapper.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2024.
+ * (C) Copyright IBM Corp. 2014, 2025.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/lib/request-wrapper.js

@@ -76,7 +76,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestWrapper = void 0;
 /**
- * (C) Copyright IBM Corp. 2014, 2024.
+ * (C) Copyright IBM Corp. 2014, 2025.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -179,10 +179,15 @@ var RequestWrapper = /** @class */ (function () {
      * @returns the string representation of the request
      */
     RequestWrapper.prototype.formatAxiosRequest = function (request) {
-        var method = request.method, url = request.url, data = request.data, headers = request.headers;
+        var method = request.method, url = request.url, data = request.data, headers = request.headers, params = request.params;
+        var queryString = (0, querystring_1.stringify)(params);
+        if (queryString) {
+            queryString = "?".concat(queryString);
+        }
         var headersOutput = this.formatAxiosHeaders(headers);
         var body = this.formatAxiosBody(data);
-        var output = "".concat((method || '??').toUpperCase(), " ").concat(url || '??', "\n").concat(headersOutput, "\n").concat(body);
+        var urlStr = url ? url + queryString : '??';
+        var output = "".concat((method || '??').toUpperCase(), " ").concat(urlStr, "\n").concat(headersOutput, "\n").concat(body);
         return (0, private_helpers_1.redactSecrets)(output);
     };
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ibm-cloud-sdk-core",
-    "version": "5.3.2",
+    "version": "5.4.1",
     "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
     "main": "./index.js",
     "typings": "./es/index.d.ts",
@@ -43,7 +43,7 @@
         "dotenv": "^16.4.5",
         "extend": "3.0.2",
         "file-type": "16.5.4",
-        "form-data": "4.0.0",
+        "form-data": "^4.0.4",
         "isstream": "0.1.2",
         "jsonwebtoken": "^9.0.2",
         "mime-types": "2.1.35",