機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

権限セットのリスト

get

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

リポジトリの権限セットをリストします。

リクエスト

パス・パラメータ

• id: string
  権限セットのリポジトリIDパラメータ。

問合せパラメータ

• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

  デフォルト値: 100
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby, first, 最後, prev, next
• offset(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。

  デフォルト値: 0
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : PermissionSets

型: object

PermissionSets

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

{
    "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"
}

ネストされたスキーマ : aggregationResults

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

ネストされたスキーマ: items

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object PermissionSet
  PermissionSet

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

ネストされたスキーマ: links

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

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

ネストされたスキーマ : AggregationResult

型: object

ソースを表示

• name(optional): string
  読取り専用: true

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

ネストされたスキーマ : PermissionSet

型: object

PermissionSet

ソースを表示

• contentPrivileges(optional): array contentPrivileges
  コンテンツ・タイプの権限。
• id(optional): string
  権限セットのID。
• links(optional): array links
  リンク
• principal(optional): object Principal
  プリンシパル
• taxonomyPrivileges(optional): array taxonomyPrivileges
  タクソノミの権限。

{
    "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"
}

ネストされたスキーマ : contentPrivileges

型: array

コンテンツ・タイプの権限。

ソースを表示

• Array of: object ContentPrivilege
  ContentPrivilege

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

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : プリンシパル

型: object

プリンシパル

ソースを表示

• name(optional): string
• scope(optional): string
  許容値: [ "CEC", "IDP" ]
• type(optional): string
  許容値: [ "user", "group" ]

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

ネストされたスキーマ : taxonomyPrivileges

型: array

タクソノミの権限。

ソースを表示

• Array of: object TaxonomyPrivilege
  TaxonomyPrivilege

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

ネストされたスキーマ : ContentPrivilege

型: object

ContentPrivilege

ソースを表示

• isEnabled(optional): boolean
  リポジトリのコンテキストで権限が有効かどうか。
• isValid(optional): boolean
  特権の有効性。
• operations(optional): array operations
  Operations
• typeDisplayName(optional): string
  コンテンツ・タイプの表示名。
• typeId(optional): string
  コンテンツ・タイプのID。
• typeName(optional): string
  コンテンツ・タイプの名前。

{
    "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"
}

ネストされたスキーマ: operations

型: array

Operations

ソースを表示

• Array of: string
  許容値: [ "view", "update", "create", "delete" ]

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

ネストされたスキーマ: Link

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

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

ネストされたスキーマ : TaxonomyPrivilege

型: object

TaxonomyPrivilege

ソースを表示

• categoryId(optional): string
  カテゴリのid。
• isEnabled(optional): boolean
  リポジトリのコンテキストで権限が有効かどうか。
• isForSiteManagement(optional): boolean
  タクソノミがサイト管理用かどうか。
• isSiteCategory(optional): boolean
  カテゴリがサイト・カテゴリかどうか。
• isValid(optional): boolean
  特権の有効性。
• nodes(optional): array nodes
  カテゴリのパス。
• operations(optional): array operations
  Operations
• taxonomyId(optional): string
  タクソノミのId。
• taxonomyShortName(optional): string
  タクソノミの短縮名。

{
    "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"
}

ネストされたスキーマ : nodes

型: array

カテゴリのパス。

ソースを表示

• Array of: object CategoryNodeBean

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

ネストされたスキーマ: operations

型: array

Operations

ソースを表示

• Array of: string
  許容値: [ "view", "categorize", "createsite" ]

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

ネストされたスキーマ : CategoryNodeBean

型: object

ソースを表示

• apiName(optional): string
  カテゴリ・ノードのapiName。
• id(optional): string
  カテゴリ・ノードのid。
• name(optional): string
  カテゴリ・ノードの名前。

{
    "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 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、リポジトリのアクセス権セットを一覧表示する方法を示しています。

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

例1

これは、IDが0A84F4683E51409C84C0D4AF0C23F4CFのリポジトリのすべての権限セットをリストします。

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

レスポンス本文

{
  "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"
    }
  ]
}

例2

これは、詳細なセキュリティ・サイト・コンテンツ・ビューアおよびコントリビュータ・グループの権限セットである、ID 8C2CF1B2EFE2446297825C4B869D2BF2のリポジトリのすべての権限セットをリストします。

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

レスポンス本文

{
  "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"
    }
  ]
}

先頭に戻る