This article lists the existing functions for performing group manipulation within the Okta Expression Language.
- Okta Expression Language (OEL)
- Groups
The following chart describes the functions that exist 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, isMemberOfGroupNameRegex group functions are designed to retrieve only an Okta user's group memberships. Do not use them to retrieve an app user's group memberships.
