List all Groups
GET {{baseUrl}}/api/v1/groups
Lists all groups with pagination support. A subset of groups can be returned that match a supported filter expression or query.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
q | string | Searches the name property of groups for matching value | |
filter | string | Filter expression for groups | |
after | string | Specifies the pagination cursor for the next page of groups | |
limit | number | Specifies the number of group results in a page | |
expand | string | If specified, it causes additional metadata to be included in the response. | |
search | string | Searches for groups with a supported filtering expression for all attributes except for _embedded, _links, and objectClass | |
sortBy | string | Specifies field to sort by and can be any single property (for search queries only). | |
sortOrder | string | Specifies sort order asc or desc (for search queries only). This parameter is ignored if sortBy is not present. | |
Groups with the same value for the sortBy parameter are ordered by id . |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"created":"1948-05-17T05:29:56.892Z","id":"sint minim qui voluptate do","lastMembershipUpdated":"1996-05-30T10:45:38.232Z","lastUpdated":"1995-02-06T21:29:33.866Z","objectClass":["laborum laboris","commodo culpa sunt pariatur mollit"],"profile":{"description":"ut et","name":"exercitation ad"},"type":"OKTA_GROUP","_embedded":{"incididunt_c8":{},"cupidatat_0":{}},"_links":{"apps":{"href":"mollit","hints":{"allow":["POST","GET"]},"name":"magna","type":"aliqua eiusmod quis"},"logo":[{"href":"cupidatat fugiat minim labore consequat","hints":{"allow":["POST","GET"]},"name":"sit laboris consectetur commodo dolore","type":"laboris ad et"},{"href":"est in culpa","hints":{"allow":["GET","POST"]},"name":"magna nisi velit aliquip ullamco","type":"do qui"}],"self":{"href":"laboris qui","hints":{"allow":["PUT","GET"]},"name":"est aliqua nisi ad","type":"ex mollit sit"},"source":{"href":"consequat in","hints":{"allow":["DELETE","POST"]},"name":"ut sint cupidatat","type":"aliquip dolore amet commodo"},"users":{"href":"exercitation reprehenderit mollit ipsum","hints":{"allow":["GET","DELETE"]},"name":"fugiat laborum do aliqua","type":"aliquip veniam in"}}},{"created":"1985-05-26T12:40:37.980Z","id":"voluptate eiusmod","lastMembershipUpdated":"1969-06-03T01:54:10.008Z","lastUpdated":"1981-08-04T10:55:41.991Z","objectClass":["labore reprehenderit elit laborum","eu cupidatat dolor laboris"],"profile":{"description":"in veniam","name":"mollit eiusmod ullamco tempor"},"type":"OKTA_GROUP","_embedded":{"sint_8_7":{},"sedc7":{},"Duisd07":{}},"_links":{"apps":{"href":"deserunt nostrud","hints":{"allow":["DELETE","GET"]},"name":"adipisicing enim","type":"nisi aute Ut quis"},"logo":[{"href":"cupidatat","hints":{"allow":["GET","POST"]},"name":"irure sunt","type":"quis anim"},{"href":"non Lorem et sunt","hints":{"allow":["DELETE","PUT"]},"name":"deserunt ullamco cupidatat","type":"proident ut sit"}],"self":{"href":"ad","hints":{"allow":["DELETE","GET"]},"name":"exercitation","type":"consectetur veniam"},"source":{"href":"occaecat officia ad","hints":{"allow":["PUT","POST"]},"name":"ex","type":"Excepteur adipisicing "},"users":{"href":"Ut dolor adipisicing labore","hints":{"allow":["DELETE","DELETE"]},"name":"ea","type":"dolor minim ullamco ea"}}}]