Cloudflare v0.2.0

Cloudflare.Organization (Cloudflare v0.2.0) View Source

Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.

Organizations

An Organization is an entity which holds a set of zones for multiple users to interact with.

Organization Details

GET Get information about a specific organization that you are a member of

GET organizations/:identifier

Permission needed: #organization:read

Available in:

  • ENTERPRISE

Edit Organization

PATCH Update an existing Organization

PATCH organizations/:identifier

Permission needed: #organization:edit

Available in:

  • ENTERPRISE

Link to this section Summary

Functions

client(opts \\ [])
path_for(id, opts \\ [])
show(id, opts \\ [])
show!(id, opts \\ [])
update(id, body, opts \\ [])
update!(id, 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(id, opts \\ [])

View Source

Specs

show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.result()
Link to this function

show!(id, opts \\ [])

View Source

Specs

show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.t() | no_return()
Link to this function

update(id, body, opts \\ [])

View Source

Specs

update(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: Tesla.Env.result()
Link to this function

update!(id, body, opts \\ [])

View Source

Specs

update!(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: Tesla.Env.t() | no_return()