Get details about a membership

This guide explains how to use the get() method on the Membership resource of the Google Chat API to get details about a membership in a space.

If you're a Google Workspace administrator, you can call the get() method to retrieve details about any membership in your Google Workspace organization.

The Membership resource represents whether a human user or Google Chat app is invited to, part of, or absent from a space.

Authenticating with app authentication lets a Chat app get memberships from spaces that it has access to in Google Chat (for example, spaces it's a member of), but excludes Chat app memberships, including its own. Authenticating with user authentication returns memberships from spaces that the authenticated user has access to.

Prerequisites

Node.js

A Business or Enterprise Google Workspace account with access to Google Chat .

Set up your environment:
- Create a Google Cloud project .
- Configure the OAuth consent screen .
- Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
- Install the Node.js Cloud Client Library .
- Create access credentials based on how you want to authenticate in your Google Chat API request:
  - To authenticate as a Chat user, create OAuth client ID credentials and save the credentials as a JSON file named credentials.json to your local directory.
  - To authenticate as the Chat app, create service account credentials and save the credentials as a JSON file named credentials.json .
Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

A Google Chat space where the authenticated user or calling Chat app is a member. To authenticate as the Chat app, add the Chat app to the space .

Python

A Business or Enterprise Google Workspace account with access to Google Chat .

Set up your environment:
- Create a Google Cloud project .
- Configure the OAuth consent screen .
- Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
- Install the Python Cloud Client Library .
- Create access credentials based on how you want to authenticate in your Google Chat API request:
  - To authenticate as a Chat user, create OAuth client ID credentials and save the credentials as a JSON file named credentials.json to your local directory.
  - To authenticate as the Chat app, create service account credentials and save the credentials as a JSON file named credentials.json .
Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

A Google Chat space where the authenticated user or calling Chat app is a member. To authenticate as the Chat app, add the Chat app to the space .

Java

A Business or Enterprise Google Workspace account with access to Google Chat .

Set up your environment:
- Create a Google Cloud project .
- Configure the OAuth consent screen .
- Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
- Install the Java Cloud Client Library .
- Create access credentials based on how you want to authenticate in your Google Chat API request:
  - To authenticate as a Chat user, create OAuth client ID credentials and save the credentials as a JSON file named credentials.json to your local directory.
  - To authenticate as the Chat app, create service account credentials and save the credentials as a JSON file named credentials.json .
Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

A Google Chat space where the authenticated user or calling Chat app is a member. To authenticate as the Chat app, add the Chat app to the space .

Apps Script

A Business or Enterprise Google Workspace account with access to Google Chat .

Set up your environment:
- Create a Google Cloud project .
- Configure the OAuth consent screen .
- Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
- Create a standalone Apps Script project , and turn on the Advanced Chat Service .
- In this guide, you must use either user or app authentication . To authenticate as the Chat app, create service account credentials. For steps, see Authenticate and authorize as a Google Chat app .
Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

A Google Chat space where the authenticated user or calling Chat app is a member. To authenticate as the Chat app, add the Chat app to the space .

Get details about a membership

To get details about a membership in Google Chat, pass the following in your request:

With app authentication , specify the chat.bot authorization scope. With user authentication , specify the chat.memberships.readonly or chat.memberships authorization scope. As a best practice, choose the most restrictive scope that still allows your app to function.
Call the GetMembership() method.
Pass the name of the membership to get. Obtain the membership name from the membership resource of Google Chat.

Get a membership with user authentication

Here's how to get a membership with user authentication :

Node.js

chat/client-libraries/cloud/get-membership-user-cred.js

View on GitHub

 import 
  
 { 
 createClientWithUserCredentials 
 } 
  
 from 
  
 './authentication-utils.js' 
 ; 
 const 
  
 USER_AUTH_OAUTH_SCOPES 
  
 = 
  
 [ 
 'https://www.googleapis.com/auth/chat.memberships.readonly' 
 ]; 
 // This sample shows how to get membership with user credential 
 async 
  
 function 
  
 main 
 () 
  
 { 
  
 // Create a client 
  
 const 
  
 chatClient 
  
 = 
  
 await 
  
 createClientWithUserCredentials 
 ( 
 USER_AUTH_OAUTH_SCOPES 
 ); 
  
 // Initialize request argument(s) 
  
 const 
  
 request 
  
 = 
  
 { 
  
 // Replace SPACE_NAME and MEMBER_NAME here 
  
 name 
 : 
  
 'spaces/SPACE_NAME/members/MEMBER_NAME' 
  
 }; 
  
 // Make the request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 chatClient 
 . 
 getMembership 
 ( 
 request 
 ); 
  
 // Handle the response 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
 } 
 main 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 );

Python

chat/client-libraries/cloud/get_membership_user_cred.py

View on GitHub

 from 
  
 authentication_utils 
  
 import 
 create_client_with_user_credentials 
 from 
  
 google.apps 
  
 import 
 chat_v1 
 as 
 google_chat 
 SCOPES 
 = 
 [ 
 "https://www.googleapis.com/auth/chat.memberships.readonly" 
 ] 
 # This sample shows how to get membership with user credential 
 def 
  
 get_membership_with_user_cred 
 (): 
 # Create a client 
 client 
 = 
 create_client_with_user_credentials 
 ( 
 SCOPES 
 ) 
 # Initialize request argument(s) 
 request 
 = 
 google_chat 
 . 
 GetMembershipRequest 
 ( 
 # Replace SPACE_NAME and MEMBER_NAME here 
 name 
 = 
 'spaces/SPACE_NAME/members/MEMBER_NAME' 
 , 
 ) 
 # Make the request 
 response 
 = 
 client 
 . 
 get_membership 
 ( 
 request 
 ) 
 # Handle the response 
 print 
 ( 
 response 
 ) 
 get_membership_with_user_cred 
 ()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetMembershipUserCred.java

View on GitHub

 import 
  
 com.google.chat.v1.ChatServiceClient 
 ; 
 import 
  
 com.google.chat.v1.GetMembershipRequest 
 ; 
 import 
  
 com.google.chat.v1.Membership 
 ; 
 // This sample shows how to get membership with user credential. 
 public 
  
 class 
 GetMembershipUserCred 
  
 { 
  
 private 
  
 static 
  
 final 
  
 String 
  
 SCOPE 
  
 = 
  
 "https://www.googleapis.com/auth/chat.memberships.readonly" 
 ; 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 try 
  
 ( 
 ChatServiceClient 
  
 chatServiceClient 
  
 = 
  
 AuthenticationUtils 
 . 
 createClientWithUserCredentials 
 ( 
  
 ImmutableList 
 . 
 of 
 ( 
 SCOPE 
 ))) 
  
 { 
  
 GetMembershipRequest 
 . 
 Builder 
  
 request 
  
 = 
  
 GetMembershipRequest 
 . 
 newBuilder 
 () 
  
 // replace SPACE_NAME and MEMBERSHIP_NAME here 
  
 . 
 setName 
 ( 
 "spaces/SPACE_NAME/members/MEMBERSHIP_NAME" 
 ); 
  
 Membership 
  
 response 
  
 = 
  
 chatServiceClient 
 . 
 getMembership 
 ( 
 request 
 . 
 build 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 JsonFormat 
 . 
 printer 
 (). 
 print 
 ( 
 response 
 )); 
  
 } 
  
 } 
 }

Apps Script

chat/advanced-service/Main.gs

View on GitHub

 /** 
 * This sample shows how to get membership with user credential 
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships.readonly' 
 * referenced in the manifest file (appsscript.json). 
 */ 
 function 
  
 getMembershipUserCred 
 () 
  
 { 
  
 // Initialize request argument(s) 
  
 // TODO(developer): Replace SPACE_NAME and MEMBER_NAME here 
  
 const 
  
 name 
  
 = 
  
 'spaces/SPACE_NAME/members/MEMBER_NAME' 
 ; 
  
 // Make the request 
  
 const 
  
 response 
  
 = 
  
 Chat 
 . 
 Spaces 
 . 
 Members 
 . 
 get 
 ( 
 name 
 ); 
  
 // Handle the response 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
 }

To run this sample, replace the following:

SPACE_NAME : the ID from the space's name . You can obtain the ID by calling the ListSpaces() method or from the space's URL.
MEMBER_NAME : the ID from the member's name . You can obtain the ID by calling the ListMemberships() method.

The Chat API returns an instance of Membership detailing the specified membership.

Get a membership with app authentication

Here's how to get a membership with app authentication :

Node.js

chat/client-libraries/cloud/get-membership-app-cred.js

View on GitHub

 import 
  
 { 
 createClientWithAppCredentials 
 } 
  
 from 
  
 './authentication-utils.js' 
 ; 
 // This sample shows how to get membership with app credential 
 async 
  
 function 
  
 main 
 () 
  
 { 
  
 // Create a client 
  
 const 
  
 chatClient 
  
 = 
  
 createClientWithAppCredentials 
 (); 
  
 // Initialize request argument(s) 
  
 const 
  
 request 
  
 = 
  
 { 
  
 // Replace SPACE_NAME and MEMBER_NAME here 
  
 name 
 : 
  
 'spaces/SPACE_NAME/members/MEMBER_NAME' 
  
 }; 
  
 // Make the request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 chatClient 
 . 
 getMembership 
 ( 
 request 
 ); 
  
 // Handle the response 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
 } 
 main 
 (). 
 catch 
 ( 
 console 
 . 
 error 
 );

Python

chat/client-libraries/cloud/get_membership_app_cred.py

View on GitHub

 from 
  
 authentication_utils 
  
 import 
 create_client_with_app_credentials 
 from 
  
 google.apps 
  
 import 
 chat_v1 
 as 
 google_chat 
 # This sample shows how to get membership with app credential 
 def 
  
 get_membership_with_app_cred 
 (): 
 # Create a client 
 client 
 = 
 create_client_with_app_credentials 
 () 
 # Initialize request argument(s) 
 request 
 = 
 google_chat 
 . 
 GetMembershipRequest 
 ( 
 # Replace SPACE_NAME and MEMBER_NAME here 
 name 
 = 
 'spaces/SPACE_NAME/members/MEMBER_NAME' 
 , 
 ) 
 # Make the request 
 response 
 = 
 client 
 . 
 get_membership 
 ( 
 request 
 ) 
 # Handle the response 
 print 
 ( 
 response 
 ) 
 get_membership_with_app_cred 
 ()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetMembershipAppCred.java

View on GitHub

 import 
  
 com.google.chat.v1.ChatServiceClient 
 ; 
 import 
  
 com.google.chat.v1.GetMembershipRequest 
 ; 
 import 
  
 com.google.chat.v1.Membership 
 ; 
 // This sample shows how to get membership with app credential. 
 public 
  
 class 
 GetMembershipAppCred 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 try 
  
 ( 
 ChatServiceClient 
  
 chatServiceClient 
  
 = 
  
 AuthenticationUtils 
 . 
 createClientWithAppCredentials 
 ()) 
  
 { 
  
 GetMembershipRequest 
 . 
 Builder 
  
 request 
  
 = 
  
 GetMembershipRequest 
 . 
 newBuilder 
 () 
  
 // replace SPACE_NAME and MEMBERSHIP_NAME here 
  
 . 
 setName 
 ( 
 "spaces/SPACE_NAME/members/MEMBERSHIP_NAME" 
 ); 
  
 Membership 
  
 response 
  
 = 
  
 chatServiceClient 
 . 
 getMembership 
 ( 
 request 
 . 
 build 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 JsonFormat 
 . 
 printer 
 (). 
 print 
 ( 
 response 
 )); 
  
 } 
  
 } 
 }

Apps Script

chat/advanced-service/Main.gs

View on GitHub

 /** 
 * This sample shows how to get membership with app credential 
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot' 
 * used by service accounts. 
 */ 
 function 
  
 getMembershipAppCred 
 () 
  
 { 
  
 // Initialize request argument(s) 
  
 // TODO(developer): Replace SPACE_NAME and MEMBER_NAME here 
  
 const 
  
 name 
  
 = 
  
 'spaces/SPACE_NAME/members/MEMBER_NAME' 
 ; 
  
 const 
  
 parameters 
  
 = 
  
 {}; 
  
 // Make the request 
  
 const 
  
 response 
  
 = 
  
 Chat 
 . 
 Spaces 
 . 
 Members 
 . 
 get 
 ( 
 name 
 , 
  
 parameters 
 , 
  
 getHeaderWithAppCredentials 
 ()); 
  
 // Handle the response 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
 }

To run this sample, replace the following:

SPACE_NAME : the ID from the space's name . You can obtain the ID by calling the ListSpaces() method or from the space's URL.
MEMBER_NAME : the ID from the member's name . You can obtain the ID by calling the ListMemberships() method.

The Chat API returns an instance of Membership detailing the specified membership.

Get details about memberships as a Google Workspace administrator

If you're a Google Workspace administrator, you can call the GetMembership() method to retrieve details about a membership for any user in your Google Workspace organization.

To call this method as a Google Workspace administrator, do the following:

Call the method using user authentication, and specify an authorization scope that supports calling the method using administrator privileges .
In your request, specify the query parameter useAdminAccess to true .

For more information and examples, see Manage Google Chat spaces as a Google Workspace administrator .

Get details about a membership Stay organized with collections Save and categorize content based on your preferences.

Prerequisites

Node.js

Python

Java

Apps Script

Get details about a membership

Get a membership with user authentication

Node.js

Python

Java

Apps Script

Get a membership with app authentication

Node.js

Python

Java

Apps Script

Get details about memberships as a Google Workspace administrator

Related topics

Get details about a membership