Knock.Tenants (Knock v0.4.5) 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

Deletes the given tenant.

Specs

Gets the given tenant.

Link to this function

list(client, options \\ [])

View Source

Specs

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

Link to this function

set(client, id, tenant_data)

View Source

Specs

Upserts the given tenant with the tenant data provided.