HookSniffAPI.Api.SSO (hooksniff v1.0.0)

API calls for all endpoints tagged SSO.

Summary

Functions

sso_config_delete(connection, opts \\ [])

Delete SSO configuration

sso_config_get(connection, opts \\ [])

Get SSO configuration

sso_config_post(connection, opts \\ [])

Create/update SSO configuration

sso_test_post(connection, opts \\ [])

Test SSO connection

Functions

sso_config_delete(connection, opts \\ [])

@spec sso_config_delete(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Delete SSO configuration

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

sso_config_get(connection, opts \\ [])

@spec sso_config_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Get SSO configuration

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

sso_config_post(connection, opts \\ [])

@spec sso_config_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Create/update SSO configuration

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :body (SsoConfigPostRequest):

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

sso_test_post(connection, opts \\ [])

@spec sso_test_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Test SSO connection

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure