Struct okta::inline_hooks::InlineHooks

pub struct InlineHooks {
    pub client: Client,
}

Fields

client: Client

Implementations

impl InlineHooks

pub async fn list(&self, type_: &str) -> Result<Vec<InlineHook>>

This function performs a GET to the /api/v1/inlineHooks endpoint.

Success

Parameters:

• type_: &str

pub async fn list_all(&self, type_: &str) -> Result<Vec<InlineHook>>

This function performs a GET to the /api/v1/inlineHooks endpoint.

As opposed to list, this function returns all the pages of the request at once.

Success

pub async fn create(&self, body: &InlineHook) -> Result<InlineHook>

This function performs a POST to the /api/v1/inlineHooks endpoint.

Success

pub async fn get(&self, inline_hook_id: &str) -> Result<InlineHook>

This function performs a GET to the /api/v1/inlineHooks/{inlineHookId} endpoint.

Gets an inline hook by ID

Parameters:

• inline_hook_id: &str

pub async fn update(
    &self,
    inline_hook_id: &str,
    body: &InlineHook
) -> Result<InlineHook>

This function performs a PUT to the /api/v1/inlineHooks/{inlineHookId} endpoint.

Updates an inline hook by ID

Parameters:

• inline_hook_id: &str

pub async fn delete(&self, inline_hook_id: &str) -> Result<()>

This function performs a DELETE to the /api/v1/inlineHooks/{inlineHookId} endpoint.

Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

Parameters:

• inline_hook_id: &str

pub async fn execute(
    &self,
    inline_hook_id: &str,
    body: &Links
) -> Result<InlineHookResponse>

This function performs a POST to the /api/v1/inlineHooks/{inlineHookId}/execute endpoint.

Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

Parameters:

• inline_hook_id: &str

pub async fn activate(&self, inline_hook_id: &str) -> Result<InlineHook>

This function performs a POST to the /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate endpoint.

Activates the Inline Hook matching the provided id

Parameters:

• inline_hook_id: &str

pub async fn deactivate(&self, inline_hook_id: &str) -> Result<InlineHook>

This function performs a POST to the /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate endpoint.

Deactivates the Inline Hook matching the provided id

Parameters:

• inline_hook_id: &str