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.
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 environment.
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
Interface representing the Resource Attributes API.