# ApiKeyStoreContract > Tracon documentation. Tracon is a .NET package family that adds a control > plane on Microsoft Agent Framework, published as NuGet packages that run > inside your own ASP.NET Core application. > > Page: https://tracon.dev/api/tracon.testing.contracts.storage.apikeystorecontract/ > Summary: ApiKeyStoreContract: Behavior tests for the IApiKeyStore contract.
Namespace Tracon.Testing.Contracts.Storage ยท Assembly Tracon.Testing.Contracts.Xunit.dll
Behavior tests for the [IApiKeyStore](/api/tracon.iapikeystore/) contract. ```csharp public abstract class ApiKeyStoreContract : TenantIsolationContract, IAsyncLifetime, IAsyncDisposable ```
Inheritance
object โ† StoreCancellationContract<IApiKeyStore> โ† TenantIsolationContract<IApiKeyStore> โ† ApiKeyStoreContract
Implements
IAsyncLifetime, IAsyncDisposable
Inherited Members
TenantIsolationContract<IApiKeyStore>.TenantA, TenantIsolationContract<IApiKeyStore>.TenantB, TenantIsolationContract<IApiKeyStore>.UseAmbientTenant(MutableTenantContext), TenantIsolationContract<IApiKeyStore>.SeedAsync(string, string, CancellationToken), TenantIsolationContract<IApiKeyStore>.ExistsAsync(string, object), TenantIsolationContract<IApiKeyStore>.CountAsync(string, CancellationToken), TenantIsolationContract<IApiKeyStore>.TryDeleteAsync(string, object), TenantIsolationContract<IApiKeyStore>.TryOverwriteAsync(string, string), TenantIsolationContract<IApiKeyStore>.CancellableReadAsync(CancellationToken), TenantIsolationContract<IApiKeyStore>.CancellableWriteAsync(CancellationToken), TenantIsolationContract<IApiKeyStore>.WroteAnythingAsync(), TenantIsolationContract<IApiKeyStore>.Tenant_cannot_read_another_tenants_record(), TenantIsolationContract<IApiKeyStore>.Tenant_reads_its_own_record(), TenantIsolationContract<IApiKeyStore>.Tenant_does_not_see_another_tenants_record_in_the_list(), TenantIsolationContract<IApiKeyStore>.Tenant_cannot_delete_another_tenants_record(), TenantIsolationContract<IApiKeyStore>.Same_name_lives_independently_across_two_tenants(), TenantIsolationContract<IApiKeyStore>.AmbientTenant, StoreCancellationContract<IApiKeyStore>.CreateStoreAsync(), StoreCancellationContract<IApiKeyStore>.InitializeAsync(), StoreCancellationContract<IApiKeyStore>.DisposeAsync(), StoreCancellationContract<IApiKeyStore>.OnDisposeAsync(), StoreCancellationContract<IApiKeyStore>.CancellableReadAsync(CancellationToken), StoreCancellationContract<IApiKeyStore>.CancellableWriteAsync(CancellationToken), StoreCancellationContract<IApiKeyStore>.WroteAnythingAsync(), StoreCancellationContract<IApiKeyStore>.Canceled_token_throws_on_read(), StoreCancellationContract<IApiKeyStore>.The_write_this_contract_checks_can_be_read_back(), StoreCancellationContract<IApiKeyStore>.Canceled_token_throws_on_write_and_leaves_no_trace(), StoreCancellationContract<IApiKeyStore>.Store, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
## Remarks In this contract, the raw key value is visible only in the [ApiKeyCreationResult.PlaintextKey](/api/tracon.apikeycreationresult/#Tracon_ApiKeyCreationResult_PlaintextKey) returned by [IApiKeyStore.CreateAsync](/api/tracon.iapikeystore/#Tracon_IApiKeyStore_CreateAsync_Tracon_ApiKeyDraft_System_Threading_CancellationToken_); no read path ([IApiKeyStore.ListAsync](/api/tracon.iapikeystore/#Tracon_IApiKeyStore_ListAsync_System_String_System_Threading_CancellationToken_), [IApiKeyStore.FindByHashAsync](/api/tracon.iapikeystore/#Tracon_IApiKeyStore_FindByHashAsync_System_ReadOnlyMemory_System_Byte__System_Threading_CancellationToken_)) returns the raw value or its hash. ## Constructors ### ApiKeyStoreContract\(\) ```csharp protected ApiKeyStoreContract() ``` ## Methods ### Active\_scope\_is\_found\_system\_wide\(\) ```csharp [Fact] public Task Active_scope_is_found_system_wide() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Cannot\_revoke\_another\_tenants\_key\(\) ```csharp [Fact] public Task Cannot_revoke_another_tenants_key() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### CountAsync\(string, CancellationToken\) Reports how many records the given tenant sees through the listing endpoint. ```csharp protected override ValueTask CountAsync(string tenantId, CancellationToken cancellationToken) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The reading tenant. `cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) The token every store call inside the hook must be handed; see [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\> The number of records seen. ### ExistsAsync\(string, object\) Reports whether the record is visible from the given tenant's viewpoint. ```csharp protected override ValueTask ExistsAsync(string tenantId, object key) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The reading tenant. `key` [object](https://learn.microsoft.com/dotnet/api/system.object) The key returned by [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[bool](https://learn.microsoft.com/dotnet/api/system.boolean)\> [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the record is visible. ### Expiration\_is\_read\_back\(\) ```csharp [Fact] public Task Expiration_is_read_back() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Finding\_another\_tenants\_key\_by\_hash\_returns\_the\_correct\_tenant\(\) ```csharp [Fact] public Task Finding_another_tenants_key_by_hash_returns_the_correct_tenant() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Found\_by\_hash\_of\_the\_raw\_value\(\) ```csharp [Fact] public Task Found_by_hash_of_the_raw_value() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Last\_used\_timestamp\_is\_updated\(\) ```csharp [Fact] public Task Last_used_timestamp_is_updated() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Revoked\_key\_carries\_RevokedAt\_and\_appears\_inactive\(\) ```csharp [Fact] public Task Revoked_key_carries_RevokedAt_and_appears_inactive() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Revoked\_keys\_scope\_is\_no\_longer\_active\(\) ```csharp [Fact] public Task Revoked_keys_scope_is_no_longer_active() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Same\_key\_cannot\_be\_revoked\_twice\(\) ```csharp [Fact] public Task Same_key_cannot_be_revoked_twice() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### Saved\_key\_is\_read\_back\(\) ```csharp [Fact] public Task Saved_key_is_read_back() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task) ### SeedAsync\(string, string, CancellationToken\) Writes a sample record for the given tenant. ```csharp protected override ValueTask SeedAsync(string tenantId, string name, CancellationToken cancellationToken) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The tenant that owns the record. `name` [string](https://learn.microsoft.com/dotnet/api/system.string) The name distinguishing the record. The same name may be used by two tenants. `cancellationToken` [CancellationToken](https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken) The token every store call inside the hook must be handed. The cancellation contract calls this hook with a token that is already cancelled, so a hook that drops the token reports a store as sound when it is not. #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[object](https://learn.microsoft.com/dotnet/api/system.object)\> The key to use for reading the record back. ### TryDeleteAsync\(string, object\) Attempts to delete the record on behalf of the given tenant. ```csharp protected override ValueTask TryDeleteAsync(string tenantId, object key) ``` #### Parameters `tenantId` [string](https://learn.microsoft.com/dotnet/api/system.string) The tenant attempting the delete. `key` [object](https://learn.microsoft.com/dotnet/api/system.object) The key returned by [TenantIsolationContract.SeedAsync](/api/tracon.testing.contracts.storage/). #### Returns [ValueTask](https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask\-1)<[bool](https://learn.microsoft.com/dotnet/api/system.boolean)?\> [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the delete succeeded, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the record was not found; [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) if the store does not offer deletion. ### Unknown\_hash\_is\_not\_found\(\) ```csharp [Fact] public Task Unknown_hash_is_not_found() ``` #### Returns [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)