Update Policy

Updates a custom policy for project.

A policy is a reusable set of permissions (allow/deny rules over modules and actions). Policies are attached to roles; a user's effective permissions are the union of the policies on all their roles.

This endpoint updates the policy — only the fields you send are changed.

Updates a custom policy for project.

put

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

VersionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

Updates a custom policy for project.

correlationIdstringOptional

CorrelationId for each request

cultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstringOptional

TimeZone

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

envstringOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

idstring · nullableRequired

Public policy id, e.g. 'pol_database-read', from get_policies.

policyNamestring · nullableRequired

The policy's name — required; resend the current name to keep it.

descriptionstring · nullableOptional

Optional human-readable description of what the policy grants.

policyDocumentJsonstring · nullableOptional

AWS-IAM-style policy document as a raw JSON string (an object with a permission statement list) matching PolicyDocument.schema.json — this is a FULL replacement of the policy's current permissions.

Responses

200

Success

application/json

IdResponse

idstring · nullableOptional

statusstring · nullableOptional

put/{version}/membership/policies

PUT /{version}/membership/policies HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 195

{
  "id": "text",
  "policyName": "text",
  "description": "text",
  "policyDocumentJson": "text",
  "projectId": "text",
  "env": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "text",
  "version": "text"
}

200

Success

{
  "responseStatus": {
    "isSuccess": true
  },
  "id": "text",
  "status": "text"
}

In Cloud

Manage this visually in Cloud — see Membership → Policies.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Update Policy in the SDK reference, with examples in every language.