Search Groups

Search groups with a query. The query performs a starts with match against the name value of the groups. You can either display the first record that matches or a list of all of the matching records (up to 300). See Search Groups for more information on searching groups.

Unless otherwise indicated, field types are text.

Options

  • Option (drop-down list)

    • First Matching Record: Returns the first record that matches.

    • All Matching Records: Returns all matching records as a list.

Input

  • Query: The query string used to find groups by name. For example, to search for groups related to sales, enter a query value of sales.

Output

  • Result

    • First Matching Record:

      • Raw Body (object): The raw payload returned from the Okta API.

      • ID: The ID of the group in Okta.

      • Created (date): The timestamp when the group was created.

      • Last Updated (date): The timestamp of the last group update.

      • Last Membership Updated: The timestamp of the last update to the group's membership.

      • Object Class (list of text): The determiner of the group's profile.

      • Type: How the group's profile and memberships are managed; this is one of: OKTA_GROUP, APP_GROUP, or BUILT_IN.

      • Profile (object)

        • Name: The name of the group.

        • Description: The description of the group.

    • All Matching Records:

      • Groups (list of objects): A list of all matching groups with a payload similar to above.

See also