Membership'ler

Membership, izole bir kiracıdır: kullanıcıların, rollerin, uygulamaların ve diğer tüm kaynakların sahibidir ve kullanıcılarının kimlik doğrulama ayarlarını tutar. Bkz. Temel Kavramlar.

İlk membership kurulum sırasında oluşturulur. Sonraki membership'ler bu API ile oluşturulur.

Membership nesnesi#

{
	"_id": "66f1c0d2a4b5c6d7e8f90123",
	"name": "My Company",
	"slug": "my-company",
	"expires_in": 3600,
	"scoped_token_expires_in": 900,
	"refresh_token_expires_in": 86400,
	"reset_password_token_expires_in": 1800,
	"secret_key": "<at least 32 bytes>",
	"hash_algorithm": "ARGON2ID",
	"encoding": "UTF-8",
	"default_language": "en",
	"user_activation": "active",
	"code_policy": "tv-codes",
	"otp_settings": {
		"host": "https://app.example.com/reset-password",
		"policy": {
			"length": 6,
			"contains_letters": false,
			"contains_digits": true,
			"expires_in": 300,
			"max_attempts": 5
		}
	},
	"mail_providers": [
		{
			"type": "SmtpServer",
			"name": "Company SMTP",
			"slug": "company-smtp",
			"host": "smtp.example.com",
			"port": 587,
			"tls_enabled": true,
			"username": "no-reply@example.com",
			"password": "<password>"
		}
	],
	"sys": { "created_at": "2026-01-01T12:00:00Z", "created_by": "system" }
}

Parola hash algoritmaları#

Hızlı hash'ler (SHA, MD5), veritabanınız sızarsa kaba kuvvetle hızla kırılabilir. Başka bir sistemden parola hash'i aktarmıyorsanız ARGON2ID'yi tercih edin.

Değerler alt çizgiyle de kabul edilir (SHA2_512).

Mail sağlayıcıları#

mail_providers, membership'in e-posta gönderebileceği servislerin listesidir. Bir mail hook bunlardan birine slug'ıyla başvurur.

"mail_providers": [
	{ "type": "SendGrid", "name": "SendGrid", "slug": "sendgrid", "apiKey": "<api_key>" },
	{ "type": "MailChimp", "name": "Mandrill", "slug": "mandrill", "apiKey": "<api_key>" }
]

type büyük/küçük harfe duyarlıdır.

Endpoint'ler#

Membership route'ları kurulum genelidir: çağıranın token'ının membership'ine bağlı değildir.

Membership getirme#

GET /memberships/{id}
Authorization: Bearer <access_token>

{id} id ya da slug olabilir. Membership yoksa 404 MembershipNotFound döner.

Listeleme, sorgulama ve arama#

GET /memberships, POST /memberships/_query ve GET /memberships/search?keyword=, API Kuralları sayfasında anlatıldığı gibi çalışır.

Membership oluşturma#

curl -X POST https://auth.example.com/memberships \
	-H 'Authorization: Bearer <access_token>' \
	-H 'Content-Type: application/json' \
	-d '{
		"name": "Mobile App",
		"expires_in": 3600,
		"refresh_token_expires_in": 2592000,
		"secret_key": "<random string of at least 32 bytes>",
		"hash_algorithm": "ARGON2ID",
		"encoding": "UTF-8"
	}'

Secret key'i güvenli bir rastgele üreticiyle oluşturun, örneğin openssl rand -base64 48.

Yanıt 201 Created: membership.

Yeni membership boştur. Ona erişebilen bir token'la, endpoint'leri üzerinden bir admin rolü, bir kullanıcı tipi ve ilk kullanıcıları oluşturun; tamamen yeni bir kiracı için ise ayrı bir kurulum ve kurulum adımlarını kullanın.

Membership güncelleme#

PUT /memberships/{id}

Gövde, oluşturma isteğiyle aynı alanlara sahiptir; güncellenen kayıt route'taki id'dir, gövdedeki _id yok sayılır.

Şu alanlar verilmediğinde (ya da boş veya 0 olduğunda) mevcut değerlerini korur: name, secret_key, hash_algorithm, encoding, expires_in ve refresh_token_expires_in. Diğer tüm alanlar gönderdiğinizle değiştirilir: mail_providers, otp_settings, code_policy, user_activation, default_language, scoped_token_expires_in ya da reset_password_token_expires_in gönderilmezse temizlenir. Önce membership'i okuyun ve değişikliklerinizle birlikte geri gönderin.

Membership silme#

DELETE /memberships/{id}

204 No Content döner. Hâlâ kaynakları (kullanıcılar, roller, uygulamalar…) olan bir membership silinemez: 409 MembershipCouldNotDeleted.

Ayarlar#

GET /memberships/settings, bir membership'in kullanabileceği değerleri tek yanıtta döner:

{
	"encodings": [ { "displayName": "Unicode (UTF-8)", "name": "UTF-8" } ],
	"defaultEncoding": "UTF-8",
	"hashAlgorithms": [ "MD5", "SHA1", "SHA2-224", "SHA2-256", "SHA2-384", "SHA2-512", "SHA2-512-224", "SHA2-512-256", "SHA3-224", "SHA3-256", "SHA3-384", "SHA3-512", "ARGON2ID", "PBKDF2-SHA256", "PBKDF2-SHA512" ],
	"defaultHashAlgorithm": "ARGON2ID",
	"dbLocales": [ { "Name": "None", "ISO6391Code": "none" }, { "Name": "Turkish", "ISO6391Code": "tr" } ],
	"defaultDbLocale": "none"
}

Listeler tek tek de /memberships/settings/encodings, /hash-algorithms ve /db-locales altında, her biri bir /default endpoint'iyle birlikte sunulur. defaultHashAlgorithm önerilen algoritmadır; membership'in varsayılanı yoktur ve her zaman bir algoritma belirtmelidir.