機械翻訳について

移動先

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

権限セットの読取り

get

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

リポジトリの権限セットを読み取ります。

リクエスト

パス・パラメータ

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

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : 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/{permissionSetId}'

例

これは、ID 0A84F4683E51409C84C0D4AF0C23F4CFのリポジトリとともにID 514E1A01602042FB992C74BB999F47A9の権限セットを読み取ります。

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

レスポンス本文

{
  "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"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/0A84F4683E51409C84C0D4AF0C23F4CF/permissionSets/514E1A01602042FB992C74BB999F47A9",
      "rel": "canonical",
      "method": "GET",
      "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"
    }
  ]
}

先頭に戻る