계정에서 모든 사용자 및 관련 역할에 대한 전체 정보를 가져옵니다.

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

GET https://{{host}}/api/public/alluserroles?

쿼리 매개 변수

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

권한 부여

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

콘텐츠 유형 응답

application/json

샘플 요청

curl -X GET \   
  https://{{host}}/api/public/alluserroles?limit=2' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

샘플 응답

{
    "total": 10,
    "availableMore": true,
    "users": [
        {
            "username": "<name>@kore.com",
            "orgUserId": "org assigned user id",
            "accountId": "<id>",
            "isDeveloper": true,
            "canCreateBot": true,
            "userId": "u-xxx-xxx-xxx-xxx-xxxxx",
            "btRoles": [],
            "adminRoles": []
        },
        {
            "username": "<name>@kore.com",
            "orgUserId": "org assigned user id",
            "accountId": "<id>",
            "isDeveloper": true,
            "canCreateBot": true,
            "userId": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "btRoles": [
                {
                    "roleId": "5c04ae921ad9976d311e9b50",
                    "roleName": "Bot Developer",
                    "groups": [],
                    "botId": "st-fd7c7396-82c1-5916-972d-6bfe6908b5ab",
                    "botName": "Example Bot"
                }
            ],
            "adminRoles": []
        }
    ]
}

アカウント内のすべてのユーザーおよびそれに関連するロールの完全な情報を取得します。

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

GET https://{{host}}/api/public/alluserroles?

クエリパラメータ

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

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ https://{{host}}/api/public/alluserroles?limit=2' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

サンプル応答

{ "total": 10, "availableMore": true, "users": [ { "username": "<name>@kore.com", "orgUserId": "org assigned user id", "accountId": "<id>", "isDeveloper": true, "canCreateBot": true, "userId": "u-xxx-xxx-xxx-xxx-xxxxx", "btRoles": [], "adminRoles": [] }, { "username": "<name>@kore.com", "orgUserId": "org assigned user id", "accountId": "<id>", "isDeveloper": true, "canCreateBot": true, "userId": "u-xxxxx-xxx-xxx-xxx-xxxxx", "btRoles": [ { "roleId": "5c04ae921ad9976d311e9b50", "roleName": "Bot Developer", "groups": [], "botId": "st-fd7c7396-82c1-5916-972d-6bfe6908b5ab", "botName": "Example Bot" } ], "adminRoles": [] } ] }

To get full information of all users and their associated roles in the account.

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/alluserroles?

Query Parameters

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

Authorization

Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X GET \   
  https://{{host}}/api/public/alluserroles?limit=2' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response

{
    "total": 10,
    "availableMore": true,
    "users": [
        {
            "username": "<name>@kore.com",
            "orgUserId": "org assigned user id",
            "accountId": "<id>",
            "isDeveloper": true,
            "canCreateBot": true,
            "userId": "u-xxx-xxx-xxx-xxx-xxxxx",
            "btRoles": [],
            "adminRoles": []
        },
        {
            "username": "<name>@kore.com",
            "orgUserId": "org assigned user id",
            "accountId": "<id>",
            "isDeveloper": true,
            "canCreateBot": true,
            "userId": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "btRoles": [
                {
                    "roleId": "5c04ae921ad9976d311e9b50",
                    "roleName": "Bot Developer",
                    "groups": [],
                    "botId": "st-fd7c7396-82c1-5916-972d-6bfe6908b5ab",
                    "botName": "Example Bot"
                }
            ],
            "adminRoles": []
        }
    ]
}