Edits history of script submission #20024 for ' Delete User Group (segment)'

  • bun
    One script reply has been approved by the moderators
    Ap­pro­ved
    //native
    type Segment = {
      token: string;
      baseUrl: string;
    };
    /**
     * Delete User Group
     * Removes a user group from a Workspace.
    
    
    
    • When called, this endpoint may generate the `User Group Deleted` event in the audit trail.
          
    
    
    The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See Rate Limiting for more information.
     */
    export async function main(auth: Segment, userGroupId: string) {
      const url = new URL(`${auth.baseUrl}/groups/${userGroupId}`);
    
      const response = await fetch(url, {
        method: "DELETE",
        headers: {
          Authorization: "Bearer " + auth.token,
        },
        body: undefined,
      });
      if (!response.ok) {
        const text = await response.text();
        throw new Error(`${response.status} ${text}`);
      }
      return await response.json();
    }
    

    Submitted by hugo697 235 days ago