List Groups
Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.
External Documentation
To learn more, visit the Okta documentation.
Basic Parameters
Parameter | Description |
---|---|
Query | Searches the name property of groups for matching value. |
Return All Pages | Automatically fetch all resources, page by page. |
Advanced Parameters
Parameter | Description |
---|---|
Expand | Adds extra metadata to the response if provided. Possible values are stats and/or app. |
Limit | Specifies the number of group results in a page. If you don't specify a value for limit and don't specify a query, only 200 results are returned for most orgs. If you don't specify any value for limit and do specify a query, a maximum of 10 results are returned. |
Search | Filter expression for groups based on the SCIM protocol specification. For more information visit https://developer.okta.com/docs/reference/core-okta-api/#filter. For example: type eq "APP_GROUP" or lastUpdated gt "yyyy-MM-dd'T'HH:mm:ss.SSSZ" |
Example Output
[
{
"id": "00g1emaKYZTWRYYRRTSK",
"created": "2015-02-06T10:11:28.000Z",
"lastUpdated": "2015-10-05T19:16:43.000Z",
"lastMembershipUpdated": "2015-11-28T19:15:32.000Z",
"objectClass": [
"okta:user_group"
],
"type": "OKTA_GROUP",
"profile": {
"name": "West Coast Users",
"description": "All Users West of The Rockies"
},
"_links": {
"logo": [
{
"name": "medium",
"href": "https://{yourOktaDomain}/img/logos/groups/okta-medium.png",
"type": "image/png"
},
{
"name": "large",
"href": "https://{yourOktaDomain}/img/logos/groups/okta-large.png",
"type": "image/png"
}
],
"users": {
"href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/users"
},
"apps": {
"href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK/apps"
}
}
},
{
"id": "00garwpuyxHaWOkdV0g4",
"created": "2015-08-15T19:15:17.000Z",
"lastUpdated": "2015-11-18T04:02:19.000Z",
"lastMembershipUpdated": "2015-08-15T19:15:17.000Z",
"objectClass": [
"okta:windows_security_principal"
],
"type": "APP_GROUP",
"profile": {
"name": "Engineering Users",
"description": "corp.example.com/Engineering/Engineering Users",
"groupType": "Security",
"samAccountName": "Engineering Users",
"objectSid": "S-1-5-21-717838489-685202119-709183397-1177",
"groupScope": "Global",
"dn": "CN=Engineering Users,OU=Engineering,DC=corp,DC=example,DC=com",
"windowsDomainQualifiedName": "CORP\\Engineering Users",
"externalId": "OZJdWdONCU6h7WjQKp+LPA=="
},
"source": {
"id": "0oa2v0el0gP90aqjJ0g7"
},
"_links": {
"logo": [
{
"name": "medium",
"href": "https://{yourOktaDomain}/img/logos/groups/active_directory-medium.png",
"type": "image/png"
},
{
"name": "large",
"href": "https://{yourOktaDomain}/img/logos/groups/active_directory-large.png",
"type": "image/png"
}
],
"source": {
"href": "https://{yourOktaDomain}/api/v1/apps/0oa2v0el0gP90aqjJ0g7"
},
"users": {
"href": "https://{yourOktaDomain}/api/v1/groups/00garwpuyxHaWOkdV0g4/users"
},
"apps": {
"href": "https://{yourOktaDomain}/api/v1/groups/00garwpuyxHaWOkdV0g4/apps"
}
}
}
]
Workflow Library Example
Temporarily Add User to Group with Okta