사용자 API 업데이트1 min read

사용자 세부 정보를 업데이트합니다.

이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱에 보안 및 제어 아래의 사용자 관리의 관리자 API 범위가 필요합니다.

PUT https://{{host}}/api/public/users 참고 사항: 이 기능은 플랫폼의 v7.1에 도입되었습니다.

쿼리 매개 변수

매개 변수	설명
host	환경 URL(예: https://bots.kore.ai)

본문 매개 변수

매개 변수

설명

users

업데이트해야 하는 각 사용자에 대한 세부 정보 배열

userInfo.emailId or userInfo.orgUserId (필수)

업데이트 중인 사용자의 이메일 ID 또는 조직 사용자 ID

userInfo.firstName(선택 사항)

업데이트해야 할 경우 사용자의 이름

userInfo.lastName(선택 사항)

업데이트해야 할 경우 사용자의 성

userInfo.companyName(선택 사항)

업데이트해야 할 경우 사용자의 회사

userInfo.dept(선택 사항)

업데이트해야 할 경우 사용자의 부서

userInfo.companyContactPhone(선택 사항)

업데이트해야 할 경우 사용자가 속한 회사의 연락처

userInfo.worknumber(선택 사항)

업데이트가 필요한 경우 사용자의 회사 번호

userInfo.street(선택 사항)

업데이트해야 하는 경우 사용자의 주소

userInfo.suiteNo(선택 사항)

업데이트가 필요한 경우 객실 주소

userInfo.city(선택 사항)

업데이트가 필요한 경우 사용자의 도시 주소

userInfo.zip(선택 사항)

업데이트해야 할 경우 사용자의 우편 주소

userInfo.state(선택 사항)

업데이트해야 할 경우 사용자의 주 주소

userInfo.country(선택 사항)

업데이트해야 하는 경우 사용자의 국가 주소

groups(선택 사항)

사용자가 addTo 또는 removeFrom 이어야 하는 그룹 ID의 배열

roles(선택 사항)

사용자가 addTo 또는 removeFrom 이어야 하는 roleId – botId 조합의 배열

assignBotTasks(선택 사항)

사용자에게 할당해야 하는 봇의 배열입니다. 나타나지 않으면 현재 배정이 유지됩니다.

botId	사용자에게 할당할 봇 ID입니다. 지정되지 않은 경우 이전에 할당된 모든 봇이 할당되지 않습니다. 즉, "botId" 항목이 없는 "assignBotTasks" 항목으로 사용자에 대한 봇 작업 할당을 취소할 수 있습니다.
dialogs	사용자에게 할당해야 하는 봇 내 대화 작업 ID의 배열입니다. 지정하지 않으면 모든 대화 상자 작업이 할당됩니다

canCreateBot(선택 사항)

지정된 사용자가 봇 빌더 계정에 봇을 생성할 수 있는지를 결정합니다. true 또는 false로 설정합니다. 기본값은 "true"입니다.

isDeveloper(선택 사항)

지정된 사용자가 봇 빌더에 액세스할 수 있는지를 결정합니다. true 또는 false로 설정합니다. 기본값은 "true"입니다.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다: auth: {{JWT}}

콘텐츠 유형 응답

application/json

샘플 요청

curl -X PUT \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "publicuser2@gmail.com" // or "orgUserId": <orgUserId>,
                "firstName": "user1",
                "lastName":"user1",
                "companyName":"company_name",
                "dept":"dept",
                "companyContactPhone":"12334444",
                "worknumber":"321",
                "street":"street",
                "suiteNo":"suite",
                "city":"city",
                "zip":"123123",
                "state":"state",
                "country":"country"
            },
            "groups": {
                "addTo": [
                    "e-f9c09c08-9310-52ff-b672-570ec7325215"
                ]
            },
            "roles": {
                "addTo": [
                    {
                        "roleId": "5d9d8db3x0d54920a8df1e68b",
                        "botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                    }
                ],
                "removeFrom": [
                    {
                        "roleId": "5d9d920dabdc1e6e8ec99342",
                        "botId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                    }
                ]
            },
            "assignBotTasks": [
               {
                  "botId": "st-xxx-xx-xxx-xxx-xxxx",
                  "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
                 }
      	       ],
            "canCreateBot": true,
            "isDeveloper": true
        }
	]
}
'

샘플 응답

성공 사례의 경우:

{
        "msg": "Users are updated Successfully"
    };

On this Page