Class RoleAssignmentsApi

The RoleAssignmentsApi class provides methods for interacting with Role Assignments.

Hierarchy

  • BaseFactsPermitAPI
    • RoleAssignmentsApi

Implements

Constructors

Methods

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

    Parameters

    • requiredAccessLevel: ApiKeyLevel

      The required API Key Access level for the endpoint.

    Returns Promise<void>

    Throws

    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.

    Parameters

    • requiredContext: ApiContextLevel

      The required API context level for the endpoint.

    Returns Promise<void>

    Throws

    PermitContextError If the currently set API context level does not match the required context level.

  • 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 RoleAssignmentsApi

Generated using TypeDoc