Interface ITenantsApi

Hierarchy

  • IWaitForSync
    • ITenantsApi

Implemented by

Methods

  • Deletes a tenant.

    Parameters

    • tenantKey: string

      The key of the tenant to delete.

    Returns Promise<void>

    A promise that resolves when the tenant is deleted.

    Throws

    PermitApiError If the API returns an error HTTP status code.

    Throws

    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).

    Parameters

    • tenantKey: string

      The key of the tenant from which the user will be deleted.

    • userKey: string

      The key of the user to be deleted.

    Returns Promise<void>

    A promise that resolves when the user is successfully deleted.

    Throws

    PermitApiError If the API returns an error HTTP status code.

    Throws

    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.

    Parameters

    • timeout: null | number

      The maximum number of seconds to wait for the synchronization to complete. Set to null to wait indefinitely.

    Returns ITenantsApi

Generated using TypeDoc