View Source OpenApiTypesense.Keys (OpenApiTypesense v0.2.1)
Provides API endpoints related to keys
Summary
Functions
Create an API Key
Delete an API key given its ID.
Retrieve (metadata about) a key
Retrieve (metadata about) all keys.
Functions
@spec create_key( OpenApiTypesense.ApiKeySchema.t(), keyword() ) :: {:ok, OpenApiTypesense.ApiKey.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Create an API Key
Create an API Key with fine-grain access control. You can restrict access on both a per-collection and per-action level. The generated key is returned only during creation. You want to store this key carefully in a secure place.
@spec create_key( OpenApiTypesense.Connection.t(), OpenApiTypesense.ApiKeySchema.t(), keyword() ) :: {:ok, OpenApiTypesense.ApiKey.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec delete_key( integer(), keyword() ) :: {:ok, OpenApiTypesense.ApiKeyDeleteResponse.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Delete an API key given its ID.
@spec delete_key(OpenApiTypesense.Connection.t(), integer(), keyword()) :: {:ok, OpenApiTypesense.ApiKeyDeleteResponse.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec get_key( integer(), keyword() ) :: {:ok, OpenApiTypesense.ApiKey.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieve (metadata about) a key
Retrieve (metadata about) a key. Only the key prefix is returned when you retrieve a key. Due to security reasons, only the create endpoint returns the full API key.
@spec get_key(OpenApiTypesense.Connection.t(), integer(), keyword()) :: {:ok, OpenApiTypesense.ApiKey.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec get_keys(keyword()) :: {:ok, OpenApiTypesense.ApiKeysResponse.t()} | :error
Retrieve (metadata about) all keys.
@spec get_keys( OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, OpenApiTypesense.ApiKeysResponse.t()} | :error