계정에 사용자를 추가합니다
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱에 보안 및 제어 아래의 사용자 관리의 관리자 API 범위가 필요합니다.
POSThttps://{{host}}/api/public/users
참고 사항: 이 기능은 플랫폼의 v7.1에 도입되었습니다.
쿼리 매개 변수
| 매개 변수 | 설명 |
|---|---|
| host | 환경 URL(예: https://bots.kore.ai) |
본문 매개 변수
| 매개 변수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| users |
각 사용자에 대한 세부 정보 배열에는 사용자 이메일 ID, 사용자 이름, 사용자가 속할 그룹, 봇에 할당될 역할 및 권한이 포함됩니다
|
||||||||||||||||||||||||||||||||||||||||||
| sendEmail(선택 사항) | 계정 아래 사용자를 활성화하기 위해 활성화 링크를 포함한 사용자에게 이메일을 보내야 하는지를 결정합니다. true 또는 false로 설정합니다. 기본값은 "true"입니다. |
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
콘텐츠 유형 응답
application/json
샘플 요청
curl -X POST \
https://{{host}}/api/public/users \
-H 'Content-Type: application/json' \
-H 'auth: YOUR_JWT_ACCESS_TOKEN' \
-d '{
"users": [
{
"userInfo": {
"emailId": "deskkore1@gmail.com",
"orgUserId": "org assigned user id",
"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": [
"e-06b41cdd-7678-5394-b958-40ca5662f502"
],
"roles": [
{
"roleId": "5d9d8db30d54920a8df1e68b",
"botId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
},
{
"roleId": "5d9d920dabdc1e6e8ec99342",
"botId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
},
{
"roleId": "5bbcb20c8bfd33db440ec1d1"
},
{
"roleId": "5d9d8d930d54920a8df1e689"
}
],
"assignBotTasks": [
{
"botId": "st-xxx-xx-xxx-xxx-xxxx",
"dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
}
],
"canCreateBot": true,
"isDeveloper": true
}
]
}'
샘플 응답
- 성공 사례의 경우:
{ "msg": "Users are created Successfully" }; - 실패 사례:
{ "failedUserDetails": [ { "userInfo": { "emailId": "deskkore1", "firstName": "user1", "status": "failure", "reason": { "statusCode": 400, "status": 400, "customCode": 400, "errors": [ { "msg": "INVALID_EMAIL", "code": 400 } ], "_headers": {}, "message": "INVALID_EMAIL", "name": "BadRequest" } } } ] }