Skip to content

UpsertAccessControlRuleRequest

HTTP API schema

← HTTP API reference

UpsertAccessControlRuleRequest fields

idstring

The ID of the access control rule to upsert on.

effectAccessControlRuleEffectRequired

effect: Reference AccessControlRuleEffect

operationstringRequired

The operation to grant access to. This could be a read, write, delete, etc. Please see the access controls list specification for all operations and their descriptions.

resourcestringRequired

The resource to grant access to. This could be an endpoint, a flow, a secret, etc. You can define this as either a class of resources, or a specific resource. Examples: - port1/principals/alice/endpoints/thermostat-zero grants access to that thermostat - port1/principals/alice/flows/* grants access to all flows owned by alice

identitystringRequired

The identity to grant access to. This could be a user, a role, a group, etc. You can define this as either a class of identities, or a specific identity. Examples: - port1/principals/bob grants access to bob - * just grants access to all identities

conditionsarray<AccessControlRuleCondition>

Conditions on the operation context that must all match for the rule to apply. Omitting conditions means the rule has none.

reasonstring

Optional operator-supplied reason recorded in the audit log for this change.

maxLength: 500

View source specification ↗