Skip to content
Ideasoft
Admin API

User

Serverhttps://your-store.myideasoft.com

User LIST

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

User 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 Users adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

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. ids=1,2,3,4

sinceId
​integer · min: 1

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

q
​string

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

s
​string

Arama anahtarı ile filtreleme

User LIST › Responses

The request (GET or PUT) completed successfully.

id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
email
​string · email · maxLength: 255

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
password
​string · maxLength: 255 · writeOnly · pattern: (?=.*[0-9])(?=.*[A-Z…

Kullanıcının kimlik doğrulamasında kullanılan şifre (hashlenmiş olarak saklanır).

username
​string · minLength: 4 · maxLength: 16

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum

Kullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.

Enum values:
0
1
2
Example: 1
createdAt
​string · date-time

Kullanıcı hesabının oluşturulma zamanı.

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

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isCustomerRepresentative
​integer · enum

Kullanıcının müşteri temsilcisi olup olmadığını belirtir. Seçenekler: | 0: Müşteri temsilcisi değil. | 1: Müşteri temsilcisi.

Enum values:
0
1
Example: 0
isOwner
​integer · enum
Enum values:
0
1
​MemberGroupSummary[]

Kullanıcının üye olduğu gruplar; yetki ve erişim seviyelerini etkiler.

​UserRoleSummary
mfaStatus
​integer · enum
Enum values:
0
1

User POST

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

User POST › Request Body

id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
email
​string · email · maxLength: 255

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
password
​string · maxLength: 255 · writeOnly · pattern: (?=.*[0-9])(?=.*[A-Z…

Kullanıcının kimlik doğrulamasında kullanılan şifre (hashlenmiş olarak saklanır).

username
​string · minLength: 4 · maxLength: 16

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum

Kullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.

Enum values:
0
1
2
Example: 1
createdAt
​string · date-time

Kullanıcı hesabının oluşturulma zamanı.

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

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isCustomerRepresentative
​integer · enum

Kullanıcının müşteri temsilcisi olup olmadığını belirtir. Seçenekler: | 0: Müşteri temsilcisi değil. | 1: Müşteri temsilcisi.

Enum values:
0
1
Example: 0
isOwner
​integer · enum
Enum values:
0
1
​MemberGroupSummary[]

Kullanıcının üye olduğu gruplar; yetki ve erişim seviyelerini etkiler.

​UserRoleSummary
mfaStatus
​integer · enum
Enum values:
0
1

User POST › Responses

The create request (POST) completed successfully.

id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
email
​string · email · maxLength: 255

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
password
​string · maxLength: 255 · writeOnly · pattern: (?=.*[0-9])(?=.*[A-Z…

Kullanıcının kimlik doğrulamasında kullanılan şifre (hashlenmiş olarak saklanır).

username
​string · minLength: 4 · maxLength: 16

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum

Kullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.

Enum values:
0
1
2
Example: 1
createdAt
​string · date-time

Kullanıcı hesabının oluşturulma zamanı.

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

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isCustomerRepresentative
​integer · enum

Kullanıcının müşteri temsilcisi olup olmadığını belirtir. Seçenekler: | 0: Müşteri temsilcisi değil. | 1: Müşteri temsilcisi.

Enum values:
0
1
Example: 0
isOwner
​integer · enum
Enum values:
0
1
​MemberGroupSummary[]

Kullanıcının üye olduğu gruplar; yetki ve erişim seviyelerini etkiler.

​UserRoleSummary
mfaStatus
​integer · enum
Enum values:
0
1

User COUNT

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

User 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 Users adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

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. ids=1,2,3,4

sinceId
​integer · min: 1

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

q
​string

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

s
​string

Arama anahtarı ile filtreleme

User COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


User GET

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

User GET › path Parameters

id
​string · pattern: \d+ · required

User GET › Responses

The request (GET or PUT) completed successfully.

id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
email
​string · email · maxLength: 255

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
password
​string · maxLength: 255 · writeOnly · pattern: (?=.*[0-9])(?=.*[A-Z…

Kullanıcının kimlik doğrulamasında kullanılan şifre (hashlenmiş olarak saklanır).

username
​string · minLength: 4 · maxLength: 16

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum

Kullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.

Enum values:
0
1
2
Example: 1
createdAt
​string · date-time

Kullanıcı hesabının oluşturulma zamanı.

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

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isCustomerRepresentative
​integer · enum

Kullanıcının müşteri temsilcisi olup olmadığını belirtir. Seçenekler: | 0: Müşteri temsilcisi değil. | 1: Müşteri temsilcisi.

Enum values:
0
1
Example: 0
isOwner
​integer · enum
Enum values:
0
1
​MemberGroupSummary[]

Kullanıcının üye olduğu gruplar; yetki ve erişim seviyelerini etkiler.

​UserRoleSummary
mfaStatus
​integer · enum
Enum values:
0
1

User PUT

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

User PUT › path Parameters

id
​string · pattern: \d+ · required

User PUT › Request Body

id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
email
​string · email · maxLength: 255

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
password
​string · maxLength: 255 · writeOnly · pattern: (?=.*[0-9])(?=.*[A-Z…

Kullanıcının kimlik doğrulamasında kullanılan şifre (hashlenmiş olarak saklanır).

username
​string · minLength: 4 · maxLength: 16

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum

Kullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.

Enum values:
0
1
2
Example: 1
createdAt
​string · date-time

Kullanıcı hesabının oluşturulma zamanı.

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

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isCustomerRepresentative
​integer · enum

Kullanıcının müşteri temsilcisi olup olmadığını belirtir. Seçenekler: | 0: Müşteri temsilcisi değil. | 1: Müşteri temsilcisi.

Enum values:
0
1
Example: 0
isOwner
​integer · enum
Enum values:
0
1
​MemberGroupSummary[]

Kullanıcının üye olduğu gruplar; yetki ve erişim seviyelerini etkiler.

​UserRoleSummary
mfaStatus
​integer · enum
Enum values:
0
1

User PUT › Responses

The request (GET or PUT) completed successfully.

id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
email
​string · email · maxLength: 255

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
password
​string · maxLength: 255 · writeOnly · pattern: (?=.*[0-9])(?=.*[A-Z…

Kullanıcının kimlik doğrulamasında kullanılan şifre (hashlenmiş olarak saklanır).

username
​string · minLength: 4 · maxLength: 16

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum

Kullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.

Enum values:
0
1
2
Example: 1
createdAt
​string · date-time

Kullanıcı hesabının oluşturulma zamanı.

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

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isCustomerRepresentative
​integer · enum

Kullanıcının müşteri temsilcisi olup olmadığını belirtir. Seçenekler: | 0: Müşteri temsilcisi değil. | 1: Müşteri temsilcisi.

Enum values:
0
1
Example: 0
isOwner
​integer · enum
Enum values:
0
1
​MemberGroupSummary[]

Kullanıcının üye olduğu gruplar; yetki ve erişim seviyelerini etkiler.

​UserRoleSummary
mfaStatus
​integer · enum
Enum values:
0
1

User DELETE

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

User DELETE › path Parameters

id
​string · pattern: \d+ · required

User DELETE › Responses

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

No data returned