View Source Auth0.Common.Management.Http (Auth0Api v2.2.0)

Documentation for Auth0 Management HTTP.

This module manages http request for Auth0 Management API.

Summary

Types

body()
config()
endpoint()
headers()
method()
multipart()
raw_response()
response()

Functions

delete(endpoint, config)

DELETE Auth0 management rest api.

delete(endpoint, body, config)

DELETE Auth0 management rest api. (with body)

get(endpoint, config)

GET Auth0 management rest api.

multipart_post(endpoint, multipart, config)

MULTIPART POST Auth0 management rest api.

patch(endpoint, body, config)

PATCH Auth0 management rest api.

post(endpoint, body, config)

POST Auth0 management rest api.

put(endpoint, body, config)

PUT Auth0 management rest api.

raw_request(method, endpoint, body \\ %{}, headers \\ nil, config \\ %Config{})

Request Auth0 management rest api simply.

Types

Link to this type

body()

View Source 
@type body() :: map() | list()
Link to this type

config()

View Source 
@type config() :: Auth0.Config.t()
Link to this type

endpoint()

View Source 
@type endpoint() :: String.t()
Link to this type

headers()

View Source 
@type headers() :: map()
Link to this type

method()

View Source 
@type method() :: :get | :post | :put | :patch | :delete | :options | :head
Link to this type

multipart()

View Source 
@type multipart() :: {:multipart, list()}
Link to this type

raw_response()

View Source 
@type raw_response() ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}
Link to this type

response()

View Source 
@type response() ::
  {:ok, integer(), String.t()} | {:error, integer(), term()} | {:error, term()}

Functions

Link to this function

delete(endpoint, config)

View Source 
@spec delete(endpoint(), config()) :: response()

DELETE Auth0 management rest api.

Link to this function

delete(endpoint, body, config)

View Source 
@spec delete(endpoint(), body(), config()) :: response()

DELETE Auth0 management rest api. (with body)

Link to this function

get(endpoint, config)

View Source 
@spec get(endpoint(), config()) :: response()

GET Auth0 management rest api.

Link to this function

multipart_post(endpoint, multipart, config)

View Source 
@spec multipart_post(endpoint(), multipart(), config()) :: response()

MULTIPART POST Auth0 management rest api.

Link to this function

patch(endpoint, body, config)

View Source 
@spec patch(endpoint(), body(), config()) :: response()

PATCH Auth0 management rest api.

Link to this function

post(endpoint, body, config)

View Source 
@spec post(endpoint(), body(), config()) :: response()

POST Auth0 management rest api.

Link to this function

put(endpoint, body, config)

View Source 
@spec put(endpoint(), body(), config()) :: response()

PUT Auth0 management rest api.

Link to this function

raw_request(method, endpoint, body \\ %{}, headers \\ nil, config \\ %Config{})

View Source 
@spec raw_request(method(), endpoint(), body(), headers(), config()) :: raw_response()

Request Auth0 management rest api simply.