Jump to

• Request
• Response
• Examples

List Permission Sets

get

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

List permission sets of a repository.

Request

Path Parameters

• id: string
  Repository id parameter for permission sets.

Query Parameters

• limit(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the size of the result.

  Default Value: 100
• 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, first, last, prev, next
• offset(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the start index of the result.

  Default Value: 0
• totalResults(optional): boolean
  This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : PermissionSets

Type: object

PermissionSets

Show Source

• aggregationResults(optional): array aggregationResults
  Aggregation results.
• count(optional): integer(int32)
  Total number of records in the current response.
• hasMore(optional): boolean
  Check whether there are more pages to fetch.
• items(optional): array items
  Singular resources contained in the collection.
• limit(optional): integer(int32)
  Actual page size used by the server. This might not be the same as what the client requests.
• links(optional): array links
  Links of the resource.
• offset(optional): integer(int32)
  The actual index from which the singular resources are returned.
• pinned(optional): array pinned
  Pinned items. Shows items pinned at the top of search list
• scrollId(optional): string
  scrollId if the search resolved to a scroll search.
• totalResults(optional): integer(int32)
  Total number of rows that satisfy the client request (excluding the paging parameters.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/PermissionSet"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"PermissionSets"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object PermissionSet
  PermissionSet

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/PermissionSet"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested 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."
        }
    }
}

304 Response

Not modified.

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 list permission sets of a repository.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/repositories/{id}/permissionSets'

Example 1

This lists all permission sets of repository with id 0A84F4683E51409C84C0D4AF0C23F4CF.

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

Response Body

{
  "hasMore": false,
  "offset": 0,
  "count": 2,
  "limit": 2,
  "items": [
    {
      "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/514E1A01602042FB992C74BB999F47A9",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "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",
          "categoryId": "CEFC8C6C2AA245AB9F719FBE9C45D88A",
          "nodes": [
            {
              "id": "CEFC8C6C2AA245AB9F719FBE9C45D88A",
              "name": "Cat1",
              "apiName": "txm-c"
            }
          ],
          "isValid": true,
          "operations": [
            "view"
          ]
        },
        {
          "taxonomyId": "691B31CFB0F14381ACDF9E0CE0B63CD1",
          "taxonomyShortName": "TXM",
          "categoryId": "0EAC9A777E73415AA4BC3CDB61FBD59C",
          "nodes": [
            {
              "id": "0EAC9A777E73415AA4BC3CDB61FBD59C",
              "name": "Cat2",
              "apiName": "txm-c1"
            }
          ],
          "isValid": true,
          "operations": [
            "view",
            "categorize"
          ]
        }
      ],
      "links": [
        {
          "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets/3C1B236C10C54C80AA2ADDACCAFB1B4A",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets?offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets?offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

Example 2

This lists all permission sets of repository with id 8C2CF1B2EFE2446297825C4B869D2BF2, which happen to be the permissions sets for a granular security site's content viewer and contributor groups.

/content/management/api/v1.1/repositories/8C2CF1B2EFE2446297825C4B869D2BF2/permissionSets

Response Body

{
  "hasMore": false,
  "offset": 0,
  "count": 2,
  "limit": 2,
  "items": [
    {
      "id": "C5C6CE6503E04D71991C32B88535C8D7",
      "principal": {
        "name": "Site1_contributor",
        "type": "group",
        "scope": "CEC"
      },
      "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": []
        },
        {
          "taxonomyId": "AF6B75DBBCA244FC93166610EA2BA62A",
          "taxonomyShortName": "SST",
          "isForSiteManagement": true,
          "categoryId": "4136D8D1FD5C4241A3E08A42765D615C",
          "nodes": [
            {
              "id": "BE58B209A968480480AA2AFBCE9C2D64",
              "name": "org1",
              "apiName": "sst-o"
            },
            {
              "id": "F54C934D081B4768B3A93A45C0E6955C",
              "name": "team1",
              "apiName": "sst-o-d"
            },
            {
              "id": "4136D8D1FD5C4241A3E08A42765D615C",
              "name": "Site1_site_category",
              "apiName": "sst-o-t-s"
            }
          ],
          "isSiteCategory": true,
          "isValid": true,
          "operations": [
            "view",
            "categorize"
          ]
        }
      ],
      "links": [
        {
          "href": "http://<hostname>/content/management/api/v1.1/repositories/8C2CF1B2EFE2446297825C4B869D2BF2/permissionSets/C5C6CE6503E04D71991C32B88535C8D7",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "BF0F6132885D425688A58DD26D0EE1D8",
      "principal": {
        "name": "Site1_viewer",
        "type": "group",
        "scope": "CEC"
      },
      "contentPrivileges": [
        {
          "typeId": "",
          "typeName": null,
          "typeDisplayName": null,
          "isValid": true,
          "operations": [
            "view"
          ]
        }
      ],
      "taxonomyPrivileges": [
        {
          "taxonomyId": null,
          "taxonomyShortName": null,
          "isForSiteManagement": false,
          "categoryId": "",
          "nodes": null,
          "isSiteCategory": false,
          "isValid": true,
          "operations": []
        },
        {
          "taxonomyId": "AF6B75DBBCA244FC93166610EA2BA62A",
          "taxonomyShortName": "SST",
          "isForSiteManagement": true,
          "categoryId": "4136D8D1FD5C4241A3E08A42765D615C",
          "nodes": [
            {
              "id": "BE58B209A968480480AA2AFBCE9C2D64",
              "name": "org1",
              "apiName": "sst-o"
            },
            {
              "id": "F54C934D081B4768B3A93A45C0E6955C",
              "name": "team1",
              "apiName": "sst-o-d"
            },
            {
              "id": "4136D8D1FD5C4241A3E08A42765D615C",
              "name": "Site1_site_category",
              "apiName": "sst-o-t-s"
            }
          ],
          "isSiteCategory": true,
          "isValid": true,
          "operations": [
            "view"
          ]
        }
      ],
      "links": [
        {
          "href": "http://<hostname>/content/management/api/v1.1/repositories/8C2CF1B2EFE2446297825C4B869D2BF2/permissionSets/BF0F6132885D425688A58DD26D0EE1D8",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/8C2CF1B2EFE2446297825C4B869D2BF2/permissionSets",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/8C2CF1B2EFE2446297825C4B869D2BF2/permissionSets",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/8C2CF1B2EFE2446297825C4B869D2BF2/permissionSets",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/8C2CF1B2EFE2446297825C4B869D2BF2/permissionSets?offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/8C2CF1B2EFE2446297825C4B869D2BF2/permissionSets?offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}

Back to Top