Knock.Tenants (Knock v0.4.13) View Source
Knock resources for accessing Tenants
Link to this section Summary
Functions
Deletes the given tenant.
Gets the given tenant.
Returns paginated tenants for environment
Upserts the given tenant with the tenant data provided.
Link to this section Functions
Specs
delete(Knock.Client.t(), String.t()) :: Knock.Api.response()
Deletes the given tenant.
Specs
get(Knock.Client.t(), String.t()) :: Knock.Api.response()
Gets the given tenant.
Specs
list(Knock.Client.t(), Keyword.t()) :: Knock.Api.response()
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
Specs
set(Knock.Client.t(), String.t(), map()) :: Knock.Api.response()
Upserts the given tenant with the tenant data provided.