Kullanıcı Tipleri

Kullanıcı tipi, bir kullanıcı türünün şemasıdır. O tipteki kullanıcıların standart alanların ötesinde sahip olduğu alanları, tipleri ve doğrulama kurallarıyla birlikte tanımlar. Her kullanıcı oluşturma ve güncelleme, kullanıcının tipinin şemasına göre doğrulanır.

Kullanıcı tipleriyle, hiç kod değiştirmeden:

• özel alanlar ekleyebilir (telefon numarası, doğum tarihi, adres listesi, sadakat seviyesi…),
• alanları zorunlu, benzersiz ya da bir değer kümesiyle sınırlı yapabilir,
• bir tip hiyerarşisi kurabilir (Customer ve Employee'nin ikisi de Person'dan türer),
• bir back office'in şemadan form üretmesini sağlayabilirsiniz.

Kalıtım#

Kullanıcı tipleri baseType üzerinden birbirinden türer. Her zincir, tüm kullanıcıların standart alanlarını tanımlayan yerleşik base-user tipinde biter:

base-user abstract'tır: hiçbir kullanıcının tipi olamaz, her zaman kendi tiplerinizi oluşturursunuz. Veritabanında saklanmaz ve liste endpoint'i onu döndürmez, ama GET /user-types/all ve GET /user-types/base-user onu içerir.

base-user (abstract)
└── person (abstract)       + phone, birth_date
    ├── customer            + loyalty_tier, addresses
    └── employee (sealed)   + department, employee_no

Bir tip, atalarının tüm alanlarına ek olarak kendi alanlarına sahiptir.

Bir tip hem abstract hem sealed olamaz ve bir zincir kendi üzerine dönemez.

Kullanıcı tipi nesnesi#

{
	"_id": "66f1c0d2a4b5c6d7e8f90130",
	"name": "Customer",
	"slug": "customer",
	"description": "People who buy from us",
	"baseType": "person",
	"isAbstract": false,
	"isSealed": false,
	"allowAdditionalProperties": false,
	"properties": {
		"loyalty_tier": {
			"type": "enum",
			"displayName": "Loyalty Tier",
			"items": [
				{ "displayName": "Bronze", "value": "bronze" },
				{ "displayName": "Silver", "value": "silver" },
				{ "displayName": "Gold", "value": "gold" }
			],
			"defaultValue": "bronze"
		},
		"customer_no": {
			"type": "string",
			"isRequired": true,
			"isUnique": true,
			"regexPattern": "^C[0-9]{8}$"
		},
		"addresses": {
			"type": "array",
			"maxCount": 5,
			"itemSchema": {
				"type": "object",
				"properties": {
					"label": { "type": "string", "isRequired": true },
					"city": { "type": "string", "isRequired": true },
					"location": { "type": "location" }
				}
			}
		}
	},
	"membership_id": "66f1c0d2a4b5c6d7e8f90123",
	"sys": { "created_at": "2026-01-01T12:00:00Z", "created_by": "admin" }
}

Alanlar#

properties'in her girdisi bir alanı tanımlar. Anahtar, alanın kullanıcılarda görünen adıdır.

Ortak seçenekler#

Alan tipleri#

Temel tipler

Biçimli tipler

Tarih ve saat değerleri UTC olarak saklanır. Offset içermeyen bir datetime UTC olarak okunur.

Örnekler#

Bir telefon numarası:

"phone": {
	"type": "string",
	"displayName": "Phone",
	"maxLength": 20,
	"regexPattern": "^\\+?[0-9 ()-]{7,20}$"
}

Son yüzyıl içinde olması gereken bir doğum tarihi:

"birth_date": {
	"type": "date",
	"minValue": "1926-01-01"
}

Bir kümeden seçilen ilgi alanları listesi:

"interests": {
	"type": "enum",
	"isMultiple": true,
	"items": [
		{ "displayName": "Sports", "value": "sports" },
		{ "displayName": "Music", "value": "music" },
		{ "displayName": "Travel", "value": "travel" }
	]
}

Bir çalışanın yöneticisi; o da bir çalışan olmalıdır:

"manager": {
	"type": "reference",
	"referenceType": "single",
	"contentType": "employee"
}

Benzersiz alanlar#

Bir alan isUnique olarak işaretlendiğinde ErtisAuth onun için bir MongoDB unique index'i oluşturur:

• Benzersizlik, alanı benzersiz tanımlayan tipin ve ondan türeyen tiplerin kullanıcıları arasında, membership içinde kontrol edilir.
• Boş değerler sayılmaz: birçok kullanıcı benzersiz bir alanı boş bırakabilir.
• username ve email_address membership içinde benzersizdir.

Bir alanı benzersiz olarak işaretlediğinizde bazı kullanıcılar zaten aynı değeri paylaşıyorsa, kullanıcı tipi değişikliği tekrarlanan değeri belirten 409 UniqueFieldHasDuplicates hatasıyla reddedilir. Önce tekrarları temizleyin.

Tekrarlanan bir değerle yapılan kullanıcı yazma isteği, bir alan hatasıyla 400 ValidationException döner (bkz. Kullanıcılar).

Array öğelerinin içindeki benzersiz alanlar bir index'le değil, uygulama tarafından kontrol edilir.

Miras alınan alanları yeniden tanımlama#

Bir tip, temel tiplerinden birinin zaten tanımladığı bir alanı tanımlayamaz (400 SchemaValidationException, "field is already exist in base type"). İstisnası, türetilmiş tipte isVirtual: true ile tanımlanan bir alandır: type'ı miras alınanla aynı olduğu sürece kabul edilir (aksi halde 400 SchemaValidationException, "The field type cannot be overwritten on virtual fields").

Endpoint'ler#

Tüm route'lar /memberships/{membershipId} altındadır.

Kullanıcı tipi getirme#

GET /memberships/{membershipId}/user-types/{id}

Tipi, temel tiplerinden miras aldığı alanlarla birlikte döner.

Alan ilişkileri#

GET /memberships/{membershipId}/user-types/relations/customer

Bir tipin alanlarını, base-user'a kadar, onları tanımlayan tipe göre gruplar. Her seviye için bir bölüm içeren formlar oluşturmak için kullanışlıdır:

{
	"base-user": [ "firstname", "lastname", "username", "email_address", "role", "…" ],
	"person": [ "phone", "birth_date" ],
	"customer": [ "loyalty_tier", "customer_no", "addresses" ]
}

Kullanıcı tipi oluşturma#

curl -X POST https://auth.example.com/memberships/<membership_id>/user-types \
	-H 'Authorization: Bearer <access_token>' \
	-H 'Content-Type: application/json' \
	-d '{
		"name": "Employee",
		"baseType": "person",
		"isSealed": true,
		"properties": {
			"department": { "type": "string", "isRequired": true },
			"employee_no": { "type": "integer", "isUnique": true, "minimum": 1 }
		}
	}'

Yanıt 201 Created: kullanıcı tipi.

Kullanıcı tipi güncelleme#

PUT /memberships/{membershipId}/user-types/{id}

Gövde, oluşturma isteğiyle aynı alanlara sahiptir ve tipi tamamen değiştirir: yalnızca değişenleri değil, tipin kendi properties'inin tamamını gönderin.

• Mevcut kullanıcılar yeniden yazılmaz. Varsayılan değeri olmayan yeni bir zorunlu alan, mevcut kullanıcılar bir değer alana kadar onların sonraki güncellemelerinin başarısız olmasına yol açar; bu yüzden yeni zorunlu alanlara bir defaultValue verin ya da önce onları doldurun.
• Kullanımdaki bir tipin slug'ı (kullanıcılar ya da türetilmiş tipler tarafından) değişemez: kullanıcılar tiplerine slug ile başvurduğu için yeni slug yok sayılır.
• Hiçbir değişiklik içermeyen bir güncelleme 409 IdenticalDocumentError döner.

Kullanıcı tipi silme#

DELETE /memberships/{membershipId}/user-types/{id}

Yanıt 204 No Content. Hâlâ kullanıcıları ya da türetilmiş tipleri olan bir tip silinemez: 400 UserTypeCanNotBeDelete.

Olaylar#

UserTypeCreated, UserTypeUpdated ve UserTypeDeleted. Bkz. Olaylar.