계정에서 사용자를 제거합니다.
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱에 보안 및 제어 아래의 사용자 관리의 관리자 API 범위가 필요합니다.
DELETE https://{{host}}/api/public/users
참고 사항: 이 기능은 플랫폼의 v7.1에 도입되었습니다.
쿼리 매개 변수
매개 변수 | 설명 |
---|---|
host | 환경 URL(예: https://bots.kore.ai) |
본문 매개 변수
매개 변수 | 설명 |
---|---|
deleteEmailIds 또는 orgUserIds | 정보를 삭제할 각 사용자에 대한 이메일 또는 조직 사용자 ID의 배열입니다. |
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
콘텐츠 유형 응답
application/json
샘플 요청
curl -X DELETE \
https://{{host}}/api/public/users \
-H 'Content-Type: application/json' \
-H 'auth: YOUR_JWT_ACCESS_TOKEN' \
-d '{
"deleteEmailIds"/"orgUserIds":["deskkore1@gmail.com"]
}'
샘플 응답
- 성공 사례의 경우:
{"msg": "Users are removed Successfully"};
- 실패 사례:
{ "failedUserDetails": [ { "emailId": "deskkore1@gmail.com", "reason": { "statusCode": 400, "status": 400, "customCode": 400, "errors": [ { "msg": "Unauthorized to perform this activity", "code": 400 } ], "_headers": {}, "message": "Unauthorized to perform this activity", "name": "BadRequest" } } ] }