v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB

User & Permission

Update the Field Permission

Replaces the PermissionField resource.

put/permissions/fields/{id}

Path parameters

idstring required

Resource identifier

Request body

fieldsVisiblestring[] required

This array should contains Field Identifiers. While POST or PUT, this array should contain every single value needed, while current values in the payload will replace existing ones.

fieldsEditablestring[] required

This array should contains Field Identifiers. While POST or PUT, this array should contain every single value needed, while current values in the payload will replace existing ones.

usersIdentifier[]

This object should contains a collection of user identifiers

Example request

{
  "fieldsVisible": [
    "name",
    "web_description"
  ],
  "fieldsEditable": [
    "name",
    "web_description"
  ],
  "users": [
    "johndoe",
    "janedoe"
  ],
  "description": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "name": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  }
}

Response

PermissionField resource updated

fieldsVisiblestring[]

This array should contains Field Identifiers.

fieldsEditablestring[]

This array should contains Field Identifiers.

dateCreatedstring date-time nullable

This is an ISO datetime

dateModifiedstring date-time nullable

This is an ISO datetime

idstring

This is the unique identifier of the resource

Example response

{
  "fieldsVisible": [
    "field_id_1",
    "field_id_2"
  ],
  "fieldsEditable": [
    "field_id_1",
    "field_id_2"
  ],
  "name": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "description": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "id": "identifier_example",
  "users": [
    {
      "id": "identifier_example"
    }
  ]
}