latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Groups

List groups

Lists all available groups.

get/groups

Query parameters

namestring

The name of the group.

mappingstring

The group mapping which can contain provider or identity.

createdOnstring date

The created date of the group.

lastModifiedOnstring date

The last modified date of the group.

sortFieldstring

Sort field options available for groups. Possible values are: NAME, CREATED_ON or LAST_MODIFIED_ON.

A field to sort the groups.

sortOrderstring

Order on the sort field options available for groups. Possible values are: ASC or DESC.

Sorting order to be applied on the sort field.

limitinteger

This is the maximum number of results that may be returned. Fewer may be returned than the value of <code>limit</code>.

Do not depend on the number of results being fewer than the <code>limit</code> value to indicate that your query reached the end of the list of data, use the absence of <code>after</code> (see Cursors) instead. For example, if you set <code>limit</code> to 10 and 9 results are returned, there may be more data available.

If not set, the default limit (limit = <code>25</code>) will be used. The maximum value for this parameter is <code>500</code>.

afterstring nullable

This is the cursor that points to the end of the page of data that has been returned.

Response

The list of groups.