Globus SDK for JavaScript
    Preparing search index...

    Function update

    • Update a group's information.

      Parameters

      • group_id: string
      • options:
            | undefined
            | {
                payload: {
                    description?: null
                    | string;
                    name?: null | string;
                    subscription_admin_verified_id?: null | string;
                    terms_and_conditions?: null | string;
                };
                query?: undefined;
            } & {
                headers?: Headers;
                query?: {
                    [key: string]: | undefined
                    | null
                    | string
                    | number
                    | boolean
                    | (undefined | null | string | number)[];
                };
            }
      • OptionalsdkOptions: SDKOptions

      Returns Promise<
          JSONFetchResponse<
              {
                  allowed_actions?: | null
                  | {
                      accept: string[];
                      add: string[];
                      approve: string[];
                      change_role: string[];
                      decline: string[];
                      invite: string[];
                      join: string[];
                      leave: string[];
                      reject: string[];
                      remove: string[];
                      request_join: string[];
                  };
                  child_ids?: null
                  | string[];
                  description?: null | string;
                  enforce_session: boolean;
                  group_type: "regular" | "plus";
                  id: string;
                  memberships?:
                      | null
                      | {
                          group_id: string;
                          identity_id: string;
                          invite_email_address?: null
                          | string;
                          invite_time?: null | string;
                          membership_fields: null | { [key: string]: unknown };
                          role: "manager" | "admin" | "member";
                          source_group_id?: string;
                          status:
                              | "active"
                              | "invited"
                              | "pending"
                              | "rejected"
                              | "removed"
                              | "left"
                              | "declined";
                          status_reason?: null
                          | string;
                          updated?: null | string;
                          username: string;
                      }[];
                  my_memberships?: | null
                  | {
                      group_id: string;
                      identity_id: string;
                      invite_email_address?: null
                      | string;
                      invite_time?: null | string;
                      membership_fields: null | { [key: string]: unknown };
                      role: "manager" | "admin" | "member";
                      source_group_id?: string;
                      status:
                          | "active"
                          | "invited"
                          | "pending"
                          | "rejected"
                          | "removed"
                          | "left"
                          | "declined";
                      status_reason?: null
                      | string;
                      updated?: null | string;
                      username: string;
                  }[];
                  name: string;
                  parent_id: null
                  | string;
                  policies?: {
                      authentication_assurance_timeout?: null | number;
                      group_members_visibility: "members" | "managers";
                      group_visibility: "authenticated" | "private";
                      is_high_assurance: boolean;
                      join_requests?: boolean;
                      signup_fields: (
                          | "state"
                          | "department"
                          | "institution"
                          | "current_project_name"
                          | "address"
                          | "city"
                          | "country"
                          | "address1"
                          | "address2"
                          | "zip"
                          | "phone"
                          | "field_of_science"
                      )[];
                  };
                  session_limit?: null
                  | number;
                  session_timeouts: {
                      [key: string]: { expire_time: string; expires_in: number };
                  };
                  subscription_admin_verified_id?: null
                  | string;
                  subscription_id?: null | string;
                  subscription_info?:
                      | null
                      | {
                          connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
                          is_baa: boolean;
                          is_high_assurance: boolean;
                          name: string;
                          subscriber_name: string;
                      };
                  terms_and_conditions?: null
                  | string;
              },
          >,
      >

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

    Settings

    Member Visibility