Skip to content
Ideasoft
Admin API

UserRole

Serverhttps://your-store.myideasoft.com

UserRole LIST

GET
https://your-store.myideasoft.com
/admin-api/user_roles
Bearer
or
OAuth 2.0

UserRole LIST › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek User Roles adedi

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

q
​string

User Role arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

s
​string

Arama anahtarı ile filtreleme

UserRole LIST › Responses

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Rol adı.

Example: Yönetici
id
​integer

Kullanıcı rolü nesnesi kimlik değeri.

Example: 12
predefined
​integer · enum

Değiştirilemez kullanıcı rolü durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1

Role ait izinler listesi.

userCount
​integer

Role sahip kullanıcı sayısı.

Example: 4
createdAt
​string · date-time

Kullanıcı rolü nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kullanıcı rolü nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

UserRole POST

POST
https://your-store.myideasoft.com
/admin-api/user_roles
Bearer
or
OAuth 2.0

UserRole POST › Request Body

name
​string · maxLength: 255 · required

Rol adı.

Example: Yönetici
id
​integer

Kullanıcı rolü nesnesi kimlik değeri.

Example: 12
predefined
​integer · enum

Değiştirilemez kullanıcı rolü durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1

Role ait izinler listesi.

userCount
​integer

Role sahip kullanıcı sayısı.

Example: 4
createdAt
​string · date-time

Kullanıcı rolü nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kullanıcı rolü nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

UserRole POST › Responses

The create request (POST) completed successfully.

name
​string · maxLength: 255 · required

Rol adı.

Example: Yönetici
id
​integer

Kullanıcı rolü nesnesi kimlik değeri.

Example: 12
predefined
​integer · enum

Değiştirilemez kullanıcı rolü durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1

Role ait izinler listesi.

userCount
​integer

Role sahip kullanıcı sayısı.

Example: 4
createdAt
​string · date-time

Kullanıcı rolü nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kullanıcı rolü nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

UserRole COUNT

GET
https://your-store.myideasoft.com
/admin-api/user_roles/count
Bearer
or
OAuth 2.0

UserRole COUNT › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek User Roles adedi

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

q
​string

User Role arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

s
​string

Arama anahtarı ile filtreleme

UserRole COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


UserRole GET

GET
https://your-store.myideasoft.com
/admin-api/user_roles/{id}
Bearer
or
OAuth 2.0

UserRole GET › path Parameters

id
​string · pattern: \d+ · required

UserRole GET › Responses

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Rol adı.

Example: Yönetici
id
​integer

Kullanıcı rolü nesnesi kimlik değeri.

Example: 12
predefined
​integer · enum

Değiştirilemez kullanıcı rolü durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1

Role ait izinler listesi.

userCount
​integer

Role sahip kullanıcı sayısı.

Example: 4
createdAt
​string · date-time

Kullanıcı rolü nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kullanıcı rolü nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

UserRole PUT

PUT
https://your-store.myideasoft.com
/admin-api/user_roles/{id}
Bearer
or
OAuth 2.0

UserRole PUT › path Parameters

id
​string · pattern: \d+ · required

UserRole PUT › Request Body

name
​string · maxLength: 255 · required

Rol adı.

Example: Yönetici
id
​integer

Kullanıcı rolü nesnesi kimlik değeri.

Example: 12
predefined
​integer · enum

Değiştirilemez kullanıcı rolü durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1

Role ait izinler listesi.

userCount
​integer

Role sahip kullanıcı sayısı.

Example: 4
createdAt
​string · date-time

Kullanıcı rolü nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kullanıcı rolü nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

UserRole PUT › Responses

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Rol adı.

Example: Yönetici
id
​integer

Kullanıcı rolü nesnesi kimlik değeri.

Example: 12
predefined
​integer · enum

Değiştirilemez kullanıcı rolü durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1

Role ait izinler listesi.

userCount
​integer

Role sahip kullanıcı sayısı.

Example: 4
createdAt
​string · date-time

Kullanıcı rolü nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kullanıcı rolü nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

UserRole DELETE

DELETE
https://your-store.myideasoft.com
/admin-api/user_roles/{id}
Bearer
or
OAuth 2.0

UserRole DELETE › path Parameters

id
​string · pattern: \d+ · required

UserRole DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned