v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB

PermissionPolicy

Create Permission Policy

Create a new Permission Policy

NOTE: When you set up a policy statement for this call using the permissionPolicy request parameter to specify the effect, action, and resource, you must use all lower case and the format as shown in this example for a Permission Policy statement that grants full CRUD access to all meters:

"permissionPolicy" : [
	{
		"effect" : "allow",
		"action" : [
		"config:create",
		"config:delete",
		"config:retrieve",
		"config:update"
		]
		"resource" : [
		"config:meter/*"
		]
	}
]

For more details and further examples, see Understanding, Creating, and Managing Permission Policies in our main Documentation.

post/organizations/{orgId}/permissionpolicies

Path parameters

orgIdstring required

UUID of the organization

Request body

versioninteger

The version number of the entity:

Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.

namestring required

Response

Returns the new Permission Policy

idstring required

The UUID of the entity.

versioninteger

The version number:

Create: On initial Create to insert a new entity, the version is set at 1 in the response.
Update: On successful Update, the version is incremented by 1 in the response.

namestring

The name of the Permission Policy.

managedPolicyboolean

Indicates whether this is a system generated Managed Permission Policy.

dtCreatedstring date-time

The date and time (in ISO-8601 format) when the Permission Policy was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the Permission Policy was last modified.

createdBystring

The unique identifier (UUID) of the user who created this Permission Policy.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this Permission Policy.