Create a Permission Set

post

/content/management/api/v1.1/repositories/{id}/permissionSets

Creates a permission set of the repository with the given payload.

Request

Supported Media Types
Path Parameters
Query Parameters
Header Parameters
Body ()
Creates a permission set with the given information in the payload. The fields id and links will be ignored even if given in the payload.
Root Schema : PermissionSet
Type: object
PermissionSet
Show Source
Nested Schema : contentPrivileges
Type: array
The privileges of content type.
Show Source
Nested Schema : Principal
Type: object
Principal
Show Source
Nested Schema : taxonomyPrivileges
Type: array
The privileges of taxonomy.
Show Source
Nested Schema : ContentPrivilege
Type: object
ContentPrivilege
Show Source
Nested Schema : operations
Type: array
Operations.
Show Source
Nested Schema : TaxonomyPrivilege
Type: object
TaxonomyPrivilege
Show Source
Nested Schema : nodes
Type: array
The path of the category.
Show Source
Nested Schema : operations
Type: array
Operations.
Show Source
Nested Schema : CategoryNodeBean
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

Created.
Body ()
Root Schema : PermissionSet
Type: object
PermissionSet
Show Source
Nested Schema : contentPrivileges
Type: array
The privileges of content type.
Show Source
Nested Schema : Principal
Type: object
Principal
Show Source
Nested Schema : taxonomyPrivileges
Type: array
The privileges of taxonomy.
Show Source
Nested Schema : ContentPrivilege
Type: object
ContentPrivilege
Show Source
Nested Schema : operations
Type: array
Operations.
Show Source
Nested Schema : TaxonomyPrivilege
Type: object
TaxonomyPrivilege
Show Source
Nested Schema : nodes
Type: array
The path of the category.
Show Source
Nested Schema : operations
Type: array
Operations.
Show Source
Nested Schema : CategoryNodeBean
Type: object
Show Source

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.
Back to Top

Examples

The following example shows how to create a permission set on a repository.

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/repositories/{id}/permissionSets'

Example 1

/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets
This creates a permission set for a user on the repository with id 0A84F4683E51409C84C0D4AF0C23F4CF. Replace payload with your own data.

Note:

The any type rule is defined by an empty typeId; and the any category rule is defined by an empty categoryId.

Request Payload

{
  "principal": {
    "name": "cecusername",
    "type": "user"
  },
  "contentPrivileges": [
    {
      "typeId": "",
      "typeName": "",
      "operations": [
        "view"
      ]
    },
    {
      "typeId": "49B267B515C84AD7903C5B9C34EDB09E",
      "typeName": "TypeAAA",
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    },
    {
      "typeId": "8CB7D974CBB74923BF40A6CA68BED145",
      "typeName": "TypeBBB",
      "operations": []
    }
  ],
  "taxonomyPrivileges": [
    {
      "taxonomyId": "",
      "categoryId": "",
      "operations": [
        "view"
      ]
    }
  ]
}

Response Body

{
  "id": "514E1A01602042FB992C74BB999F47A9",
  "principal": {
    "name": "cecusername",
    "type": "user"
  },
  "contentPrivileges": [
    {
      "typeId": "",
      "typeName": null,
      "isValid": true,
      "operations": [
        "view"
      ]
    },
    {
      "typeId": "49B267B515C84AD7903C5B9C34EDB09E",
      "typeName": "TypeAAA",
      "isValid": true,
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    },
    {
      "typeId": "8CB7D974CBB74923BF40A6CA68BED145",
      "typeName": "TypeBBB",
      "isValid": true,
      "operations": []
    }
  ],
  "taxonomyPrivileges": [
    {
      "taxonomyId": null,
      "taxonomyShortName": null,
      "isForSiteManagement": false,
      "categoryId": "",
      "nodes": null,
      "isSiteCategory": false,
      "isValid": true,
      "operations": [
        "view"
      ]
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "self",
      "method": "POST",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "canonical",
      "method": "POST",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ]
}

Example 2

/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets
This creates a permission set with a group on the repository with id 0A84F4683E51409C84C0D4AF0C23F4CF. Replace payload with your own data.

Note:

The any type rule is defined by an empty typeId; and the any category rule is defined by an empty categoryId.

Request Payload

{
  "principal": {
    "name": "cecgroupname",
    "type": "group",
    "scope": "CEC"
  },
  "contentPrivileges": [
    {
      "typeId": "",
      "typeName": "",
      "operations": [
        "view"
      ]
    },
    {
      "typeId": "EF4C64E6BF81419F9743A8A4348A69EB",
      "typeName": "Image",
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    }
  ],
  "taxonomyPrivileges": [
    {
      "taxonomyId": "",
      "categoryId": "",
      "operations": []
    },
    {
      "taxonomyId": "691B31CFB0F14381ACDF9E0CE0B63CD1",
      "categoryId": "CEFC8C6C2AA245AB9F719FBE9C45D88A",
      "operations": [
        "view"
      ]
    },
    {
      "taxonomyId": "691B31CFB0F14381ACDF9E0CE0B63CD1",
      "categoryId": "0EAC9A777E73415AA4BC3CDB61FBD59C",
      "operations": [
        "view",
        "categorize"
      ]
    }
  ]
}

Response Body

{
  "id": "3C1B236C10C54C80AA2ADDACCAFB1B4A",
  "principal": {
    "name": "cecgroupname",
    "type": "group",
    "scope": "CEC"
  },
  "contentPrivileges": [
    {
      "typeId": "",
      "typeName": null,
      "isValid": true,
      "operations": [
        "view"
      ]
    },
    {
      "typeId": "EF4C64E6BF81419F9743A8A4348A69EB",
      "typeName": "Image",
      "isValid": true,
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    }
  ],
  "taxonomyPrivileges": [
    {
      "taxonomyId": null,
      "taxonomyShortName": null,
      "isForSiteManagement": false,
      "categoryId": "",
      "nodes": null,
      "isSiteCategory": false,
      "isValid": true,
      "operations": []
    },
    {
      "taxonomyId": "691B31CFB0F14381ACDF9E0CE0B63CD1",
      "taxonomyShortName": "TXM",
      "isForSiteManagement": false,
      "categoryId": "CEFC8C6C2AA245AB9F719FBE9C45D88A",
      "nodes": [
        {
          "id": "CEFC8C6C2AA245AB9F719FBE9C45D88A",
          "name": "Cat1",
          "apiName": "txm-c"
        }
      ],
      "isSiteCategory": false,
      "isValid": true,
      "operations": [
        "view"
      ]
    },
    {
      "taxonomyId": "691B31CFB0F14381ACDF9E0CE0B63CD1",
      "taxonomyShortName": "TXM",
      "isForSiteManagement": false,
      "categoryId": "0EAC9A777E73415AA4BC3CDB61FBD59C",
      "nodes": [
        {
          "id": "0EAC9A777E73415AA4BC3CDB61FBD59C",
          "name": "Cat2",
          "apiName": "txm-c1"
        }
      ],
      "isSiteCategory": false,
      "isValid": true,
      "operations": [
        "view",
        "categorize"
      ]
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "self",
      "method": "POST",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "canonical",
      "method": "POST",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ]
}

Example 3

/content/management/api/v1.1/repositories/50109217E930462096BC76722F0AD739/permissionSets
This creates a permission set for a user on the repository with id 50109217E930462096BC76722F0AD739, which includes a taxonomy rule with createSite permission. Replace payload with your own data.

Note:

The any type rule is defined by an empty typeId; and the any category rule is defined by an empty categoryId.

Request Payload

{
  "principal": {
    "name": "cecuser2",
    "type": "user"
  },
  "contentPrivileges": [
    {
      "typeId": "",
      "typeName": "",
      "isValid": true,
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    }
  ],
  "taxonomyPrivileges": [
    {
      "taxonomyId": "",
      "categoryId": "",
      "isValid": true,
      "operations": [
        "view",
        "categorize"
      ]
    },
    {
      "taxonomyId": "AF6B75DBBCA244FC93166610EA2BA62A",
      "categoryId": "F54C934D081B4768B3A93A45C0E6955C",
      "isValid": true,
      "operations": [
        "view",
        "categorize",
        "createSite"
      ]
    }
  ]
}

Request Headers

{
  "Content-Type": "application/json",
  "X-Requested-With": "XMLHttpRequest"
}

Response Body

{
  "id": "68CE607F31614F2B84C542D87518F4D3",
  "principal": {
    "name": "cecuser2",
    "type": "user"
  },
  "contentPrivileges": [
    {
      "typeId": "",
      "typeName": null,
      "typeDisplayName": null,
      "isValid": true,
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    }
  ],
  "taxonomyPrivileges": [
    {
      "taxonomyId": null,
      "taxonomyShortName": null,
      "isForSiteManagement": false,
      "categoryId": "",
      "nodes": null,
      "isSiteCategory": false,
      "isValid": true,
      "operations": [
        "view",
        "categorize"
      ]
    },
    {
      "taxonomyId": "AF6B75DBBCA244FC93166610EA2BA62A",
      "taxonomyShortName": "SST",
      "isForSiteManagement": true,
      "categoryId": "F54C934D081B4768B3A93A45C0E6955C",
      "nodes": [
        {
          "id": "BE58B209A968480480AA2AFBCE9C2D64",
          "name": "org1",
          "apiName": "sst-o"
        },
        {
          "id": "F54C934D081B4768B3A93A45C0E6955C",
          "name": "team1",
          "apiName": "sst-o-d"
        }
      ],
      "isSiteCategory": false,
      "isValid": true,
      "operations": [
        "view",
        "categorize",
        "createSite"
      ]
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/50109217E930462096BC76722F0AD739/permissionSets",
      "rel": "self",
      "method": "POST",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/50109217E930462096BC76722F0AD739/permissionSets",
      "rel": "canonical",
      "method": "POST",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/50109217E930462096BC76722F0AD739/permissionSets",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}
Back to Top