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