Creates an instance of the TenantsApi.
The configuration object for the Permit SDK.
The logger instance for logging.
Creates a new tenant.
The data for the new tenant.
A promise that resolves to the created tenant.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Deletes a tenant.
The key of the tenant to delete.
A promise that resolves when the tenant is deleted.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Deletes a user from a given tenant (also removes all roles granted to the user in that tenant).
The key of the tenant from which the user will be deleted.
The key of the user to be deleted.
A promise that resolves when the user is successfully deleted.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Ensure that the API Key has the necessary permissions to successfully call the API endpoint. Note that this check is not foolproof, and the API may still throw 401.
The required API Key Access level for the endpoint.
PermitContextError If the currently set API key access level does not match the required access level.
Ensure that the API context matches the required endpoint context.
The required API context level for the endpoint.
PermitContextError If the currently set API context level does not match the required context level.
Retrieves a tenant by its key.
The key of the tenant.
A promise that resolves to the tenant.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves a tenant by its ID. Alias for the get method.
The ID of the tenant.
A promise that resolves to the tenant.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves a tenant by its key. Alias for the get method.
The key of the tenant.
A promise that resolves to the tenant.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves a list of tenants.
Optional params: IListTenantsParamsFiltering and pagination options,
A promise that resolves to an array of tenants.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves a list of users for a given tenant.
A promise that resolves to a PaginatedResultUserRead object containing the list of tenant users.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Updates a tenant.
The key of the tenant.
The updated data for the tenant.
A promise that resolves to the updated tenant.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Wait for the facts to be synchronized with the PDP. Available only when proxyFactsViaPdp is set to true.
The maximum number of seconds to wait for the synchronization to complete. Set to null to wait indefinitely.
Generated using TypeDoc
The TenantsApi class provides methods for interacting with Permit Tenants.