Export Okta Users Based on Specific Attributes Using the Rockstar Browser Extension
Last Updated:
Overview
Administrators can export a report of Okta users based on specific attributes by leveraging the Rockstar browser extension. The Rockstar browser extension creates an overlay on the Okta dashboard that provides options for pre-programmed Application Programming Interface (API) calls and allows customized API calls via the API Explorer. Review the Rockstar browser extension interface on the Okta dashboard.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- Rockstar
- Users
- Attributes
- Universal Directory
- Application Programming Interface (API)
Solution
How are Okta users exported based on specific attributes using the Rockstar browser extension?
Export Okta users based on specific attributes by navigating to the Okta directory, launching the Rockstar export tool, and entering a formatted search query.
- Navigate to Directory > People in the Okta Admin Console while the Rockstar browser extension is loaded.
- Select Export Users on the Rockstar user interface.
- Enter a search query in the provided window.
NOTE: If the export runs with a blank search query, Okta downloads all users whose status is not deactivated. - Focus the search query on the
userNamevariable under the Profile section.
Review the supported attribute operators for Rockstar search queries.
Format search queries using the following attribute operators to filter the exported user data accurately.
| Operator | Description | Behavior |
|---|---|---|
and | Logical AND | The filter matches only if both expressions evaluate to true. |
not | Logical NOT | The filter matches if the expression evaluates to false. |
or | Logical OR | The filter matches if either expression evaluates to true. |
eq | equal | The attribute and operand values must match identically. |
ge | greater than or equal | The filter matches if the attribute value is greater than or equal to the operand value. The actual comparison depends on the attribute type. String attribute types use a lexicographical comparison and Date types use a chronological comparison. |
gt | greater than | The filter matches if the attribute value is greater than the operand value. The actual comparison depends on the attribute type. String attribute types use a lexicographical comparison and Date types use a chronological comparison. |
le | less than or equal | The filter matches if the attribute value is less than or equal to the operand value. The actual comparison depends on the attribute type. String attribute types use a lexicographical comparison and Date types use a chronological comparison. |
lt | less than | The filter matches if the attribute value is less than the operand value. The actual comparison depends on the attribute type. String attribute types use a lexicographical comparison and Date types use a chronological comparison. |
pr | present (has value) | The filter matches if the attribute contains a non-empty value or a non-empty node for complex attributes. |
sw | starts with | The entire operand value must form a substring starting at the beginning of the attribute value. The filter matches if the two strings are identical. |
NOTE:The ne (not equal) operator is not supported; however, to obtain the same result use lt ... or ... gt. For example, to search for users whose first name is not "testuser", use (search=profile.firstName lt "testuser" or profile.firstName gt "testuser").
What are some examples of Rockstar search queries?
Review the following query examples to understand how to format searches for specific user attributes and operators.
- Search by user ID:
search=id eq "<user_id>"- Search by Okta user type ID:
search=type.id eq "<type_id>"NOTE: The ID refers to the Okta user type (Okta user profile). View this profile by appending {{org_url}}//admin/universaldirectory#okta/{{type.id}} to the Okta URL.
- Search by first name:
search=profile.firstName eq "Test"- Search for users with a specific subdomain:
search=profile.login co "@example.com"- Search using the
andoperator:
search=profile.firstName eq "Test" and profile.email sw "test"NOTE: The Rockstar extension appears in the top left corner of the Okta Admin Console. This extension is an unofficial tool created and supported by the community, not Okta. If the extension does not work correctly, Okta Support cannot provide troubleshooting. Access the JavaScript source on GitHub to open an issue or a pull request.
