Skip to main content
POST
Add 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, required environment Name, and AccessType``View (1). Email matching trims whitespace and normalises letter case; no default is declared.

Target user and pricing environment selected for a new view-access grant.

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

Configurable-entity access level to grant to 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

Created

Outcome of granting a user view access to a pricing environment.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PricingEnvironmentAccess.ApiProxyUserPricingEnvironmentAccessCreateResponse, 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.