Version 4.0.24.18 (latest)
Get information about all groups.
Request
GET
/groups
Datatype
Description
Request
query
Expand HTTP Query definition...
fields
Requested fields.
page
DEPRECATED. Use limit and offset instead. Return only page N of paginated results
per_page
DEPRECATED. Use limit and offset instead. Return N rows of data per page
limit
Number of results to return. (used with offset and takes priority over page and per_page)
offset
Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
sorts
Fields to sort by.
ids
content_metadata_id
Id of content metadata to which groups must have access.
can_add_to_content_metadata
Select only groups that either can/cannot be given access to content.
Response
200: Group
Datatype
Description
(array)
can
lock
Operations the current user is able to perform on this object
can_add_to_content_metadata
Group can be used in content access controls
contains_current_user
lock
Currently logged in user is group member
external_group_id
lock
External Id group if embed group
externally_managed
lock
Group membership controlled outside of Looker
id
lock
Unique Id
include_by_default
lock
New users are added to this group by default
name
Name of group
user_count
lock
Number of users included in this group
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Examples
Ruby
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/ruby/all_users_to_group.rb |
Kotlin
https://github.com/looker-open-source/sdk-codegen/blob/main/kotlin/src/test/TestMethods.kt |
Swift
https://github.com/looker-open-source/sdk-codegen/blob/main/swift/looker/Tests/lookerTests/smokeTests.swift |