Skip to main content

​
Overview

The createLoginGroup() method creates a Google login group that manages authentication for bots joining Google Meet meetings. Login groups allow you to control when and how bots authenticate to Google Meet.

​
Method Signature

async createLoginGroup(params: CreateLoginGroupParams): Promise<Response>

​
Parameters

​
CreateLoginGroupParams

​
name
string
required
The name of the login group. This is used to identify the group when assigning it to bots.
​
loginMode
LoginMode
required
Controls when the bot should authenticate to Google Meet.
  • "always" - Bot will always authenticate when joining a meeting
  • "only_if_required" - Bot will only authenticate if the meeting requires it

​
Types

​
LoginMode

type LoginMode = "always" | "only_if_required";
Defines when a bot should authenticate to Google Meet:
  • always: The bot authenticates for every meeting, regardless of meeting requirements
  • only_if_required: The bot only authenticates when the meeting host has restricted access to authenticated users

​
CreateLoginGroupParams

interface CreateLoginGroupParams {
  name: string;
  loginMode: LoginMode;
}
Configuration parameters for creating a new Google login group.

​
Example

import { RecallAI } from '@recall-ai/sdk';

const recall = new RecallAI({ apiKey: 'your-api-key' });

// Create a login group that always authenticates
const loginGroup = await recall.auth.google.createLoginGroup({
  name: 'production-bots',
  loginMode: 'always'
});

// Create a login group that only authenticates when required
const conditionalLoginGroup = await recall.auth.google.createLoginGroup({
  name: 'conditional-auth-bots',
  loginMode: 'only_if_required'
});

​
Use Cases

​
Always Authenticate

Use loginMode: "always" when:
  • Your bots need to join private or restricted meetings consistently
  • You want to ensure a specific Google account identity for all meetings
  • Compliance or security policies require authenticated access

​
Conditional Authentication

Use loginMode: "only_if_required" when:
  • You want to minimize authentication overhead for public meetings
  • Your bots join a mix of public and private meetings
  • You want to preserve Google account rate limits

​
Response

The method returns a Promise that resolves with the created login group details. The exact response structure depends on the API implementation.

​
Error Handling

try {
  const loginGroup = await recall.auth.google.createLoginGroup({
    name: 'my-login-group',
    loginMode: 'always'
  });
  console.log('Login group created:', loginGroup);
} catch (error) {
  console.error('Failed to create login group:', error);
}

Build docs developers (and LLMs) love

Get started for freeTalk to us