Creates an instance of the ResourceActionGroupsApi.
The configuration object for the Permit SDK.
The logger instance for logging.
Creates a new action group.
The resource key.
The action group data.
A promise that resolves to a ResourceActionGroupRead object representing the created action group.
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 group based on the resource key and group key.
The resource key.
The group key.
A promise that resolves when the action group 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 group based on the resource key and the group key.
The resource key.
The group key.
A promise that resolves to a ResourceActionGroupRead object representing the action group.
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 group based on the resource ID and the group ID. Alias for the get method.
The resource ID.
The group ID.
A promise that resolves to a ResourceActionGroupRead object representing the action group.
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 group based on the resource key and the group key. Alias for the get method.
The resource key.
The group key.
A promise that resolves to a ResourceActionGroupRead object representing the action group.
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 action groups that are defined for a given resource.
pagination and filtering params,
A promise that resolves to an array of ResourceActionGroupRead objects representing the action groups.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Updates an action group.
The resource key.
The group key.
The action group data.
A promise that resolves to a ResourceActionGroupRead object representing the updated action group.
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 Action Groups API.