Get All Groups
Implementation Notes
Get information about all groups.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
page | false | Return only page N of paginated results | integer | int64 |
per_page | false | Return N rows of data per page | integer | int64 |
sorts | false | Fields to sort by. | string | string |
ids | false | Optional of ids to get specific groups. | array | array |
content_metadata_id | false | Id of content metadata to which groups must have access. | integer | int64 |
can_add_to_content_metadata | false | Select only groups that either can/cannot be given access to content. | boolean | boolean |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Group
Implementation Notes
Creates a new group (admin only).
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
body | true | Group | body |
Group {
can (object, read-only): Operations the current user is able to perform on this object, can_add_to_content_metadata (boolean): Group can be used in content access controls, contains_current_user (boolean, read-only): Currently logged in user is group member, external_group_id (string, read-only): External Id group if embed group, externally_managed (boolean, read-only): Group membership controlled outside of Looker, id (long, read-only): Unique Id, include_by_default (boolean, read-only): New users are added to this group by default, name (string): Name of group, user_count (long, read-only): Number of users included in this group }
|
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Group
Implementation Notes
Get information about a group.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Group
Implementation Notes
Updates the a group (admin only).
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
body | true | Group | body |
Group {
can (object, read-only): Operations the current user is able to perform on this object, can_add_to_content_metadata (boolean): Group can be used in content access controls, contains_current_user (boolean, read-only): Currently logged in user is group member, external_group_id (string, read-only): External Id group if embed group, externally_managed (boolean, read-only): Group membership controlled outside of Looker, id (long, read-only): Unique Id, include_by_default (boolean, read-only): New users are added to this group by default, name (string): Name of group, user_count (long, read-only): Number of users included in this group }
|
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Delete Group
Implementation Notes
Deletes a group (admin only).
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
403 | Permission Denied |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Successfully deleted. | string |
Get All Groups in Group
Implementation Notes
Get information about all the groups in a group.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Add a Group to Group
Implementation Notes
Adds a new group to a group.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
body | true | Group id to add | body |
GroupIdForGroupInclusion {
group_id (long, read-only): Id of group }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
403 | Permission Denied |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get All Users in Group
Implementation Notes
Get information about all the users directly included in a group.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
fields | false | Requested fields. | string | string |
page | false | Return only page N of paginated results | integer | int64 |
per_page | false | Return N rows of data per page | integer | int64 |
sorts | false | Fields to sort by. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Add a User to Group
Implementation Notes
Adds a new user to a group.
Response Class
CredentialsApi3 {
CredentialsEmail {
CredentialsEmbed {
CredentialsGoogle {
CredentialsLDAP {
CredentialsLookerOpenid {
CredentialsOIDC {
CredentialsSaml {
CredentialsTotp {
Session {
CredentialsApi {
AccessFilter {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
body | true | User id to add | body |
GroupIdForGroupUserInclusion {
user_id (long, read-only): Id of user }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
403 | Permission Denied |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Remove a User from Group
Implementation Notes
Removes a user from a group.
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
user_id | true | Id of user to remove from group | integer | int64 |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
403 | Permission Denied |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | User successfully removed from group |
Deletes a Group from Group
Implementation Notes
Removes a group from a group.
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
deleting_group_id | true | Id of group to delete | integer | int64 |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
403 | Permission Denied |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Group successfully deleted |
Set User Attribute Group Value
Implementation Notes
Set the value of a user attribute for a group.
For information about how user attribute values are calculated, see Set User Attribute Group Values).
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
user_attribute_id | true | Id of user attribute | integer | int64 |
body | true | New value for group. | body |
UserAttributeGroupValue {
can (object, read-only): Operations the current user is able to perform on this object, id (long, read-only): Unique Id of this group-attribute relation, group_id (long, read-only): Id of group, user_attribute_id (long, read-only): Id of user attribute, value_is_hidden (boolean, read-only): If true, the "value" field will be null, because the attribute settings block access to this value, rank (long, read-only): Precedence for resolving value for user, value (string, read-only): Value of user attribute for group }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
Delete User Attribute Group Value
Implementation Notes
Remove a user attribute value from a group.
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
group_id | true | Id of group | integer | int64 |
user_attribute_id | true | Id of user attribute | integer | int64 |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Value successfully unset |