Globus SDK for JavaScript
    Preparing search index...

    Function act

    • Perform actions on members of the group.

      Parameters

      • group_id: string
      • options:
            | undefined
            | {
                payload: {
                    accept?: | null
                    | { identity_id: string; status_reason?: null
                    | string }[];
                    add?:
                        | null
                        | {
                            identity_id: string;
                            role?: null
                            | "manager"
                            | "member"
                            | "admin";
                            status_reason?: null | string;
                        }[];
                    approve?: null
                    | { identity_id: string; status_reason?: null | string }[];
                    change_role?:
                        | null
                        | { identity_id: string; role?: null
                        | "manager"
                        | "member"
                        | "admin" }[];
                    decline?: null | { identity_id: string; status_reason?: null | string }[];
                    invite?:
                        | null
                        | {
                            identity_id: string;
                            invite_email_address?: null
                            | string;
                            role?: null | "manager" | "member" | "admin";
                            status_reason?: null | string;
                        }[];
                    join?: null
                    | { identity_id: string }[];
                    leave?: null | { identity_id: string; status_reason?: null | string }[];
                    reject?: null | { identity_id: string; status_reason?: null | string }[];
                    remove?: null | { identity_id: string; status_reason?: null | string }[];
                    request_join?: null | { identity_id: string }[];
                };
            } & {
                headers?: Headers;
                query?: {
                    [key: string]: | undefined
                    | null
                    | string
                    | number
                    | boolean
                    | (undefined | null | string | number)[];
                };
            }
      • OptionalsdkOptions: SDKOptions

      Returns Promise<
          JSONFetchResponse<
              {
                  accept?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  add?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  approve?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  change_role?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  decline?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  errors?: | null
                  | {
                      accept?: | null
                      | { code: string; detail: string; identity_id: string }[];
                      add?: null | { code: string; detail: string; identity_id: string }[];
                      approve?: null | { code: string; detail: string; identity_id: string }[];
                      change_role?:
                          | null
                          | { code: string; detail: string; identity_id: string }[];
                      decline?: null | { code: string; detail: string; identity_id: string }[];
                      invite?: null | { code: string; detail: string; identity_id: string }[];
                      join?: null | { code: string; detail: string; identity_id: string }[];
                      leave?: null | { code: string; detail: string; identity_id: string }[];
                      reject?: null | { code: string; detail: string; identity_id: string }[];
                      remove?: null | { code: string; detail: string; identity_id: string }[];
                      request_join?:
                          | null
                          | { code: string; detail: string; identity_id: string }[];
                  };
                  invite?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  join?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  leave?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  reject?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  remove?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  request_join?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields?: null | Record<string, unknown>;
                      role: "manager" | "member" | "admin";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
              },
          >,
      >

      https://groups.api.globus.org/redoc#tag/groups/operation/group_membership_post_actions_v2_groups__group_id__post

    Settings

    Member Visibility