Knock.Tenants (Knock v0.4.18)

View Source

Knock resources for accessing Tenants

Summary

Functions

Deletes the given tenant.

Gets the given tenant.

Returns paginated tenants for environment

Upserts the given tenant with the tenant data provided.

Functions

delete(client, id)

@spec delete(Knock.Client.t(), String.t()) :: Knock.Api.response()

Deletes the given tenant.

get(client, id)

Gets the given tenant.

list(client, options \\ [])

Returns paginated tenants for environment

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

- tenant_id: id of the tenant to filter for

- name: name of the tenant to filter for

set(client, id, tenant_data)

@spec set(Knock.Client.t(), String.t(), map()) :: Knock.Api.response()

Upserts the given tenant with the tenant data provided.