@pulumi/okta 4.9.0-alpha.1718431198 → 4.9.0

package/user/getUser.d.ts

@@ -2,7 +2,7 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "../types/input";
 import * as outputs from "../types/output";
 /**
- * Use this data source to retrieve a users from Okta.
+ * Get a single users from Okta.
  */
 export declare function getUser(args?: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>;
 /**
@@ -10,7 +10,7 @@ export declare function getUser(args?: GetUserArgs, opts?: pulumi.InvokeOptions)
  */
 export interface GetUserArgs {
     /**
-     * Given multiple search elements they will be compounded together with the op. Default is `and`, `or` is also valid.
+     * Search operator used when joining multiple search clauses
      */
     compoundSearchOperator?: string;
     /**
@@ -18,13 +18,19 @@ export interface GetUserArgs {
      */
     delayReadSeconds?: string;
     /**
-     * Map of search criteria. It supports the following properties.
+     * Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present
      */
     searches?: inputs.user.GetUserSearch[];
+    /**
+     * Do not populate user groups information (prevents additional API call)
+     */
     skipGroups?: boolean;
+    /**
+     * Do not populate user roles information (prevents additional API call)
+     */
     skipRoles?: boolean;
     /**
-     * String representing a specific user's id value
+     * Retrieve a single user based on their id
      */
     userId?: string;
 }
@@ -33,156 +39,72 @@ export interface GetUserArgs {
  */
 export interface GetUserResult {
     readonly adminRoles: string[];
-    /**
-     * City or locality component of user's address.
-     */
     readonly city: string;
-    readonly compoundSearchOperator?: string;
     /**
-     * Name of a cost center assigned to user.
+     * Search operator used when joining multiple search clauses
      */
+    readonly compoundSearchOperator?: string;
     readonly costCenter: string;
-    /**
-     * Country name component of user's address.
-     */
     readonly countryCode: string;
-    /**
-     * Raw JSON containing all custom profile attributes.
-     */
     readonly customProfileAttributes: string;
-    readonly delayReadSeconds?: string;
     /**
-     * Name of user's department.
+     * Force delay of the user read by N seconds. Useful when eventual consistency of user information needs to be allowed for.
      */
+    readonly delayReadSeconds?: string;
     readonly department: string;
-    /**
-     * Name of the user, suitable for display to end users.
-     */
     readonly displayName: string;
-    /**
-     * Name of user's division.
-     */
     readonly division: string;
-    /**
-     * Primary email address of user.
-     */
     readonly email: string;
-    /**
-     * Organization or company assigned unique identifier for the user.
-     */
     readonly employeeNumber: string;
-    /**
-     * Given name of the user.
-     */
     readonly firstName: string;
     readonly groupMemberships: string[];
-    /**
-     * Honorific prefix(es) of the user, or title in most Western languages.
-     */
     readonly honorificPrefix: string;
-    /**
-     * Honorific suffix(es) of the user.
-     */
     readonly honorificSuffix: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
-    /**
-     * Family name of the user.
-     */
     readonly lastName: string;
-    /**
-     * User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.
-     */
     readonly locale: string;
-    /**
-     * Unique identifier for the user.
-     */
     readonly login: string;
-    /**
-     * Display name of the user's manager.
-     */
     readonly manager: string;
-    /**
-     * `id` of a user's manager.
-     */
     readonly managerId: string;
-    /**
-     * Middle name(s) of the user.
-     */
     readonly middleName: string;
-    /**
-     * Mobile phone number of user.
-     */
     readonly mobilePhone: string;
-    /**
-     * Casual way to address the user in real life.
-     */
     readonly nickName: string;
-    /**
-     * Name of user's organization.
-     */
     readonly organization: string;
-    /**
-     * Mailing address component of user's address.
-     */
     readonly postalAddress: string;
-    /**
-     * User's preferred written or spoken languages.
-     */
     readonly preferredLanguage: string;
-    /**
-     * Primary phone number of user such as home number.
-     */
     readonly primaryPhone: string;
-    /**
-     * URL of user's online profile (e.g. a web page).
-     */
     readonly profileUrl: string;
+    readonly roles: string[];
     /**
-     * All roles assigned to user.
+     * Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present
      */
-    readonly roles: string[];
     readonly searches?: outputs.user.GetUserSearch[];
+    readonly secondEmail: string;
     /**
-     * Secondary email address of user typically used for account recovery.
+     * Do not populate user groups information (prevents additional API call)
      */
-    readonly secondEmail: string;
     readonly skipGroups?: boolean;
-    readonly skipRoles?: boolean;
     /**
-     * State or region component of user's address (region).
+     * Do not populate user roles information (prevents additional API call)
      */
+    readonly skipRoles?: boolean;
     readonly state: string;
-    /**
-     * Current status of user.
-     */
     readonly status: string;
-    /**
-     * Full street address component of user's address.
-     */
     readonly streetAddress: string;
-    /**
-     * User's time zone.
-     */
     readonly timezone: string;
-    /**
-     * User's title, such as "Vice President".
-     */
     readonly title: string;
-    readonly userId?: string;
     /**
-     * Used to describe the organization to user relationship such as "Employee" or "Contractor".
+     * Retrieve a single user based on their id
      */
+    readonly userId?: string;
     readonly userType: string;
-    /**
-     * Zipcode or postal code component of user's address (postalCode)
-     */
     readonly zipCode: string;
 }
 /**
- * Use this data source to retrieve a users from Okta.
+ * Get a single users from Okta.
  */
 export declare function getUserOutput(args?: GetUserOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetUserResult>;
 /**
@@ -190,7 +112,7 @@ export declare function getUserOutput(args?: GetUserOutputArgs, opts?: pulumi.In
  */
 export interface GetUserOutputArgs {
     /**
-     * Given multiple search elements they will be compounded together with the op. Default is `and`, `or` is also valid.
+     * Search operator used when joining multiple search clauses
      */
     compoundSearchOperator?: pulumi.Input<string>;
     /**
@@ -198,13 +120,19 @@ export interface GetUserOutputArgs {
      */
     delayReadSeconds?: pulumi.Input<string>;
     /**
-     * Map of search criteria. It supports the following properties.
+     * Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present
      */
     searches?: pulumi.Input<pulumi.Input<inputs.user.GetUserSearchArgs>[]>;
+    /**
+     * Do not populate user groups information (prevents additional API call)
+     */
     skipGroups?: pulumi.Input<boolean>;
+    /**
+     * Do not populate user roles information (prevents additional API call)
+     */
     skipRoles?: pulumi.Input<boolean>;
     /**
-     * String representing a specific user's id value
+     * Retrieve a single user based on their id
      */
     userId?: pulumi.Input<string>;
 }

package/user/getUser.js

@@ -6,7 +6,7 @@ exports.getUserOutput = exports.getUser = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Use this data source to retrieve a users from Okta.
+ * Get a single users from Okta.
  */
 function getUser(args, opts) {
     args = args || {};
@@ -22,7 +22,7 @@ function getUser(args, opts) {
 }
 exports.getUser = getUser;
 /**
- * Use this data source to retrieve a users from Okta.
+ * Get a single users from Okta.
  */
 function getUserOutput(args, opts) {
     return pulumi.output(args).apply((a) => getUser(a, opts));

package/user/getUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"getUser.js","sourceRoot":"","sources":["../../user/getUser.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,0CAA0C;AAE1C;;GAEG;AACH,SAAgB,OAAO,CAAC,IAAkB,EAAE,IAA2B;IACnE,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,2BAA2B,EAAE;QACtD,wBAAwB,EAAE,IAAI,CAAC,sBAAsB;QACrD,kBAAkB,EAAE,IAAI,CAAC,gBAAgB;QACzC,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAZD,0BAYC;AAmLD;;GAEG;AACH,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAClE,CAAC;AAFD,sCAEC"}
+{"version":3,"file":"getUser.js","sourceRoot":"","sources":["../../user/getUser.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,0CAA0C;AAE1C;;GAEG;AACH,SAAgB,OAAO,CAAC,IAAkB,EAAE,IAA2B;IACnE,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,2BAA2B,EAAE;QACtD,wBAAwB,EAAE,IAAI,CAAC,sBAAsB;QACrD,kBAAkB,EAAE,IAAI,CAAC,gBAAgB;QACzC,UAAU,EAAE,IAAI,CAAC,QAAQ;QACzB,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAZD,0BAYC;AAqGD;;GAEG;AACH,SAAgB,aAAa,CAAC,IAAwB,EAAE,IAA2B;IAC/E,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAClE,CAAC;AAFD,sCAEC"}

package/user/getUserProfileMappingSource.d.ts

@@ -1,8 +1,9 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Use this data source to retrieve the base user Profile Mapping source or target from Okta.
+ * Get the base user Profile Mapping source or target from Okta.
  *
- * > **NOTE:** If using this resource with OAuth2 scopes, this resource requires `okta.profileMappings.read` scope.
+ * > **NOTE:** If using this resource with OAuth2 scopes, this resource
+ * requires `okta.profileMappings.read` scope.
  *
  * ## Example Usage
  *
@@ -19,22 +20,23 @@ export declare function getUserProfileMappingSource(opts?: pulumi.InvokeOptions)
  */
 export interface GetUserProfileMappingSourceResult {
     /**
-     * id of the source.
+     * ID of the source
      */
     readonly id: string;
     /**
-     * name of source.
+     * Name of source.
      */
     readonly name: string;
     /**
-     * type of source.
+     * Type of source.
      */
     readonly type: string;
 }
 /**
- * Use this data source to retrieve the base user Profile Mapping source or target from Okta.
+ * Get the base user Profile Mapping source or target from Okta.
  *
- * > **NOTE:** If using this resource with OAuth2 scopes, this resource requires `okta.profileMappings.read` scope.
+ * > **NOTE:** If using this resource with OAuth2 scopes, this resource
+ * requires `okta.profileMappings.read` scope.
  *
  * ## Example Usage
  *

package/user/getUserProfileMappingSource.js

@@ -6,9 +6,10 @@ exports.getUserProfileMappingSourceOutput = exports.getUserProfileMappingSource
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Use this data source to retrieve the base user Profile Mapping source or target from Okta.
+ * Get the base user Profile Mapping source or target from Okta.
  *
- * > **NOTE:** If using this resource with OAuth2 scopes, this resource requires `okta.profileMappings.read` scope.
+ * > **NOTE:** If using this resource with OAuth2 scopes, this resource
+ * requires `okta.profileMappings.read` scope.
  *
  * ## Example Usage
  *
@@ -25,9 +26,10 @@ function getUserProfileMappingSource(opts) {
 }
 exports.getUserProfileMappingSource = getUserProfileMappingSource;
 /**
- * Use this data source to retrieve the base user Profile Mapping source or target from Okta.
+ * Get the base user Profile Mapping source or target from Okta.
  *
- * > **NOTE:** If using this resource with OAuth2 scopes, this resource requires `okta.profileMappings.read` scope.
+ * > **NOTE:** If using this resource with OAuth2 scopes, this resource
+ * requires `okta.profileMappings.read` scope.
  *
  * ## Example Usage
  *

package/user/getUserProfileMappingSource.js.map

@@ -1 +1 @@
-{"version":3,"file":"getUserProfileMappingSource.js","sourceRoot":"","sources":["../../user/getUserProfileMappingSource.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;GAaG;AACH,SAAgB,2BAA2B,CAAC,IAA2B;IAEnE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,mEAAmE,EAAE,EACjG,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,kEAKC;AAmBD;;;;;;;;;;;;;GAaG;AACH,SAAgB,iCAAiC,CAAC,IAA2B;IACzE,OAAO,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3D,CAAC;AAFD,8EAEC"}
+{"version":3,"file":"getUserProfileMappingSource.js","sourceRoot":"","sources":["../../user/getUserProfileMappingSource.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;;;;;;;;;;;;;GAcG;AACH,SAAgB,2BAA2B,CAAC,IAA2B;IAEnE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,mEAAmE,EAAE,EACjG,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,kEAKC;AAmBD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,iCAAiC,CAAC,IAA2B;IACzE,OAAO,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3D,CAAC;AAFD,8EAEC"}

package/user/getUserType.d.ts

@@ -1,6 +1,6 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Use this data source to retrieve a user type from Okta.
+ * Get a user type from Okta.
  *
  * ## Example Usage
  *
@@ -19,7 +19,7 @@ export declare function getUserType(args: GetUserTypeArgs, opts?: pulumi.InvokeO
  */
 export interface GetUserTypeArgs {
     /**
-     * name of user type to retrieve.
+     * Name of user type to retrieve.
      */
     name: string;
 }
@@ -28,11 +28,11 @@ export interface GetUserTypeArgs {
  */
 export interface GetUserTypeResult {
     /**
-     * description of user type.
+     * Description of user type.
      */
     readonly description: string;
     /**
-     * display name of user type.
+     * Display name of user type.
      */
     readonly displayName: string;
     /**
@@ -40,12 +40,12 @@ export interface GetUserTypeResult {
      */
     readonly id: string;
     /**
-     * name of user type.
+     * Name of user type to retrieve.
      */
     readonly name: string;
 }
 /**
- * Use this data source to retrieve a user type from Okta.
+ * Get a user type from Okta.
  *
  * ## Example Usage
  *
@@ -64,7 +64,7 @@ export declare function getUserTypeOutput(args: GetUserTypeOutputArgs, opts?: pu
  */
 export interface GetUserTypeOutputArgs {
     /**
-     * name of user type to retrieve.
+     * Name of user type to retrieve.
      */
     name: pulumi.Input<string>;
 }

package/user/getUserType.js

@@ -6,7 +6,7 @@ exports.getUserTypeOutput = exports.getUserType = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Use this data source to retrieve a user type from Okta.
+ * Get a user type from Okta.
  *
  * ## Example Usage
  *
@@ -27,7 +27,7 @@ function getUserType(args, opts) {
 }
 exports.getUserType = getUserType;
 /**
- * Use this data source to retrieve a user type from Okta.
+ * Get a user type from Okta.
  *
  * ## Example Usage
  *

package/user/getUsers.d.ts

@@ -2,22 +2,42 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "../types/input";
 import * as outputs from "../types/output";
 /**
- * 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
+ * }
  */
 export declare function getUsers(args?: GetUsersArgs, opts?: pulumi.InvokeOptions): Promise<GetUsersResult>;
 /**
@@ -25,27 +45,27 @@ export declare function getUsers(args?: GetUsersArgs, opts?: pulumi.InvokeOption
  */
 export interface GetUsersArgs {
     /**
-     * Given multiple search elements they will be compounded together with the op. Default is `and`, `or` is also valid.
+     * Search operator used when joining multiple search clauses
      */
     compoundSearchOperator?: string;
     /**
-     * Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for; for instance, when administrator roles are known to have been applied.
+     * Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
      */
     delayReadSeconds?: string;
     /**
-     * Id of group used to find users based on membership.
+     * Find users based on group membership using the id of the group.
      */
     groupId?: string;
     /**
-     * Fetch each user's group memberships. Defaults to `false`, in which case the `groupMemberships` user attribute will be empty.
+     * Fetch group memberships for each user
      */
     includeGroups?: boolean;
     /**
-     * Fetch each user's administrator roles. Defaults to `false`, in which case the `adminRoles` user attribute will be empty.
+     * Fetch user roles for each user
      */
     includeRoles?: boolean;
     /**
-     * Map of search criteria. It supports the following properties.
+     * Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present
      */
     searches?: inputs.user.GetUsersSearch[];
 }
@@ -53,38 +73,76 @@ export interface GetUsersArgs {
  * A collection of values returned by getUsers.
  */
 export interface GetUsersResult {
+    /**
+     * Search operator used when joining multiple search clauses
+     */
     readonly compoundSearchOperator?: string;
+    /**
+     * Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
+     */
     readonly delayReadSeconds?: string;
+    /**
+     * Find users based on group membership using the id of the group.
+     */
     readonly groupId?: string;
     /**
      * The provider-assigned unique ID for this managed resource.
      */
     readonly id: string;
+    /**
+     * Fetch group memberships for each user
+     */
     readonly includeGroups?: boolean;
+    /**
+     * Fetch user roles for each user
+     */
     readonly includeRoles?: boolean;
+    /**
+     * Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present
+     */
     readonly searches?: outputs.user.GetUsersSearch[];
     /**
-     * collection of users retrieved from Okta with the following properties.
+     * collection of users retrieved from Okta.
      */
     readonly users: outputs.user.GetUsersUser[];
 }
 /**
- * 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
+ * }
  */
 export declare function getUsersOutput(args?: GetUsersOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetUsersResult>;
 /**
@@ -92,27 +150,27 @@ export declare function getUsersOutput(args?: GetUsersOutputArgs, opts?: pulumi.
  */
 export interface GetUsersOutputArgs {
     /**
-     * Given multiple search elements they will be compounded together with the op. Default is `and`, `or` is also valid.
+     * Search operator used when joining multiple search clauses
      */
     compoundSearchOperator?: pulumi.Input<string>;
     /**
-     * Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for; for instance, when administrator roles are known to have been applied.
+     * Force delay of the users read by N seconds. Useful when eventual consistency of users information needs to be allowed for.
      */
     delayReadSeconds?: pulumi.Input<string>;
     /**
-     * Id of group used to find users based on membership.
+     * Find users based on group membership using the id of the group.
      */
     groupId?: pulumi.Input<string>;
     /**
-     * Fetch each user's group memberships. Defaults to `false`, in which case the `groupMemberships` user attribute will be empty.
+     * Fetch group memberships for each user
      */
     includeGroups?: pulumi.Input<boolean>;
     /**
-     * Fetch each user's administrator roles. Defaults to `false`, in which case the `adminRoles` user attribute will be empty.
+     * Fetch user roles for each user
      */
     includeRoles?: pulumi.Input<boolean>;
     /**
-     * Map of search criteria. It supports the following properties.
+     * Filter to find user/users. Each filter will be concatenated with the compound search operator. Please be aware profile properties must match what is in Okta, which is likely camel case. Expression is a free form expression filter https://developer.okta.com/docs/reference/core-okta-api/#filter . The set name/value/comparison properties will be ignored if expression is present
      */
     searches?: pulumi.Input<pulumi.Input<inputs.user.GetUsersSearchArgs>[]>;
 }