Creates an instance of the ResourceActionsApi.
The configuration object for the Permit SDK.
The logger instance for logging.
Creates a new action.
The resource key.
The action data.
A promise that resolves to a ResourceActionRead object representing the created action.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Deletes a action based on the resource key and action key.
The resource key.
The action key.
A promise that resolves when the action 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 an action based on the resource key and the action key.
The resource key.
The action key.
A promise that resolves to a ResourceActionRead object representing the action.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves an action based on the resource ID and the action ID. Alias for the get method.
The resource ID.
The action ID.
A promise that resolves to a ResourceActionRead object representing the action.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves an action based on the resource key and the action key. Alias for the get method.
The resource key.
The action key.
A promise that resolves to a ResourceActionRead object representing the action.
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 all actions that are defined for a given resource.
pagination and filtering params,
A promise that resolves to an array of ResourceActionRead objects representing the actions.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Updates an existing action.
The resource key.
The key of the action to modify.
The data for updating the action.
A promise that resolves to a ResourceActionRead object representing the updated action.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Generated using TypeDoc
API client for interacting with the Resource Actions API.