Globus SDK for JavaScript
    Preparing search index...

    Function act

    • Perform actions on members of the group.

      Parameters

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

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

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

    Settings

    Member Visibility