User Guide Getting Started Help Center Documentation Community Training
  
English
日本語
Group : Manage Groups

Get All Groups

GET/api/3.0/groups
all_groups(fields, page, per_page, sorts, ids, content_metadata_id, can_add_to_content_metadata)

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 Requested page. integer int64
per_page false Results 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

POST/api/3.0/groups
create_group(body, fields)

Implementation Notes

Creates a new group (admin only).

Response Class

Group {
id (long, read-only): Unique Id,
name (string): Name of group,
user_count (long, read-only): Number of users included in this group,
contains_current_user (boolean, read-only): Currently logged in user is group member,
externally_managed (boolean, read-only): Group membership controlled outside of Looker,
include_by_default (boolean, read-only): New users are added to this group by default,
external_group_id (string, read-only): External Id group if embed group,
can_add_to_content_metadata (boolean): Group can be used in content access controls,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body false Group body
Group {
id (long, read-only): Unique Id,
name (string): Name of group,
user_count (long, read-only): Number of users included in this group,
contains_current_user (boolean, read-only): Currently logged in user is group member,
externally_managed (boolean, read-only): Group membership controlled outside of Looker,
include_by_default (boolean, read-only): New users are added to this group by default,
external_group_id (string, read-only): External Id group if embed group,
can_add_to_content_metadata (boolean): Group can be used in content access controls,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Get Group

GET/api/3.0/groups/{group_id}
group(group_id, fields)

Implementation Notes

Get information about a group.

Response Class

Group {
id (long, read-only): Unique Id,
name (string): Name of group,
user_count (long, read-only): Number of users included in this group,
contains_current_user (boolean, read-only): Currently logged in user is group member,
externally_managed (boolean, read-only): Group membership controlled outside of Looker,
include_by_default (boolean, read-only): New users are added to this group by default,
external_group_id (string, read-only): External Id group if embed group,
can_add_to_content_metadata (boolean): Group can be used in content access controls,
can (object, read-only): Operations the current user is able to perform on this object
}

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

PATCH/api/3.0/groups/{group_id}
update_group(group_id, body, fields)

Implementation Notes

Updates the a group (admin only).

Response Class

Group {
id (long, read-only): Unique Id,
name (string): Name of group,
user_count (long, read-only): Number of users included in this group,
contains_current_user (boolean, read-only): Currently logged in user is group member,
externally_managed (boolean, read-only): Group membership controlled outside of Looker,
include_by_default (boolean, read-only): New users are added to this group by default,
external_group_id (string, read-only): External Id group if embed group,
can_add_to_content_metadata (boolean): Group can be used in content access controls,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
group_id true Id of group integer int64
body true Group body
Group {
id (long, read-only): Unique Id,
name (string): Name of group,
user_count (long, read-only): Number of users included in this group,
contains_current_user (boolean, read-only): Currently logged in user is group member,
externally_managed (boolean, read-only): Group membership controlled outside of Looker,
include_by_default (boolean, read-only): New users are added to this group by default,
external_group_id (string, read-only): External Id group if embed group,
can_add_to_content_metadata (boolean): Group can be used in content access controls,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Delete Group

DELETE/api/3.0/groups/{group_id}
delete_group(group_id)

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
}
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 Successfully deleted. string

Get All Groups in Group

GET/api/3.0/groups/{group_id}/groups
all_group_groups(group_id, fields)

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

POST/api/3.0/groups/{group_id}/groups
add_group_group(group_id, body)

Implementation Notes

Adds a new group to a group.

Response Class

Group {
id (long, read-only): Unique Id,
name (string): Name of group,
user_count (long, read-only): Number of users included in this group,
contains_current_user (boolean, read-only): Currently logged in user is group member,
externally_managed (boolean, read-only): Group membership controlled outside of Looker,
include_by_default (boolean, read-only): New users are added to this group by default,
external_group_id (string, read-only): External Id group if embed group,
can_add_to_content_metadata (boolean): Group can be used in content access controls,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
group_id true Id of group integer int64
body false Group id to add body
GroupIdForGroupInclusion {
group_id (long, read-only): Id of group,
can (object, read-only): Operations the current user is able to perform on this object
}

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

GET/api/3.0/groups/{group_id}/users
all_group_users(group_id, fields, page, per_page, sorts)

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 Requested page. integer int64
per_page false Results 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

POST/api/3.0/groups/{group_id}/users
add_group_user(group_id, body)

Implementation Notes

Adds a new user to a group.

Response Class

User {
id (long, read-only): Unique Id,
first_name (string): First name,
last_name (string): Last name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
email (string, read-only): EMail address,
is_disabled (boolean): Account has been disabled,
avatar_url (string, read-only): URL for the avatar image (may be generic),
home_space_id (string): ID string for user's home space,
personal_space_id (long, read-only): ID of user's personal space,
embed_group_space_id (long, read-only): (Embed only) ID of user's group space based on the external_group_id optionally specified during embed user login,
access_filters (Array[AccessFilter], read-only): Model access filters.,
credentials_email (CredentialsEmail, read-only): Email/Password login credentials,
credentials_totp (CredentialsTotp, read-only): Two-factor credentials,
credentials_ldap (CredentialsLDAP, read-only): LDAP credentials,
credentials_google (CredentialsGoogle, read-only): Google auth credentials,
credentials_saml (CredentialsSaml, read-only): Saml auth credentials,
credentials_oidc (CredentialsOIDC, read-only): OpenID Connect auth credentials,
credentials_api (CredentialsApi, read-only): API user credentials. NO LONGER SUPPORTED.,
credentials_api3 (Array[CredentialsApi3], read-only): API 3 credentials,
credentials_embed (Array[CredentialsEmbed], read-only): Embed credentials,
credentials_looker_openid (CredentialsLookerOpenid, read-only): LookerOpenID credentials. Used for login by Looker Analysts,
sessions (Array[Session], read-only): Active sessions,
role_ids (Array[long], read-only): Array of ids of the roles for this user,
group_ids (Array[long], read-only): Array of ids of the groups for this user,
presumed_looker_employee (boolean, read-only): User is identified as an employee of Looker,
verified_looker_employee (boolean, read-only): User is identified as an employee of Looker who has been verified via Looker corporate authentication,
looker_versions (Array[string], read-only): Array of strings representing the Looker versions that this user has used (this only goes back as far as '3.54.0'),
ui_state (object): Per user dictionary of undocumented state information owned by the Looker UI.,
locale (string): User's preferred locale. User locale takes precedence over Looker's system-wide default locale. Locale determines language of display strings and date and numeric formatting in API responses. Locale string must be a 2 letter language code or a combination of language code and region code: 'en' or 'en-US', for example.,
models_dir_validated (boolean): User's dev workspace has been checked for presence of applicable production projects,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
AccessFilter {
id (long, read-only): ID of this AccessFilter,
model (string): Model to which this filter applies,
field (string): Field to which this filter applies,
value (string): Value for this filter,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsEmail {
email (string): EMail address used for user login,
created_at (string, read-only): Timestamp for the creation of this credential,
logged_in_at (string, read-only): Timestamp for most recent login using credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
password_reset_url (string, read-only): Url with one-time use secret token that the user can use to reset password,
forced_password_reset_at_next_login (boolean, read-only): Force the user to change their password upon their next login,
url (string, read-only): Link to get this item,
user_url (string, read-only): Link to get this user,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsTotp {
verified (boolean, read-only): User has verified,
created_at (string, read-only): Timestamp for the creation of this credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsLDAP {
email (string, read-only): EMail address,
ldap_id (string, read-only): LDAP Unique ID for this user,
ldap_dn (string, read-only): LDAP Distinguished name for this user (as-of the last login),
created_at (string, read-only): Timestamp for the creation of this credential,
logged_in_at (string, read-only): Timestamp for most recent login using credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsGoogle {
email (string, read-only): EMail address,
google_user_id (string, read-only): Google's Unique ID for this user,
domain (string, read-only): Google domain,
created_at (string, read-only): Timestamp for the creation of this credential,
logged_in_at (string, read-only): Timestamp for most recent login using credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsSaml {
email (string, read-only): EMail address,
saml_user_id (string, read-only): Saml IdP's Unique ID for this user,
created_at (string, read-only): Timestamp for the creation of this credential,
logged_in_at (string, read-only): Timestamp for most recent login using credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsOIDC {
email (string, read-only): EMail address,
oidc_user_id (string, read-only): OIDC OP's Unique ID for this user,
created_at (string, read-only): Timestamp for the creation of this credential,
logged_in_at (string, read-only): Timestamp for most recent login using credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsApi {
token (string, read-only): API key token,
created_at (string, read-only): Timestamp for the creation of this credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsApi3 {
id (long, read-only): Unique Id,
client_id (string, read-only): API key client_id,
created_at (string, read-only): Timestamp for the creation of this credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsEmbed {
id (long, read-only): Unique Id,
external_user_id (string, read-only): Embedder's unique id for the user,
external_group_id (string, read-only): Embedder's id for a group to which this user was added during the most recent login,
created_at (string, read-only): Timestamp for the creation of this credential,
logged_in_at (string, read-only): Timestamp for most recent login using credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
CredentialsLookerOpenid {
email (string, read-only): EMail address used for user login,
created_at (string, read-only): Timestamp for the creation of this credential,
logged_in_at (string, read-only): Timestamp for most recent login using credential,
logged_in_ip (string, read-only): IP address of client for most recent login using credential,
is_disabled (boolean, read-only): Has this credential been disabled?,
type (string, read-only): Short name for the type of this kind of credential,
url (string, read-only): Link to get this item,
user_url (string, read-only): Link to get this user,
can (object, read-only): Operations the current user is able to perform on this object
}
Session {
id (long, read-only): Unique Id,
ip_address (string, read-only): IP address of user when this session was initiated,
browser (string, read-only): User's browser type,
operating_system (string, read-only): User's Operating System,
city (string, read-only): City component of user location (derived from IP address),
state (string, read-only): State component of user location (derived from IP address),
country (string, read-only): Country component of user location (derived from IP address),
credentials_type (string, read-only): Type of credentials used for logging in this session,
extended_at (string, read-only): Time when this session was last extended by the user,
extended_count (long, read-only): Number of times this session was extended,
sudo_user_id (long, read-only): Actual user in the case when this session represents one user sudo'ing as another,
created_at (string, read-only): Time when this session was initiated,
expires_at (string, read-only): Time when this session will expire,
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
group_id true Id of group integer int64
body false User id to add body
GroupIdForGroupUserInclusion {
user_id (long, read-only): Id of user,
can (object, read-only): Operations the current user is able to perform on this object
}

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

DELETE/api/3.0/groups/{group_id}/users/{user_id}
delete_group_user(group_id, user_id)

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

DELETE/api/3.0/groups/{group_id}/groups/{deleting_group_id}
delete_group_from_group(group_id, deleting_group_id)

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

PATCH/api/3.0/groups/{group_id}/attribute_values/{user_attribute_id}
update_user_attribute_group_value(group_id, user_attribute_id, body)

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

UserAttributeGroupValue {
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,
can (object, read-only): Operations the current user is able to perform on this object
}

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 {
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,
can (object, read-only): Operations the current user is able to perform on this object
}

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
}

Delete User Attribute Group Value

DELETE/api/3.0/groups/{group_id}/attribute_values/{user_attribute_id}
delete_user_attribute_group_value(group_id, user_attribute_id)

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
Top