@pulumi/okta 4.9.0-alpha.1718344922 → 4.9.0-alpha.1718755579

package/user/getUsers.js

@@ -6,22 +6,42 @@ exports.getUsersOutput = exports.getUsers = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Use this data source to retrieve a list of users from Okta.
+ * Get a list of users from Okta.
  *
  * ## Example Usage
  *
+ * ### Lookup Users by Search Criteria
+ *
+ * data "okta.user.getUsers" "example" {
+ *   search {
+ *     name       = "profile.company"
+ *     value      = "Articulate"
+ *     comparison = "sw"
+ *   }
+ * }
+ *
+ * # Search for multiple users based on a raw search expression string
+ * data "okta.user.getUsers" "example" {
+ *   search {
+ *     expression = "profile.department eq \"Engineering\" and (created lt \"2014-01-01T00:00:00.000Z\" or status eq \"ACTIVE\")"
+ *   }
+ * }
+ *
  * ### Lookup Users by Group Membership
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as okta from "@pulumi/okta";
- *
- * const exampleGroup = new okta.group.Group("example", {name: "example-group"});
- * const example = okta.user.getUsersOutput({
- *     groupId: exampleGroup.id,
- *     includeGroups: true,
- *     includeRoles: true,
- * });
- * ```
+ *
+ * resource "okta.group.Group" "example" {
+ *   name = "example-group"
+ * }
+ *
+ * data "okta.user.getUsers" "example" {
+ *   groupId = okta_group.example.id
+ *
+ * # optionally include each user's group membership
+ *   includeGroups = true
+ *
+ * # optionally include each user's administrator roles
+ *   includeRoles = true
+ * }
  */
 function getUsers(args, opts) {
     args = args || {};
@@ -37,22 +57,42 @@ function getUsers(args, opts) {
 }
 exports.getUsers = getUsers;
 /**
- * Use this data source to retrieve a list of users from Okta.
+ * Get a list of users from Okta.
  *
  * ## Example Usage
  *
+ * ### Lookup Users by Search Criteria
+ *
+ * data "okta.user.getUsers" "example" {
+ *   search {
+ *     name       = "profile.company"
+ *     value      = "Articulate"
+ *     comparison = "sw"
+ *   }
+ * }
+ *
+ * # Search for multiple users based on a raw search expression string
+ * data "okta.user.getUsers" "example" {
+ *   search {
+ *     expression = "profile.department eq \"Engineering\" and (created lt \"2014-01-01T00:00:00.000Z\" or status eq \"ACTIVE\")"
+ *   }
+ * }
+ *
  * ### Lookup Users by Group Membership
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as okta from "@pulumi/okta";
- *
- * const exampleGroup = new okta.group.Group("example", {name: "example-group"});
- * const example = okta.user.getUsersOutput({
- *     groupId: exampleGroup.id,
- *     includeGroups: true,
- *     includeRoles: true,
- * });
- * ```
+ *
+ * resource "okta.group.Group" "example" {
+ *   name = "example-group"
+ * }
+ *
+ * data "okta.user.getUsers" "example" {
+ *   groupId = okta_group.example.id
+ *
+ * # optionally include each user's group membership
+ *   includeGroups = true
+ *
+ * # optionally include each user's administrator roles
+ *   includeRoles = true
+ * }
  */
 function getUsersOutput(args, opts) {
     return pulumi.output(args).apply((a) => getUsers(a, opts));

package/user/getUsers.js.map

@@ -1 +1 @@
-{"version":3,"file":"getUsers.js","sourceRoot":"","sources":["../../user/getUsers.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,QAAQ,CAAC,IAAmB,EAAE,IAA2B;IACrE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAElB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,EAAE;QACxD,wBAAwB,EAAE,IAAI,CAAC,sBAAsB;QACrD,kBAAkB,EAAE,IAAI,CAAC,gBAAgB;QACzC,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,cAAc,EAAE,IAAI,CAAC,YAAY;QACjC,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAZD,4BAYC;AAmDD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,cAAc,CAAC,IAAyB,EAAE,IAA2B;IACjF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACnE,CAAC;AAFD,wCAEC"}
+{"version":3,"file":"getUsers.js","sourceRoot":"","sources":["../../user/getUsers.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,0CAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,QAAQ,CAAC,IAAmB,EAAE,IAA2B;IACrE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAElB,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,EAAE;QACxD,wBAAwB,EAAE,IAAI,CAAC,sBAAsB;QACrD,kBAAkB,EAAE,IAAI,CAAC,gBAAgB;QACzC,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,cAAc,EAAE,IAAI,CAAC,YAAY;QACjC,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAZD,4BAYC;AAqED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,cAAc,CAAC,IAAyB,EAAE,IAA2B;IACjF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACnE,CAAC;AAFD,wCAEC"}