Use Okta Expression Language for Group Output
Last Updated:
Overview
Administrators require a reference for the existing functions used to manipulate groups in the Okta Expression Language (OEL). Review the available functions and their syntax to configure group outputs correctly.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- Okta Expression Language (OEL)
- Groups
Solution
What are the available Okta Expression Language functions for group manipulation?
Review the following table to identify the available functions, return types, and syntax examples for performing group manipulation within the Okta Expression Language.
|
getFilteredGroups |
Array |
getFilteredGroups({"00gml2xHE3RYRx7cM0g3"}, "group.name", 40) |
|---|---|---|
|
Groups.contains |
Array |
contains(app_type/app_instance_id, pattern, limit) |
|
Groups.startsWith |
Array |
startsWith(app_type/app_instance_id, pattern, limit) |
|
Groups.endsWith |
Array |
endsWith(app_type/app_instance_id, pattern, limit) |
|
isMemberOfGroupName |
Boolean |
isMemberOfGroupName("group1") |
|
isMemberOfGroup |
Boolean |
isMemberOfGroup("groupId") |
|
isMemberOfAnyGroup |
Boolean |
isMemberOfAnyGroup("groupId1", "groupId2", "groupId3") |
|
isMemberOfGroupNameStartsWith |
Boolean |
isMemberOfGroupNameStartsWith("San Fr") |
|
isMemberOfGroupNameContains |
Boolean |
isMemberOfGroupNameContains("admin") |
|
isMemberOfGroupNameRegex |
Boolean |
isMemberOfGroupNameRegex("/.*admin.*") |
NOTE: The isMemberOfGroupName, isMemberOfGroup, isMemberOfAnyGroup, isMemberOfGroupNameStartsWith, isMemberOfGroupNameContains, and isMemberOfGroupNameRegex group functions retrieve only an Okta user's group memberships. Do not use them to retrieve an app user's group memberships.
