cx_sdk::client::apikeys

Struct ApiKeysClient

source 
pub struct ApiKeysClient { /* private fields */ }
Expand description

The API Keys API client. Read more at https://coralogix.com/docs/api-keys/

Implementations§

source§

impl ApiKeysClient

source

pub fn new(auth_context: AuthContext, region: CoralogixRegion) -> Result<Self>

Creates a new client for the APIKeys API.

§Arguments
source

pub async fn create( &self, name: String, owner: Option<Owner>, presets: Vec<String>, permissions: Vec<String>, hashed: bool, ) -> Result<CreateApiKeyResponse>

Creates a new API Key

§Arguments
  • name - The name of the API key.
  • owner - The Owner of the API key.
  • presets - The presets of the API key.
  • permissions - The permissions of the API key.
  • hashed - Whether the API key should be encrypted.

Note that when the API key is hashed, it will not be possible to retrieve it later.

source

pub async fn update( &self, key_id: String, is_active: Option<bool>, new_name: Option<String>, presets: Option<Vec<String>>, permissions: Option<Vec<String>>, ) -> Result<UpdateApiKeyResponse>

Updates an API key.

§Arguments
  • key_id - The ID of the API key to update.
  • is_active - Whether the API key should be active.
  • new_name - The new name of the API key.
  • presets - The new presets of the API key.
  • permissions - The new permissions of the API key.
source

pub async fn delete(&self, key_id: String) -> Result<DeleteApiKeyResponse>

Deletes an API key.

§Arguments
  • key_id - The ID of the API key to delete.
source

pub async fn get(&self, key_id: String) -> Result<GetApiKeyResponse>

Retrieves an API key by its ID.

§Arguments
  • key_id - The ID of the API key to retrieve.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T