Trait SecretService

pub trait SecretService {
    // Required methods
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateSecretRequest,
    ) -> Result<Secret, Error>;
    fn get(&self, auth_: BearerToken, rid: SecretRid) -> Result<Secret, Error>;
    fn get_batch(
        &self,
        auth_: BearerToken,
        request: GetSecretsRequest,
    ) -> Result<GetSecretsResponse, Error>;
    fn update(
        &self,
        auth_: BearerToken,
        rid: SecretRid,
        request: UpdateSecretRequest,
    ) -> Result<Secret, Error>;
    fn delete(&self, auth_: BearerToken, rid: SecretRid) -> Result<(), Error>;
    fn archive(&self, auth_: BearerToken, rid: SecretRid) -> Result<(), Error>;
    fn unarchive(&self, auth_: BearerToken, rid: SecretRid) -> Result<(), Error>;
    fn search(
        &self,
        auth_: BearerToken,
        request: SearchSecretsRequest,
    ) -> Result<SearchSecretsResponse, Error>;
}

The secrets service provides functionality for creating and retrieving customer secrets (e.g. influx passwords, API keys, etc)

Required Methods

fn create( &self, auth_: BearerToken, request: CreateSecretRequest, ) -> Result<Secret, Error>

Create a new secret. The secret value is immutable after creation.

fn get(&self, auth_: BearerToken, rid: SecretRid) -> Result<Secret, Error>

Get secret by rid.

fn get_batch( &self, auth_: BearerToken, request: GetSecretsRequest, ) -> Result<GetSecretsResponse, Error>

Get secrets by a set of rids.

fn update( &self, auth_: BearerToken, rid: SecretRid, request: UpdateSecretRequest, ) -> Result<Secret, Error>

Update a secret by rid.

fn delete(&self, auth_: BearerToken, rid: SecretRid) -> Result<(), Error>

Delete a secret by rid. This is a permanent deletion. To perform a soft delete, use the archive endpoint.

fn archive(&self, auth_: BearerToken, rid: SecretRid) -> Result<(), Error>

Archive a secret by rid.

fn unarchive(&self, auth_: BearerToken, rid: SecretRid) -> Result<(), Error>

Unarchive a secret by rid.

fn search( &self, auth_: BearerToken, request: SearchSecretsRequest, ) -> Result<SearchSecretsResponse, Error>

Returns metadata about secrets that match a given query.

Implementors