Keycloak.Admin (keycloak v1.1.0) View Source

This module is responsible for making calls to the Keycloak admin api.

Example

client = Keycloak.Client.new(token: "supersecret")

case Keycloak.Admin.get(client, "/") do
  {:ok, %O{body: body}} ->
    body
  {:error, %{body: body}} ->
    "#{inspect body}"
end

response = OAuth2.Client.get!(client, "/some/resource")

Link to this section Summary

Types

body()

headers()

result()

Functions

delete(client, url, body \\ "", params \\ [], headers \\ [{"content-type", "application/json"}], opts \\ [])

Makes an authorized DELETE request to url

get(client, url, params \\ [], headers \\ [], opts \\ [])

Makes an authorized GET request to url

new(client)

A simple wrapper around the current admin_client functionality.

post(client, url, body \\ "", params \\ [], headers \\ [{"content-type", "application/json"}], opts \\ [])

Makes an authorized POST request to url

put(client, url, body \\ "", params \\ [], headers \\ [{"content-type", "application/json"}], opts \\ [])

Makes an authorized PUT request to url

Link to this section Types

body()

Specs

body() :: OAuth2.Client.body()

headers()

Specs

headers() :: OAuth2.Client.headers()

result()

Specs

result() :: {:ok, OAuth2.Response.t()} | {:error, OAuth2.Response.t()}

Link to this section Functions

delete(client, url, body \\ "", params \\ [], headers \\ [{"content-type", "application/json"}], opts \\ [])

Specs

delete(
  OAuth2.Client.t(),
  String.t(),
  body(),
  Keyword.t(),
  headers(),
  Keyword.t()
) :: result()

Makes an authorized DELETE request to url

get(client, url, params \\ [], headers \\ [], opts \\ [])

Specs

get(OAuth2.Client.t(), String.t(), Keyword.t(), headers(), Keyword.t()) ::
  result()

Makes an authorized GET request to url

new(client)

A simple wrapper around the current admin_client functionality.

NOTE: This is a temporary fix for some missing functionality.

post(client, url, body \\ "", params \\ [], headers \\ [{"content-type", "application/json"}], opts \\ [])

Specs

post(OAuth2.Client.t(), String.t(), body(), Keyword.t(), headers(), Keyword.t()) ::
  result()

Makes an authorized POST request to url

put(client, url, body \\ "", params \\ [], headers \\ [{"content-type", "application/json"}], opts \\ [])

Specs

put(OAuth2.Client.t(), String.t(), body(), Keyword.t(), headers(), Keyword.t()) ::
  result()

Makes an authorized PUT request to url