@nutanix-scratch/iam-js-client 4.0.1-beta.1 → 4.0.1

package/dist/lib/apis/usergroups-endpoints.js

@@ -0,0 +1,256 @@
+"use strict";
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UserGroupsApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _UserGroup = _interopRequireDefault(require("../models/iam/v4/authn/UserGroup"));
+var _DeleteUserGroupApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/DeleteUserGroupApiResponse"));
+var _ListUserGroupsApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/ListUserGroupsApiResponse"));
+var _CreateUserGroupApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/CreateUserGroupApiResponse"));
+var _GetUserGroupApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/GetUserGroupApiResponse"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); } /*
+ * Nutanix IAM Versioned APIs
+ *
+ * OpenAPI spec version: 4.0.1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 16.9.0.8546-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * UserGroups service.
+ * @version 4.0.1
+ * @class UserGroupsApi
+ */
+var _headersToSkip = /*#__PURE__*/new WeakMap();
+var UserGroupsApi = exports.UserGroupsApi = /*#__PURE__*/function () {
+  /**
+   * Constructs a new UserGroupsApi. 
+   * @alias module:api/UserGroupsApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  function UserGroupsApi(apiClient) {
+    _classCallCheck(this, UserGroupsApi);
+    _classPrivateFieldInitSpec(this, _headersToSkip, void 0);
+    this.apiClient = apiClient || _ApiClient.ApiClient.instance;
+    _classPrivateFieldSet(_headersToSkip, this, new Set());
+    _classPrivateFieldGet(_headersToSkip, this).add('authorization');
+    _classPrivateFieldGet(_headersToSkip, this).add('cookie');
+    _classPrivateFieldGet(_headersToSkip, this).add('host');
+    _classPrivateFieldGet(_headersToSkip, this).add('user-agent');
+  }
+
+  /**
+   * Create user group
+   * Creates a user group.
+   * @param { Partial<UserGroup> } body specification
+   * @param {Object} args Additional Arguments
+   * @return {Promise<CreateUserGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateUserGroupApiResponse } and HTTP response
+   */
+  return _createClass(UserGroupsApi, [{
+    key: "createUserGroup",
+    value: function createUserGroup(body) {
+      var _this = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var postBody = null;
+      if (body instanceof _UserGroup["default"] && typeof body.toJson === 'function') {
+        postBody = body.toJson();
+      } else {
+        postBody = body;
+      }
+      // verify the required parameter 'body' is set
+      if (typeof postBody === 'undefined' || postBody === null) {
+        throw new Error("Invalid body when calling createUserGroup");
+      }
+      var pathParams = {};
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      _ApiClient.ApiClient.addEtagReferenceToHeader(body, headerParams);
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _CreateUserGroupApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/user-groups', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Delete user group
+     * Deletes a user group based on the provided external identifier.
+     * @param { String } extId External identifier of the user group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteUserGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteUserGroupApiResponse } and HTTP response
+     */
+  }, {
+    key: "deleteUserGroupById",
+    value: function deleteUserGroupById(extId) {
+      var _this2 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var postBody = null;
+      // verify the required parameter 'extId' is set
+      if (typeof extId === 'undefined' || extId === null) {
+        throw new Error("Missing the required parameter 'extId' when calling deleteUserGroupById");
+      }
+      var pathParams = {
+        'extId': extId
+      };
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this2).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _DeleteUserGroupApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/user-groups/{extId}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Get user group
+     * Displays a user group based on the provided external identifier.
+     * @param { String } extId External identifier of the user group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetUserGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetUserGroupApiResponse } and HTTP response
+     */
+  }, {
+    key: "getUserGroupById",
+    value: function getUserGroupById(extId) {
+      var _this3 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var postBody = null;
+      // verify the required parameter 'extId' is set
+      if (typeof extId === 'undefined' || extId === null) {
+        throw new Error("Missing the required parameter 'extId' when calling getUserGroupById");
+      }
+      var pathParams = {
+        'extId': extId
+      };
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this3).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _GetUserGroupApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/user-groups/{extId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * List user groups
+     * Lists all user group(s).
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+      * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+      * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - createdBy<br>
+     * - distinguishedName<br>
+     * - extId<br>
+     * - groupType<br>
+     * - idpId<br>
+     * - name
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - createdTime<br>
+     * - distinguishedName<br>
+     * - groupType<br>
+     * - lastUpdatedTime<br>
+     * - name
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
+    - createdBy
+    - createdTime
+    - distinguishedName
+    - extId
+    - groupType
+    - idpId
+    - lastUpdatedTime
+    - links
+    - name
+    - tenantId
+      * @param {Object} args Additional Arguments
+     * @return {Promise<ListUserGroupsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUserGroupsApiResponse } and HTTP response
+     */
+  }, {
+    key: "listUserGroups",
+    value: function listUserGroups(opts) {
+      var _this4 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      opts = opts || {};
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, opts.hasOwnProperty('$page') ? {
+        '$page': opts['$page']
+      } : {}), opts.hasOwnProperty('$limit') ? {
+        '$limit': opts['$limit']
+      } : {}), opts.hasOwnProperty('$filter') ? {
+        '$filter': opts['$filter']
+      } : {}), opts.hasOwnProperty('$orderby') ? {
+        '$orderby': opts['$orderby']
+      } : {}), opts.hasOwnProperty('$select') ? {
+        '$select': opts['$select']
+      } : {});
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this4).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _ListUserGroupsApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/user-groups', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+  }], [{
+    key: "ApiClient",
+    get:
+    /**
+    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+    * their own fetch methods into the SDK
+    */
+    function get() {
+      return _ApiClient.ApiClient;
+    }
+  }]);
+}();

package/dist/lib/apis/users-endpoints.d.ts

@@ -0,0 +1,337 @@
+/**
+ * Users service.
+ * @version 4.0.1
+ * @class UsersApi
+ */
+export class UsersApi {
+    /**
+    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+    * their own fetch methods into the SDK
+    */
+    static get ApiClient(): typeof ApiClient;
+    /**
+     * Constructs a new UsersApi.
+     * @alias module:api/UsersApi
+     * @class
+     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+     * default to {@link module:ApiClient#instance} if unspecified.
+     */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Change password of user
+     * Change Password for a user with the given username.
+     * @param { Required<Pick<PasswordChangeRequest, 'username' | 'oldPassword' | 'newPassword'>> & Partial<PasswordChangeRequest> } body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ChangeUserPasswordApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ChangeUserPasswordApiResponse } and HTTP response
+     */
+    changeUserPassword(body: Required<Pick<PasswordChangeRequest, 'username' | 'oldPassword' | 'newPassword'>> & Partial<PasswordChangeRequest>, ...args: any): Promise<ChangeUserPasswordApiResponse>;
+    /**
+     * Create bucket access key for user
+     * Creates access key identifier and secret access key to call Nutanix buckets service.
+     * @deprecated This API has been deprecated.
+     * @param { Required<Pick<BucketsAccessKey, 'accessKeyName'>> & Partial<BucketsAccessKey> } body specification
+     * @param { String } userExtId External identifier of a user.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CreateUserKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateUserKeyApiResponse } and HTTP response
+     */
+    createBucketAccessKey(userExtId: string, body: Required<Pick<BucketsAccessKey, 'accessKeyName'>> & Partial<BucketsAccessKey>, ...args: any): Promise<CreateUserKeyApiResponse>;
+    /**
+     * Create user
+     * Creates a user of the type specified in the request.
+     * @param { Partial<User> } body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CreateUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateUserApiResponse } and HTTP response
+     */
+    createUser(body: Partial<User>, ...args: any): Promise<CreateUserApiResponse>;
+    /**
+     * Create a key of the requested key type for a user
+     * Create key of a requested type for a user.
+     * @param { Required<Pick<Key, 'name' | 'keyType'>> & Partial<Key> } body specification
+     * @param { String } userExtId External identifier of a user.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CreateKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateKeyApiResponse } and HTTP response
+     */
+    createUserKey(userExtId: string, body: Required<Pick<Key, 'name' | 'keyType'>> & Partial<Key>, ...args: any): Promise<CreateKeyApiResponse>;
+    /**
+     * Delete buckets access key of user
+     * Deletes a bucket access key for the user based on the provided external identifier.
+     * @deprecated This API has been deprecated.
+     * @param { String } userExtId External identifier of a user.
+     * @param { String } extId External identifier for the bucket access key.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteUserKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteUserKeyApiResponse } and HTTP response
+     */
+    deleteUserBucketKeyById(userExtId: string, extId: string, ...args: any): Promise<DeleteUserKeyApiResponse>;
+    /**
+     * Delete the requested key
+     * Delete the requested key.
+     * @param { String } userExtId External identifier of a user.
+     * @param { String } extId External identifier of the key.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteUserKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteUserKeyApiResponse } and HTTP response
+     */
+    deleteUserKeyById(userExtId: string, extId: string, ...args: any): Promise<DeleteUserKeyApiResponse>;
+    /**
+     * Get bucket access key of user
+     * Displays bucket access key of the user based on the user&#x27;s external identifier.
+     * @deprecated This API has been deprecated.
+     * @param { String } userExtId External identifier of a user.
+     * @param { String } extId External identifier for the bucket access key.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetUserBucketKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetUserBucketKeyApiResponse } and HTTP response
+     */
+    getUserBucketKeyById(userExtId: string, extId: string, ...args: any): Promise<GetUserBucketKeyApiResponse>;
+    /**
+     * Get user
+     * Fetches a user based on the provided external identifier.
+     * @param { String } extId External identifier of a user.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetUserApiResponse } and HTTP response
+     */
+    getUserById(extId: string, ...args: any): Promise<GetUserApiResponse>;
+    /**
+     * Get the requested key
+     * Fetches the requested key through the provided external identifier for the user and the key.
+     * @param { String } userExtId External identifier of a user.
+     * @param { String } extId External identifier of the key.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetUserKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetUserKeyApiResponse } and HTTP response
+     */
+    getUserKeyById(userExtId: string, extId: string, ...args: any): Promise<GetUserKeyApiResponse>;
+    /**
+     * List bucket access keys of user
+     * Lists all bucket access key(s) for the user based on the external identifier.
+     * @deprecated This API has been deprecated.
+     * @param { String } userExtId External identifier of a user.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - accessKeyName<br>
+     * - assignedTo<br>
+     * - creationType<br>
+     * - extId<br>
+     * - lastUpdatedBy<br>
+     * - status<br>
+     * - tenantId<br>
+     * - userId
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - accessKeyName<br>
+     * - assignedTo<br>
+     * - createdBy<br>
+     * - createdTime<br>
+     * - expiryTime<br>
+     * - lastUpdatedTime<br>
+     * - status<br>
+     * - tenantId
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListUserBucketKeysApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUserBucketKeysApiResponse } and HTTP response
+     */
+    listUserBucketKeys(userExtId: string, opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+    }, ...args: any): Promise<ListUserBucketKeysApiResponse>;
+    /**
+     * List keys for the user
+     * List all keys identified by the external identifier of a user.
+     * @param { String } userExtId External identifier of a user.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - assignedTo<br>
+     * - creationType<br>
+     * - extId<br>
+     * - keyType<br>
+     * - lastUpdatedBy<br>
+     * - name<br>
+     * - status<br>
+     * - tenantId
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - assignedTo<br>
+     * - createdBy<br>
+     * - createdTime<br>
+     * - expiryTime<br>
+     * - keyType<br>
+     * - lastUpdatedTime<br>
+     * - lastUsedTime<br>
+     * - name<br>
+     * - status<br>
+     * - tenantId
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
+- assignedTo
+- createdBy
+- createdTime
+- creationType
+- description
+- expiryTime
+- extId
+- keyType
+- lastUpdatedBy
+- lastUpdatedTime
+- lastUsedTime
+- name
+- status
+- tenantId
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListUserKeysApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUserKeysApiResponse } and HTTP response
+     */
+    listUserKeys(userExtId: string, opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListUserKeysApiResponse>;
+    /**
+     * List user(s)
+     * Returns a list of all non-internal user(s) in the system.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - createdBy<br>
+     * - creationType<br>
+     * - displayName<br>
+     * - emailId<br>
+     * - extId<br>
+     * - firstName<br>
+     * - idpId<br>
+     * - lastName<br>
+     * - lastUpdatedBy<br>
+     * - status<br>
+     * - userType<br>
+     * - username
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - createdTime<br>
+     * - displayName<br>
+     * - emailId<br>
+     * - firstName<br>
+     * - lastLoginTime<br>
+     * - lastName<br>
+     * - lastUpdatedTime<br>
+     * - userType<br>
+     * - username
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
+- createdBy
+- createdTime
+- creationType
+- description
+- displayName
+- emailId
+- extId
+- firstName
+- idpId
+- isForceResetPasswordEnabled
+- lastLoginTime
+- lastName
+- lastUpdatedBy
+- lastUpdatedTime
+- locale
+- middleInitial
+- region
+- status
+- tenantId
+- userType
+- username
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListUsersApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUsersApiResponse } and HTTP response
+     */
+    listUsers(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListUsersApiResponse>;
+    /**
+     * Reset user password
+     * Reset user password based on the provided external identifier.
+     * @param { Required<Pick<PasswordResetRequest, 'newPassword'>> & Partial<PasswordResetRequest> } body specification
+     * @param { String } extId External identifier of a user.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ResetUserPasswordApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ResetUserPasswordApiResponse } and HTTP response
+     */
+    resetUserPassword(extId: string, body: Required<Pick<PasswordResetRequest, 'newPassword'>> & Partial<PasswordResetRequest>, ...args: any): Promise<ResetUserPasswordApiResponse>;
+    /**
+     * Revoke bucket access key of user
+     * Revokes the service account buckets access key based on the provided external identifier.
+     * @deprecated This API has been deprecated.
+     * @param { String } userExtId External identifier of a user.
+     * @param { String } extId External identifier for the bucket access key.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<RevokeUserBucketKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link RevokeUserBucketKeyApiResponse } and HTTP response
+     */
+    revokeUserBucketAccessKey(userExtId: string, extId: string, ...args: any): Promise<RevokeUserBucketKeyApiResponse>;
+    /**
+     * Revoke the requested key
+     * Revoke the requested key.
+     * @param { String } userExtId External identifier of a user.
+     * @param { String } extId External identifier of the key.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<RevokeUserKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link RevokeUserKeyApiResponse } and HTTP response
+     */
+    revokeUserKey(userExtId: string, extId: string, ...args: any): Promise<RevokeUserKeyApiResponse>;
+    /**
+     * Update user
+     * Updates a user based on the provided external identifier.
+     * @param { Partial<User> } body specification
+     * @param { String } extId External identifier of a user.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<UpdateUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateUserApiResponse } and HTTP response
+     */
+    updateUserById(extId: string, body: Partial<User>, ...args: any): Promise<UpdateUserApiResponse>;
+    /**
+     * Update active state of user
+     * Updates the active state of a user based on the provided external identifier.
+     * @param { Required<Pick<UserStateUpdate, 'status'>> & Partial<UserStateUpdate> } body specification
+     * @param { String } extId External identifier of a user.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ActivateUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ActivateUserApiResponse } and HTTP response
+     */
+    updateUserState(extId: string, body: Required<Pick<UserStateUpdate, 'status'>> & Partial<UserStateUpdate>, ...args: any): Promise<ActivateUserApiResponse>;
+    #private;
+}
+import PasswordChangeRequest from "../models/iam/v4/authn/PasswordChangeRequest";
+import ChangeUserPasswordApiResponse from "../models/iam/v4/authn/ChangeUserPasswordApiResponse";
+import BucketsAccessKey from "../models/iam/v4/authn/BucketsAccessKey";
+import CreateUserKeyApiResponse from "../models/iam/v4/authn/CreateUserKeyApiResponse";
+import User from "../models/iam/v4/authn/User";
+import CreateUserApiResponse from "../models/iam/v4/authn/CreateUserApiResponse";
+import Key from "../models/iam/v4/authn/Key";
+import CreateKeyApiResponse from "../models/iam/v4/authn/CreateKeyApiResponse";
+import DeleteUserKeyApiResponse from "../models/iam/v4/authn/DeleteUserKeyApiResponse";
+import GetUserBucketKeyApiResponse from "../models/iam/v4/authn/GetUserBucketKeyApiResponse";
+import GetUserApiResponse from "../models/iam/v4/authn/GetUserApiResponse";
+import GetUserKeyApiResponse from "../models/iam/v4/authn/GetUserKeyApiResponse";
+import ListUserBucketKeysApiResponse from "../models/iam/v4/authn/ListUserBucketKeysApiResponse";
+import ListUserKeysApiResponse from "../models/iam/v4/authn/ListUserKeysApiResponse";
+import ListUsersApiResponse from "../models/iam/v4/authn/ListUsersApiResponse";
+import PasswordResetRequest from "../models/iam/v4/authn/PasswordResetRequest";
+import ResetUserPasswordApiResponse from "../models/iam/v4/authn/ResetUserPasswordApiResponse";
+import RevokeUserBucketKeyApiResponse from "../models/iam/v4/authn/RevokeUserBucketKeyApiResponse";
+import RevokeUserKeyApiResponse from "../models/iam/v4/authn/RevokeUserKeyApiResponse";
+import UpdateUserApiResponse from "../models/iam/v4/authn/UpdateUserApiResponse";
+import UserStateUpdate from "../models/iam/v4/authn/UserStateUpdate";
+import ActivateUserApiResponse from "../models/iam/v4/authn/ActivateUserApiResponse";
+import { ApiClient } from "../ApiClient";