Skip to main content
POST
Remove pricing environment access.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

JSON request with ProxyUserEmail for an active other user in the caller's organisation, environment Name, and AccessType to remove. Email matching trims whitespace and normalises letter case; no default is declared.

Target user, pricing environment, and stated access level selected for removal.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PricingEnvironmentAccess.ApiProxyUserPricingEnvironmentAccessDeleteRequest, Derivitec.Web.Core
access_type
enum<string>

Existing configurable-entity access level to remove from the selected user.

Available options:
view,
edit,
owner,
blocked
proxy_user_email
string | null

Email address of the organisation user whose entity access is being changed.

Example:

"user@example.com"

name
string | null

Name of the entity to select within the request's entity category. The value must not be null or empty.

Example:

"Example entity"

Response

Returns the removal outcome in the response envelope, including target-user, environment, and access errors.

Outcome of removing a user's stated pricing-environment access.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PricingEnvironmentAccess.ApiProxyUserPricingEnvironmentAccessDeleteResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.