Knock.Tenants (Knock v0.4.18)
View SourceKnock 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
@spec delete(Knock.Client.t(), String.t()) :: Knock.Api.response()
Deletes the given tenant.
@spec get(Knock.Client.t(), String.t()) :: Knock.Api.response()
Gets the given tenant.
@spec 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
@spec set(Knock.Client.t(), String.t(), map()) :: Knock.Api.response()
Upserts the given tenant with the tenant data provided.