機械翻訳について

移動先

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

タクソノミへの権限の追加

post

/content/management/api/v1.1/taxonomies/{id}/permissions

リクエスト

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

• application/json

パス・パラメータ

• id: string
  タクソノミのId。

問合せパラメータ

• fields(optional): string
  このパラメータは、新しい権限に対して返されるフィールドを制御するために使用されます。 デフォルトでは、フィールドは返されません。

  許容値: [ "permissionId" ]

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内の指定された情報を持つ権限を追加します。 フィールドrole、emailおよびfullNameは、ペイロードで指定されている場合でも無視されます。

フィールドidは、共有するユーザーまたはグループの名前を表します。
フィールドroleNameによって、追加するロールが決まります。 使用可能な値は次のとおりです: manager, editor.
フィールドtypeは、ユーザーまたはグループのいずれであるかを決定します。
フィールドgroupTypeはオプションです。 指定しない場合、デフォルト値はCECです。
フィールドmessageはオプションです。 指定した場合、メッセージはEメール通知で送信されます。

ルート・スキーマ : ResourcePermissionCreate

型: object

ResourcePermissionCreate

ソースを表示

• email(optional): string
  ユーザーの電子メール。
• fullName(optional): string
  ユーザーの完全名。
• groupType(optional): string
  許容値: [ "CEC", "IDP" ]

  グループのタイプ。
• id(optional): string
  ユーザーのuserIdログイン名。
• links(optional): array links
  読取り専用: true

  リンク
• message(optional): string
• role(optional): object PermissionRole
  PermissionRole
• roleName(optional): string
  リソース上のロールの名前。 非推奨。 'role'プロパティに置き換えられます。
• type(optional): string
  許容値: [ "user", "group" ]

  ユーザーのタイプ。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"userId login name of the user."
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource. Deprecated. Replaced by the 'role' property."
        },
        "type":{
            "type":"string",
            "description":"type of the user.",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "description":"type of the group.",
            "enum":[
                "CEC",
                "IDP"
            ]
        },
        "message":{
            "type":"string"
        },
        "role":{
            "description":"role on the resource.",
            "$ref":"#/definitions/PermissionRole"
        },
        "email":{
            "type":"string",
            "description":"email of the user."
        },
        "fullName":{
            "type":"string",
            "description":"full name of the user."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ResourcePermissionCreate"
}

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

型: array

読取り専用: true

リンク

ソースを表示

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

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

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

型: object

PermissionRole

ソースを表示

• description(optional): string
  ロールの説明。 カスタムの編集ロールまたは公開ロールにのみ適用されます。
• id(optional): string
  ロールのID。 権限セット、カスタム編集ロールまたは公開ロールにのみ適用されます。
• links(optional): array links
  リンク
• name(optional): string
  ロールの名前。
• type(optional): string
  許容値: [ "standard", "custom", "editorial", "publishing" ]

  ロールのタイプ。 値は、'standard'、'custom'、'editorial'および'publishing'です。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the role. Only applicable to permission sets and custom editorial or publishing roles."
        },
        "name":{
            "type":"string",
            "description":"Name of the role."
        },
        "type":{
            "type":"string",
            "description":"Type of the role. Values are 'standard', 'custom', 'editorial', and 'publishing'.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "description":{
            "type":"string",
            "description":"Description of the role. Only applicable to custom editorial or publishing roles."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PermissionRole"
}

ネストされたスキーマ: 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."
}

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

型: array

リンク

ソースを表示

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

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

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : ResourcePermission

型: object

ResourcePermission

ソースを表示

• email(optional): string
  ユーザーの電子メール。
• fullName(optional): string
  ユーザーの完全名。
• groupType(optional): string
  許容値: [ "CEC", "IDP" ]

  グループのタイプ。
• id(optional): string
  ユーザーのuserIdログイン名。
• links(optional): array links
  読取り専用: true

  リンク
• role(optional): object PermissionRole
  PermissionRole
• roleName(optional): string
  リソース上のロールの名前。 非推奨。 'role'プロパティに置き換えられます。
• type(optional): string
  許容値: [ "user", "group" ]

  ユーザーのタイプ。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"userId login name of the user."
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource. Deprecated. Replaced by the 'role' property."
        },
        "role":{
            "description":"role on the resource.",
            "$ref":"#/definitions/PermissionRole"
        },
        "type":{
            "type":"string",
            "description":"type of the user.",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "description":"type of the group.",
            "enum":[
                "CEC",
                "IDP"
            ]
        },
        "email":{
            "type":"string",
            "description":"email of the user."
        },
        "fullName":{
            "type":"string",
            "description":"full name of the user."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ResourcePermission"
}

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

型: array

読取り専用: true

リンク

ソースを表示

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

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

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

型: object

PermissionRole

ソースを表示

• description(optional): string
  ロールの説明。 カスタムの編集ロールまたは公開ロールにのみ適用されます。
• id(optional): string
  ロールのID。 権限セット、カスタム編集ロールまたは公開ロールにのみ適用されます。
• links(optional): array links
  リンク
• name(optional): string
  ロールの名前。
• type(optional): string
  許容値: [ "standard", "custom", "editorial", "publishing" ]

  ロールのタイプ。 値は、'standard'、'custom'、'editorial'および'publishing'です。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the role. Only applicable to permission sets and custom editorial or publishing roles."
        },
        "name":{
            "type":"string",
            "description":"Name of the role."
        },
        "type":{
            "type":"string",
            "description":"Type of the role. Values are 'standard', 'custom', 'editorial', and 'publishing'.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "description":{
            "type":"string",
            "description":"Description of the role. Only applicable to custom editorial or publishing roles."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PermissionRole"
}

ネストされたスキーマ: 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."
}

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

型: array

リンク

ソースを表示

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

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

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

先頭に戻る