Auth0.Management.LogStreams (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of LogStreams.

endpoint

/api/v2/log_streams
/api/v2/log_streams/{id}

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

create(params, config)

Create a log stream.

delete(id, config)

Delete log stream.

get(id, config)

Get log stream by ID.

list(config)

Get log streams.

update(id, params, config)

Update a log stream.

Link to this section Types

config()

Specs

config() :: Auth0.Config.t()

error()

Specs

error() :: {:error, integer(), term()} | {:error, term()}

id()

Specs

id() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

create(params, config)

Specs

create(Auth0.Management.LogStreams.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.LogStream.t(), response_body()} | error()

Create a log stream.

see

https://auth0.com/docs/api/management/v2/#!/Log_Streams/post_log_streams

delete(id, config)

Specs

delete(id(), config()) :: {:ok, String.t(), response_body()} | error()

Delete log stream.

see

https://auth0.com/docs/api/management/v2/#!/Log_Streams/delete_log_streams_by_id

get(id, config)

Specs

get(id(), config()) ::
  {:ok, Auth0.Entity.LogStream.t(), response_body()} | error()

Get log stream by ID.

see

https://auth0.com/docs/api/management/v2/#!/Log_Streams/get_log_streams_by_id

list(config)

Specs

list(config()) :: {:ok, Auth0.Entity.LogStreams.t(), response_body()} | error()

Get log streams.

see

https://auth0.com/docs/api/management/v2/#!/Log_Streams/get_log_streams

update(id, params, config)

Specs

update(id(), Auth0.Management.LogStreams.Patch.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.LogStream.t(), response_body()} | error()

Update a log stream.

see

https://auth0.com/docs/api/management/v2/#!/Log_Streams/patch_log_streams_by_id