봇 빌더에 액세스하는 기능을 추가하거나 제거하려면 새 봇을 생성합니다.

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

GET https://{{host}}/api/public/useraccess

쿼리 매개 변수

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

본문 매개 변수

매개 변수 설명
emailIds 액세스 권한을 변경해야 하는 사용자 전자 메일 ID의 배열입니다(예: ["joe@kore.com", "amy@xyz.com"]).
canCreateBot 지정된 사용자가 봇 빌더 계정에 봇을 생성할 수 있는지를 결정합니다. true 또는 false로 설정합니다.
isDeveloper 지정된 사용자가 봇 빌더에 액세스할 수 있는지를 결정합니다. true 또는 false로 설정합니다.
hasDataTableAndViewAccess 지정된 사용자가 테이블과 보기를 생성할 수 있는지를 결정합니다. true 또는 false로 설정합니다.

권한 부여

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

콘텐츠 유형 응답

application/json

샘플 요청

curl -X POST \
  https://{{host}}/api/public/useraccess \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
"emailIds":["sample1@sampleemail.com"],
"canCreateBot":true,
"isDeveloper":true,
"hasDataTableAndViewAccess": true
}'

샘플 응답

  • 성공 사례의 경우:
    [
      “SUCCESS”
    ]
  • 잘못된 입력 조합: canCreateBot: true, isDeveloper: false
    { 
      "errors": [ 
          { 
            "msg": "Invalid values in the body", 
            "code": 403 
           } 
           ] 
     }
  • 제공된 이메일 주소 없음: emailIds [ ] is empty
    {
      "errors": [
          { "msg": "emailIds cannot be empty", 
            "code": 400 } 
       ] 
     }
  • 유효하지 않은 이메일 ID 또는 DB에 없는 이메일(계정과 연결된 이메일)
    {
      "errors": [
        { "msg": "One or more entered emails not found",
          "code": 400 }
        ]
     }
  • 하나 이상의 이메일이 다른 계정에 속해 있습니다
    {
      "errors": [ 
        { "msg": "Emails <> not associated with your account",
          "code": 400 }
        ]
     }

ボットビルダーへのアクセス機能を追加または削除し、新しいボットを作成します。

このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ロール管理] の [ロール管理] の管理APIスコープを必要とします。

GET https://{{host}}/api/public/useraccess

クエリパラメータ

パラメータ 説明
ホスト 環境URL(例: https://bots.kore.ai)

本文パラメータ

パラメータ 説明
emailIds アクセス権を変更しなければならないユーザーメールIDの配列(例:["joe@kore.com", "amy@xyz.com"])
canCreateBot 指定されたユーザーが、ボットビルダーのアカウントでボットを作成できるかどうかを判断します。TrueまたはFalseを設定します。
isDeveloper 指定されたユーザーがボットビルダーにアクセスできるかどうかを判断します。TrueまたはFalseを設定します。
hasDataTableAndViewAccess 指定されたユーザーがテーブルやビューを作成できるかどうかを判断します。TrueまたはFalseを設定します。

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ https://{{host}}/api/public/useraccess \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '{ "emailIds":["sample1@sampleemail.com"], "canCreateBot":true, "isDeveloper":true, "hasDataTableAndViewAccess": true }'

サンプル応答

  • 成功例:
    [ “SUCCESS” ]
  • Invalid input combination: canCreateBot: true, isDeveloper: false
    { "errors": [ { "msg": "Invalid values in the body", "code": 403 } ] }
  • No email addresses provided: emailIds [ ] is empty
    { "errors": [ { "msg": "emailIds cannot be empty", "code": 400 } ] }
  • 無効なメールID、またはDBに存在しないメールアドレス(アカウントに関連付けられているもの)
    { "errors": [ { "msg": "One or more entered emails not found", "code": 400 } ] }
  • 他のアカウントに属している1つ以上のメールID
    { "errors": [ { "msg": "Emails <> not associated with your account", "code": 400 } ] }

To add or remove the ability to access bot builder, create new bots.

This API requires JWT generated by an application created only from Bot Admin Console.
To use this API, app needs the Admin API Scope of Role Management under Role Management.

GET https://{{host}}/api/public/useraccess

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai

Body Parameters

Parameter Description
emailIds The array of user email Ids whose access permissions have to be changed, for example, [“joe@kore.com”, “amy@xyz.com”]
canCreateBot Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
isDeveloper Determines if the specified users can have access to Bot Builder. Set to true or false.
hasDataTableAndViewAccess Determines if the specified users can create tables and views. Set to true or false.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X POST \
  https://{{host}}/api/public/useraccess \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
"emailIds":["sample1@sampleemail.com"],
"canCreateBot":true,
"isDeveloper":true,
"hasDataTableAndViewAccess": true
}'

Sample Response

  • For success case:
    [
      “SUCCESS”
    ]
  • Invalid input combination: canCreateBot: true, isDeveloper: false
    { 
      "errors": [ 
          { 
            "msg": "Invalid values in the body", 
            "code": 403 
           } 
           ] 
     }
  • No email addresses provided: emailIds [ ] is empty
    {
      "errors": [
          { "msg": "emailIds cannot be empty", 
            "code": 400 } 
       ] 
     }
  • Invalid email id or any email which is not present in DB (Which is associated with the account)
    {
      "errors": [
        { "msg": "One or more entered emails not found",
          "code": 400 }
        ]
     }
  • One or more emailIds belong to other accounts
    {
      "errors": [ 
        { "msg": "Emails <> not associated with your account",
          "code": 400 }
        ]
     }