Cloudflare v0.3.0

Cloudflare.User (Cloudflare v0.3.0) View Source

User

The currently logged in/authenticated User

User Details

GET

GET user

Permission needed: com.cloudflare.api.user.read

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Edit User

PATCH Edit part of your user details

PATCH user

Permission needed: com.cloudflare.api.user.update

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Link to this section Summary

Functions

client(opts \\ [])
path_for(id, opts \\ [])
show(opts \\ [])
show!(opts \\ [])
update(body, opts \\ [])
update!(body, opts \\ [])

Link to this section Functions

Link to this function

client(opts \\ [])

View Source

Specs

client(Restlax.Resource.action_options()) :: module()
Link to this function

path_for(id, opts \\ [])

View Source

Specs

path_for(term(), [{:action, String.t()}]) :: String.t()
Link to this function

show(opts \\ [])

View Source

Specs

show(opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}
Link to this function

show!(opts \\ [])

View Source

Specs

show!(opts :: Restlax.Resource.action_options()) :: map() | no_return()
Link to this function

update(body, opts \\ [])

View Source

Specs

update(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  {:ok, map()} | {:error, term()}
Link to this function

update!(body, opts \\ [])

View Source

Specs

update!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  map() | no_return()