API anahtarları
`keys.list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete`, `rotate` ve `revoke`, ayrıca istek günlüğü ve etkinlik okuyucuları.
Her yöntem
const key = await openemail.keys.create({ name: 'Billing sender', scopes: ['emails:send'], domainAllowlist: ['billing.acme.com'], expiresInMinutes: 60 * 24 * 90,}) await store(key.token) await openemail.keys.update(key.id, { enabled: false })const rotated = await openemail.keys.rotate(key.id)await openemail.keys.revoke(key.id, { reason: 'Replaced' })await openemail.keys.delete(key.id)create ve rotate, token içinde bir kez gizli değer döndüren tek çağrılardır. Her okuma bunun yerine maskedKey döndürür. update bir anahtarı enabled ile kapatıp açar, bu revoke işleminin geri alınabilir alternatifidir; delete ise yalnızca iptal edilmiş bir anahtarı kaldırır. Okumak keys:read, her değişiklik keys:manage ister.
Asla çağırandan geniş değil
Bir anahtar kendisinden geniş bir anahtar asla oluşturmaz ve ona asla ulaşmaz: kapsamlar, rol, süre, mod ve gönderim kapsamı çağıran anahtarın içinde kalmalıdır, yoksa çağrı 403 beyond_caller_authority ile reddedilir. Bazı alan adlarına veya adreslere daraltılmış bir anahtar yalnızca kendi gönderim kapsamının içindeki anahtarları görür. Çağıran anahtar üzerindeki rotate, me.rotate() gibi keys:write ile de çalışır.
Ek doğrulama bir anahtarla yapılan çağrıya uygulanamaz, bu yüzden keys:manage kimlik bilgisi üreten bir kimlik bilgisidir. Onu yalnızca anahtar üreten bir otomasyona verin, o anahtara bir rol, bir gönderim kapsamı ve bir süre verin ve yaptığı her şeyin ona kaydedildiği listWorkspaceActivity çıktısını izleyin.
İstek günlüğü ve etkinlik
const failures = await openemail.keys.listRequests('4c1b257a66287fd113bd89d0', { failedOnly: true, since: new Date(Date.now() - 24 * 60 * 60 * 1000),}) for await (const change of openemail.keys.iterateWorkspaceActivity()) { console.log(change.keyName, change.type, change.actor?.label)}listRequests ve listActivity tek bir anahtarı, listWorkspaceRequests ve listWorkspaceActivity ise her anahtarı ya da keyIds içinde adı geçenleri okur ve her birinin yanında bir listAll… ve bir iterate… vardır. since ve until alırlar, istek okuyucuları ayrıca failedOnly alır.