계정에서 사용할 수 있는 봇 또는 관리자 역할 목록을 검색합니다.
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱은 역할 관리 아래에 있는 역할 관리의 관리자 API 범위가 필요합니다.
GET https://{{host}}/api/public/roles?roleType=bot&limit=2
쿼리 매개 변수
매개 변수 | 필수/선택 사항 | 설명 |
---|---|---|
host | 필수 | 환경 URL(예: https://bots.kore.ai) |
roleType | 필수 |
역할 유형:
|
limit | 선택 사항 | 가져올 레코드 수입니다. 적용할 수 있는 최대 한도는 50입니다. |
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다: auth: {{JWT}}
콘텐츠 유형 응답
application/json
샘플 요청
curl -X GET \ 'https://{{host}}/api/public/roles?roleType=bot&limit=2' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
샘플 응답
{ "total": 2, "availableMore": false, "roles": [ { "roleType": "admin", "role": "admin", "rDesc": "Master administration role with full control on account activity", "permissions": { "Invite": "YES", "Import Users / Sync": "YES", "Directory Sync": "YES", "Manage User Profile Fields": "YES", "Manage Groups": "YES", "Manage Deployment": "YES", "Enterprise Bots": "YES", "Password Policies": "YES", "Single Sign On": "YES", "Domain Management": "YES", "Kore.ai Connector": "YES", "Manage Built-In Admin Roles": "YES", "Manage Custom Admin Roles": "YES", "View and Run Audit Reports": "YES", "Consumer Bots": "YES", "View and Run Bot Chat History": "YES", "Manage Bot Roles": "YES", "Preferences": "YES", "Smart Bots": "YES", "API Scopes": "YES", "Enterprise Key": "YES" } }, { "roleType": "admin", "role": "sample admin", "permissions": { "Invite": "YES", "Import Users / Sync": "NO", "Directory Sync": "NO", "Manage User Profile Fields": "YES", "Manage Groups": "YES", "Manage Deployment": "YES", "Enterprise Bots": "YES", "Smart Bots": "YES", "Preferences": "YES", "Single Sign On": "YES", "Kore.ai Connector": "YES", "Manage Built-In Admin Roles": "YES", "Manage Bot Roles": "YES", "Manage Custom Admin Roles": "YES", "View and Run Audit Reports": "YES", "View and Run Bot Chat History": "YES", "Consumer Bots": "YES", "API Scopes": "YES", "Enterprise Key": "YES" }, "rDesc": "" } ] }