Roles

Endpoint

Manajemen role dan izin (khusus admin)

List all roles with permissions

GET

https://api-chat.bara.my.id

/api/roles

Memerlukan izin agents.view.

List all roles with permissions › Responses

Daftar role beserta kode izin

object[]

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

Create a custom role

POST

https://api-chat.bara.my.id

/api/roles

Memerlukan izin agents.manage. Nama role sistem (admin, supervisor, agent) tidak dapat digunakan.

Create a custom role › Request Body

name

string · minLength: 1 · required

Nama role (akan dinormalisasi ke huruf kecil). Tidak boleh sama dengan nama role sistem.

permissions

string[] · required

Daftar kode izin yang akan diberikan ke role ini

description

string

Create a custom role › Responses

Role berhasil dibuat

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

Get a single role with permissions

GET

https://api-chat.bara.my.id

/api/roles/{id}

Memerlukan izin agents.view.

Get a single role with permissions › path Parameters

id

string · uuid · required

Get a single role with permissions › Responses

Detail role beserta kode izin

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

Delete a custom role

DELETE

https://api-chat.bara.my.id

/api/roles/{id}

Memerlukan izin agents.manage. Role sistem tidak dapat dihapus. Role yang masih digunakan agent tidak dapat dihapus.

Delete a custom role › path Parameters

id

string · uuid · required

Delete a custom role › Responses

Role berhasil dihapus

message

string

role_id

string · uuid

Update a role

PATCH

https://api-chat.bara.my.id

/api/roles/{id}

Memerlukan izin agents.manage. Role sistem tidak dapat diubah namanya. Permissions diganti sepenuhnya (replace).

Update a role › path Parameters

id

string · uuid · required

Update a role › Request Body

name

string

Tidak dapat diubah untuk role sistem

description

string

permissions

string[]

Menggantikan seluruh daftar izin role (replace, bukan merge)

Update a role › Responses

Role berhasil diperbarui

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

List all available permissions

GET

https://api-chat.bara.my.id

/api/permissions

Mengembalikan seluruh izin yang tersedia, diurutkan berdasarkan kategori dan kode. Memerlukan izin agents.view.

List all available permissions › Responses

Daftar izin yang tersedia

object[]

id

string · uuid · required

code

string · required

Kode izin dalam format category.action, misal: campaigns.manage

name

string · required

description

string · required

category

string · required

Webhooks API Keys

OmniStream CRM API

Roles

Endpoint

Manajemen role dan izin (khusus admin)

List all roles with permissions

GET

https://api-chat.bara.my.id

/api/roles

Memerlukan izin agents.view.

List all roles with permissions › Responses

Daftar role beserta kode izin

object[]

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

Create a custom role

POST

https://api-chat.bara.my.id

/api/roles

Memerlukan izin agents.manage. Nama role sistem (admin, supervisor, agent) tidak dapat digunakan.

Create a custom role › Request Body

name

string · minLength: 1 · required

Nama role (akan dinormalisasi ke huruf kecil). Tidak boleh sama dengan nama role sistem.

permissions

string[] · required

Daftar kode izin yang akan diberikan ke role ini

description

string

Create a custom role › Responses

Role berhasil dibuat

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

Get a single role with permissions

GET

https://api-chat.bara.my.id

/api/roles/{id}

Memerlukan izin agents.view.

Get a single role with permissions › path Parameters

id

string · uuid · required

Get a single role with permissions › Responses

Detail role beserta kode izin

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

Delete a custom role

DELETE

https://api-chat.bara.my.id

/api/roles/{id}

Memerlukan izin agents.manage. Role sistem tidak dapat dihapus. Role yang masih digunakan agent tidak dapat dihapus.

Delete a custom role › path Parameters

id

string · uuid · required

Delete a custom role › Responses

Role berhasil dihapus

message

string

role_id

string · uuid

Update a role

PATCH

https://api-chat.bara.my.id

/api/roles/{id}

Memerlukan izin agents.manage. Role sistem tidak dapat diubah namanya. Permissions diganti sepenuhnya (replace).

Update a role › path Parameters

id

string · uuid · required

Update a role › Request Body

name

string

Tidak dapat diubah untuk role sistem

description

string

permissions

string[]

Menggantikan seluruh daftar izin role (replace, bukan merge)

Update a role › Responses

Role berhasil diperbarui

id

string · uuid · required

name

string · required

description

string · required

is_system

boolean · required

Role bawaan sistem tidak dapat dihapus atau diubah namanya

created_at

string · date-time · required

updated_at

string · date-time · required

permissions

string[]

Daftar kode izin yang dimiliki role ini

List all available permissions

GET

https://api-chat.bara.my.id

/api/permissions

Mengembalikan seluruh izin yang tersedia, diurutkan berdasarkan kategori dan kode. Memerlukan izin agents.view.

List all available permissions › Responses

Daftar izin yang tersedia

object[]

id

string · uuid · required

code

string · required

Kode izin dalam format category.action, misal: campaigns.manage

name

string · required

description

string · required

category

string · required

Webhooks API Keys