회원 제거 | Bootpay 커머스 매뉴얼

기업 그룹(UserGroup)에 등록된 회원(User)을 제거해요. 제거된 회원이 주문할 경우 기업 그룹 내에서는 조회되지 않아요.

API 엔드포인트

DELETEhttps://api.bootapi.com/v1/user-groups/:user_group_id/user/:idBasic Auth

필요 scope: manager:user_group_remove_user (Bootpay-Role 헤더로 역할 부분 변경 가능). 대상 회원은 URL 경로로 지정하며 회원 JWT는 읽지 않아요. v1 회원 그룹 API 상세 명세에서 인증과 응답 필드를 확인해요.

제거된 회원의 이전 주문 내역은 그대로 남아있어요.
제거된 회원은 다시 그룹에 추가할 수 있어요.

요청 파라미터

파라미터	타입	필수	설명
`user_group_id`	String	필수	그룹 ID 또는 그룹 생성 때 지정한 `uid` (URL 경로)
`id`	String	필수	제거할 회원 ID, 가맹점 고유값 또는 로그인 ID (URL 경로, 요청 본문 아님)

코드 예제

const { BootpayCommerce } = require('@bootpay/backend-js');

const commerce = new BootpayCommerce({
    client_key: '{client_key}',
    secret_key: '{secret_key}'
});

const userGroupId = '67e2052b03d0cb4e4117b0af';
const response = await commerce.userGroup.removeUser(userGroupId, {
    user_id: '67e2052b03d0cb4e4117b0b1'
});
console.log(response);javascript

from bootpay_backend.commerce import BootpayCommerce

commerce = BootpayCommerce('{client_key}', '{secret_key}')
user_group_id = '67e2052b03d0cb4e4117b0af'
response = commerce.user_group.remove_user(user_group_id, {
    'user_id': '67e2052b03d0cb4e4117b0b1'
})
print(response)python

use Bootpay\ServerPhp\BootpayCommerceApi;

$commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
$userGroupId = '67e2052b03d0cb4e4117b0af';
$response = $commerce->userGroup->removeUser($userGroupId, [
    'user_id' => '67e2052b03d0cb4e4117b0b1'
]);
print_r($response);php

import kr.co.bootpay.store.BootpayStore;
import kr.co.bootpay.store.model.request.TokenPayload;
import kr.co.bootpay.store.model.response.BootpayStoreResponse;

TokenPayload tokenPayload = new TokenPayload("{client_key}", "{secret_key}");
BootpayStore bootpay = new BootpayStore(tokenPayload).withToken();
String userGroupId = "67e2052b03d0cb4e4117b0af";
String userId = "67e2052b03d0cb4e4117b0b1";

BootpayStoreResponse response = bootpay.userGroup.userDelete(userGroupId, userId);
System.out.println(response.getData());java

require 'bootpay'

commerce = BootpayStore::RestClient.new(client_key: '{client_key}', secret_key: '{secret_key}')
user_group_id = '67e2052b03d0cb4e4117b0af'
response = commerce.delete_user_from_group(
  user_group_id: user_group_id,
  user_id: '67e2052b03d0cb4e4117b0b1'
)
puts responseruby

commerce := bootpay.NewCommerceApi("{client_key}", "{secret_key}")
userGroupId := "67e2052b03d0cb4e4117b0af"
response, err := commerce.UserGroup.RemoveUser(userGroupId, map[string]interface{}{
    "user_id": "67e2052b03d0cb4e4117b0b1",
})
fmt.Println(response)go

using Bootpay.Commerce;

var commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
var userGroupId = "67e2052b03d0cb4e4117b0af";
var response = await commerce.UserGroup.RemoveUser(userGroupId, new {
    user_id = "67e2052b03d0cb4e4117b0b1"
});
Console.WriteLine(response);csharp

응답

성공 응답

HTTP 200 에 본문은 true 예요.

truejson

에러 코드

인증·권한 관련 에러는 에러 코드표를 참고해요.

코드	메시지	대처 방법
`USER_NOT_FOUND`	회원정보가 없어요. 다시 확인해요.	user_id를 확인해요
`USER_GROUP_NOT_FOUND`	회원 그룹 정보를 찾지 못했어요. 다시 로그인해요.	user_group_id를 확인해요
`USER_NOT_IN_GROUP`	사용자가 그룹에 속해 있지 않아요.	사용자의 그룹 소속을 확인해요

탈퇴한 회원도 그룹에서 제거할 수 있어요. 이 API 는 대상 회원의 탈퇴 여부를 검사하지 않아요.