Auth0Api v1.4.0

Auth0.Common.Management.Http (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management HTTP.

This module manages http request for Auth0 Management API.

Link to this section 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, config)

Request Auth0 management rest api simply.

Link to this section Types

Link to this type

body()

View Source

Specs

body() :: map() | list()
Link to this type

config()

View Source

Specs

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

endpoint()

View Source

Specs

endpoint() :: String.t()
Link to this type

headers()

View Source

Specs

headers() :: map()
Link to this type

method()

View Source

Specs

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

multipart()

View Source

Specs

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

raw_response()

View Source

Specs

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

response()

View Source

Specs

response() ::
  {:ok, integer(), String.t()} | {:error, integer(), term()} | {:error, term()}

Link to this section Functions

Link to this function

delete(endpoint, config)

View Source

Specs

delete(endpoint(), config()) :: response()

DELETE Auth0 management rest api.

Link to this function

delete(endpoint, body, config)

View Source

Specs

delete(endpoint(), body(), config()) :: response()

DELETE Auth0 management rest api. (with body)

Link to this function

get(endpoint, config)

View Source

Specs

get(endpoint(), config()) :: response()

GET Auth0 management rest api.

Link to this function

multipart_post(endpoint, multipart, config)

View Source

Specs

multipart_post(endpoint(), multipart(), config()) :: response()

MULTIPART POST Auth0 management rest api.

Link to this function

patch(endpoint, body, config)

View Source

Specs

patch(endpoint(), body(), config()) :: response()

PATCH Auth0 management rest api.

Link to this function

post(endpoint, body, config)

View Source

Specs

post(endpoint(), body(), config()) :: response()

POST Auth0 management rest api.

Link to this function

put(endpoint, body, config)

View Source

Specs

put(endpoint(), body(), config()) :: response()

PUT Auth0 management rest api.

Link to this function

raw_request(method, endpoint, body, headers, config)

View Source

Specs

raw_request(method(), endpoint(), body(), headers(), config()) :: raw_response()

Request Auth0 management rest api simply.