GetGroupsResult

data class GetGroupsResult(val groups: List<GetGroupsGroup>, val id: String, val orderBy: String? = null, val search: String? = null, val sort: String? = null, val topLevelOnly: Boolean? = null)

A collection of values returned by getGroups.

Constructors

Link copied to clipboard
constructor(groups: List<GetGroupsGroup>, id: String, orderBy: String? = null, search: String? = null, sort: String? = null, topLevelOnly: Boolean? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The list of groups.

Link copied to clipboard
val id: String

The provider-assigned unique ID for this managed resource.

Link copied to clipboard
val orderBy: String? = null

Order the groups' list by id, name, path, or similarity. (Requires administrator privileges)

Link copied to clipboard
val search: String? = null

Search groups by name or path.

Link copied to clipboard
val sort: String? = null

Sort groups' list in asc or desc order. (Requires administrator privileges)

Link copied to clipboard
val topLevelOnly: Boolean? = null

Limit to top level groups, excluding all subgroups.