Function act

  • Perform actions on members of the group.

    Parameters

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

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

    See

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

Settings

Member Visibility

Theme

Generated using TypeDoc