EndPointBlank.Management.ManagedClients (end_point_blank_elixir v0.12.0)

Managed clients: client organizations you create (EndPointBlank.Management.Clients.create/3 with managed: true) and run for your customer until they claim them.

Act on one's applications, environments and credentials with EndPointBlank.Management.for_managed_client/2:

customer = EndPointBlank.Management.for_managed_client(mgmt, client_id)
{:ok, env} =
  EndPointBlank.Management.Environments.create(customer, %{
    name: "staging",
    domain: "staging.customer.example"
  })

{:ok, app} =
  EndPointBlank.Management.Applications.create(customer, %{
    name: "billing",
    environment_base_urls: %{env["id"] => "https://billing.staging.customer.example"}
  })

This module sends the claim invite that hands one over, and mints the portal sign-in link its owner uses until they claim it.

Summary

Functions

claim_invite(client, client_id, email, opts \\ [])

Emails email an invite to claim managed client client_id (POST /api/v1/clients/:client_id/claim_invites). Answers %{"client_id", "email", "sent_at", "expires_at"}. Refused with "client_not_managed" when the client is not an unclaimed managed client of yours. Options: idempotency_key:, and return_to:, a URL registered under your organization's claim return URLs that EndPointBlank sends the user's browser back to once they accept (refused with "return_to_not_registered" otherwise).

create_portal_session(client, client_id, opts \\ [])

Mints a single-use link that signs the owner of managed client client_id in to its EndPointBlank portal (POST /api/v1/clients/:client_id/portal_sessions). Answers %{"client_id", "url", "expires_at", "return_url"}, "return_url" being nil when none was given.

Functions

claim_invite(client, client_id, email, opts \\ [])

@spec claim_invite(EndPointBlank.Management.t(), String.t(), String.t(), keyword()) ::
  EndPointBlank.Management.result(map())

create_portal_session(client, client_id, opts \\ [])

@spec create_portal_session(EndPointBlank.Management.t(), String.t(), keyword()) ::
  EndPointBlank.Management.result(map())

The link expires 60 seconds after it is minted and works once, so mint it when the user clicks and redirect their browser to it; never render it into a page, log it or send it in an email. Options: return_url:, a URL registered under your organization's claim return URLs (byte for byte) that the portal links back to, and idempotency_key:.

Each call sends a new Idempotency-Key unless you pass one, and that is what you want: the answer is never replayed, so a key used before answers 409 "idempotency_replay_unavailable". Never reuse a key across clicks.

Refused with 404 "not_found" for a client that is not yours, and with 422 "client_not_managed" (not a managed client, or already claimed), "client_being_removed", "owner_email_missing" (set one with Clients.update/3) or "return_url_not_registered" (an empty string included).