Jump to

• Request
• Response
• Examples

Update a Permission Set.

put

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

Update a permission set of a repository.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Repository id parameter for permission sets.
• permissionSetId: string
  Id of the permission set.

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Updates a permission set with the given information in the payload. The fields createdBy, createdDate, updatedBy, updatedDate and links will be ignored even if given in the payload.

Root Schema : PermissionSet

Type: object

PermissionSet

Show Source

• contentPrivileges(optional): array contentPrivileges
  The privileges of content type.
• id(optional): string
  The id of the permission set.
• links(optional): array links
  Links
• principal(optional): object Principal
  Principal
• taxonomyPrivileges(optional): array taxonomyPrivileges
  The privileges of taxonomy.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the permission set."
        },
        "principal":{
            "description":"The principal.",
            "$ref":"#/definitions/Principal"
        },
        "contentPrivileges":{
            "type":"array",
            "description":"The privileges of content type.",
            "items":{
                "$ref":"#/definitions/ContentPrivilege"
            }
        },
        "taxonomyPrivileges":{
            "type":"array",
            "description":"The privileges of taxonomy.",
            "items":{
                "$ref":"#/definitions/TaxonomyPrivilege"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PermissionSet"
}

Nested Schema : contentPrivileges

Type: array

The privileges of content type.

Show Source

• Array of: object ContentPrivilege
  ContentPrivilege

{
    "type":"array",
    "description":"The privileges of content type.",
    "items":{
        "$ref":"#/definitions/ContentPrivilege"
    }
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Principal

Type: object

Principal

Show Source

• name(optional): string
• scope(optional): string
  Allowed Values: [ "CEC", "IDP" ]
• type(optional): string
  Allowed Values: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "scope":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    },
    "description":"Principal"
}

Nested Schema : taxonomyPrivileges

Type: array

The privileges of taxonomy.

Show Source

• Array of: object TaxonomyPrivilege
  TaxonomyPrivilege

{
    "type":"array",
    "description":"The privileges of taxonomy.",
    "items":{
        "$ref":"#/definitions/TaxonomyPrivilege"
    }
}

Nested Schema : ContentPrivilege

Type: object

ContentPrivilege

Show Source

• isEnabled(optional): boolean
  Whether the privilege is enabled under the context of a repository.
• isValid(optional): boolean
  The validness of the privilege.
• operations(optional): array operations
  Operations.
• typeDisplayName(optional): string
  The display name of the content type.
• typeId(optional): string
  The id of the content type.
• typeName(optional): string
  The name of the content type.

{
    "type":"object",
    "properties":{
        "typeId":{
            "type":"string",
            "description":"The id of the content type."
        },
        "typeName":{
            "type":"string",
            "description":"The name of the content type."
        },
        "typeDisplayName":{
            "type":"string",
            "description":"The display name of the content type."
        },
        "isValid":{
            "type":"boolean",
            "description":"The validness of the privilege."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Whether the privilege is enabled under the context of a repository."
        },
        "operations":{
            "type":"array",
            "description":"Operations.",
            "items":{
                "type":"string",
                "enum":[
                    "view",
                    "update",
                    "create",
                    "delete"
                ]
            }
        }
    },
    "description":"ContentPrivilege"
}

Nested Schema : operations

Type: array

Operations.

Show Source

• Array of: string
  Allowed Values: [ "view", "update", "create", "delete" ]

{
    "type":"array",
    "description":"Operations.",
    "items":{
        "type":"string",
        "enum":[
            "view",
            "update",
            "create",
            "delete"
        ]
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : TaxonomyPrivilege

Type: object

TaxonomyPrivilege

Show Source

• categoryId(optional): string
  The id of the category.
• isEnabled(optional): boolean
  Whether the privilege is enabled under the context of a repository.
• isForSiteManagement(optional): boolean
  Whether the taxonomy is for site management.
• isSiteCategory(optional): boolean
  Whether the category is a site category.
• isValid(optional): boolean
  The validness of the privilege.
• nodes(optional): array nodes
  The path of the category.
• operations(optional): array operations
  Operations.
• taxonomyId(optional): string
  The id of the taxonomy.
• taxonomyShortName(optional): string
  The short name of the taxonomy.

{
    "type":"object",
    "properties":{
        "taxonomyId":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "taxonomyShortName":{
            "type":"string",
            "description":"The short name of the taxonomy."
        },
        "isForSiteManagement":{
            "type":"boolean",
            "description":"Whether the taxonomy is for site management."
        },
        "categoryId":{
            "type":"string",
            "description":"The id of the category."
        },
        "nodes":{
            "type":"array",
            "description":"The path of the category.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        },
        "isSiteCategory":{
            "type":"boolean",
            "description":"Whether the category is a site category."
        },
        "isValid":{
            "type":"boolean",
            "description":"The validness of the privilege."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Whether the privilege is enabled under the context of a repository."
        },
        "operations":{
            "type":"array",
            "description":"Operations.",
            "items":{
                "type":"string",
                "enum":[
                    "view",
                    "categorize",
                    "createsite"
                ]
            }
        }
    },
    "description":"TaxonomyPrivilege"
}

Nested Schema : nodes

Type: array

The path of the category.

Show Source

• Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"The path of the category.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

Nested Schema : operations

Type: array

Operations.

Show Source

• Array of: string
  Allowed Values: [ "view", "categorize", "createsite" ]

{
    "type":"array",
    "description":"Operations.",
    "items":{
        "type":"string",
        "enum":[
            "view",
            "categorize",
            "createsite"
        ]
    }
}

Nested Schema : CategoryNodeBean

Type: object

Show Source

• apiName(optional): string
  The apiName of the Category node.
• id(optional): string
  The id of the Category node.
• name(optional): string
  The name of the Category node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : PermissionSet

Type: object

PermissionSet

Show Source

• contentPrivileges(optional): array contentPrivileges
  The privileges of content type.
• id(optional): string
  The id of the permission set.
• links(optional): array links
  Links
• principal(optional): object Principal
  Principal
• taxonomyPrivileges(optional): array taxonomyPrivileges
  The privileges of taxonomy.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the permission set."
        },
        "principal":{
            "description":"The principal.",
            "$ref":"#/definitions/Principal"
        },
        "contentPrivileges":{
            "type":"array",
            "description":"The privileges of content type.",
            "items":{
                "$ref":"#/definitions/ContentPrivilege"
            }
        },
        "taxonomyPrivileges":{
            "type":"array",
            "description":"The privileges of taxonomy.",
            "items":{
                "$ref":"#/definitions/TaxonomyPrivilege"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PermissionSet"
}

Nested Schema : contentPrivileges

Type: array

The privileges of content type.

Show Source

• Array of: object ContentPrivilege
  ContentPrivilege

{
    "type":"array",
    "description":"The privileges of content type.",
    "items":{
        "$ref":"#/definitions/ContentPrivilege"
    }
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Principal

Type: object

Principal

Show Source

• name(optional): string
• scope(optional): string
  Allowed Values: [ "CEC", "IDP" ]
• type(optional): string
  Allowed Values: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "scope":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    },
    "description":"Principal"
}

Nested Schema : taxonomyPrivileges

Type: array

The privileges of taxonomy.

Show Source

• Array of: object TaxonomyPrivilege
  TaxonomyPrivilege

{
    "type":"array",
    "description":"The privileges of taxonomy.",
    "items":{
        "$ref":"#/definitions/TaxonomyPrivilege"
    }
}

Nested Schema : ContentPrivilege

Type: object

ContentPrivilege

Show Source

• isEnabled(optional): boolean
  Whether the privilege is enabled under the context of a repository.
• isValid(optional): boolean
  The validness of the privilege.
• operations(optional): array operations
  Operations.
• typeDisplayName(optional): string
  The display name of the content type.
• typeId(optional): string
  The id of the content type.
• typeName(optional): string
  The name of the content type.

{
    "type":"object",
    "properties":{
        "typeId":{
            "type":"string",
            "description":"The id of the content type."
        },
        "typeName":{
            "type":"string",
            "description":"The name of the content type."
        },
        "typeDisplayName":{
            "type":"string",
            "description":"The display name of the content type."
        },
        "isValid":{
            "type":"boolean",
            "description":"The validness of the privilege."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Whether the privilege is enabled under the context of a repository."
        },
        "operations":{
            "type":"array",
            "description":"Operations.",
            "items":{
                "type":"string",
                "enum":[
                    "view",
                    "update",
                    "create",
                    "delete"
                ]
            }
        }
    },
    "description":"ContentPrivilege"
}

Nested Schema : operations

Type: array

Operations.

Show Source

• Array of: string
  Allowed Values: [ "view", "update", "create", "delete" ]

{
    "type":"array",
    "description":"Operations.",
    "items":{
        "type":"string",
        "enum":[
            "view",
            "update",
            "create",
            "delete"
        ]
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : TaxonomyPrivilege

Type: object

TaxonomyPrivilege

Show Source

• categoryId(optional): string
  The id of the category.
• isEnabled(optional): boolean
  Whether the privilege is enabled under the context of a repository.
• isForSiteManagement(optional): boolean
  Whether the taxonomy is for site management.
• isSiteCategory(optional): boolean
  Whether the category is a site category.
• isValid(optional): boolean
  The validness of the privilege.
• nodes(optional): array nodes
  The path of the category.
• operations(optional): array operations
  Operations.
• taxonomyId(optional): string
  The id of the taxonomy.
• taxonomyShortName(optional): string
  The short name of the taxonomy.

{
    "type":"object",
    "properties":{
        "taxonomyId":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "taxonomyShortName":{
            "type":"string",
            "description":"The short name of the taxonomy."
        },
        "isForSiteManagement":{
            "type":"boolean",
            "description":"Whether the taxonomy is for site management."
        },
        "categoryId":{
            "type":"string",
            "description":"The id of the category."
        },
        "nodes":{
            "type":"array",
            "description":"The path of the category.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        },
        "isSiteCategory":{
            "type":"boolean",
            "description":"Whether the category is a site category."
        },
        "isValid":{
            "type":"boolean",
            "description":"The validness of the privilege."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Whether the privilege is enabled under the context of a repository."
        },
        "operations":{
            "type":"array",
            "description":"Operations.",
            "items":{
                "type":"string",
                "enum":[
                    "view",
                    "categorize",
                    "createsite"
                ]
            }
        }
    },
    "description":"TaxonomyPrivilege"
}

Nested Schema : nodes

Type: array

The path of the category.

Show Source

• Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"The path of the category.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

Nested Schema : operations

Type: array

Operations.

Show Source

• Array of: string
  Allowed Values: [ "view", "categorize", "createsite" ]

{
    "type":"array",
    "description":"Operations.",
    "items":{
        "type":"string",
        "enum":[
            "view",
            "categorize",
            "createsite"
        ]
    }
}

Nested Schema : CategoryNodeBean

Type: object

Show Source

• apiName(optional): string
  The apiName of the Category node.
• id(optional): string
  The id of the Category node.
• name(optional): string
  The name of the Category node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    }
}

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 update a permission set on a repository.

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

Example

This updates permission set of id 514E1A01602042FB992C74BB999F47A9 on 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.

/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets/514E1A01602042FB992C74BB999F47A9

Request Payload

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

Response Body

{
  "id": "514E1A01602042FB992C74BB999F47A9",
  "principal": {
    "name": "cecusername",
    "type": "user"
  },
  "contentPrivileges": [
    {
      "typeId": "EF4C64E6BF81419F9743A8A4348A69EB",
      "typeName": "Image",
      "isValid": true,
      "operations": [
        "view",
        "update",
        "create"
      ]
    },
    {
      "typeId": "B228AE0D8E2E41B8924C5B9FFBCAF039",
      "typeName": "TypeCCC",
      "isValid": true,
      "operations": [
        "view",
        "update",
        "create"
      ]
    },
    {
      "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/514E1A01602042FB992C74BB999F47A9",
      "rel": "self",
      "method": "PUT",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets/514E1A01602042FB992C74BB999F47A9",
      "rel": "canonical",
      "method": "PUT",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets/514E1A01602042FB992C74BB999F47A9",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top