Jump to

• Request
• Response

Add a permission to a taxonomy

post

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

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  id of the taxonomy.

Query Parameters

• fields(optional): string
  This parameter is used to control the returned fields for the new permission. By default no fields are returned.

  Allowed Values: [ "permissionId" ]

Header Parameters

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

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Add a permission with the given information in the payload. The fields role, email and fullName will be ignored even if given in the payload.

The field id represents the name of the user or group to share.
The field roleName determines the role to add. The allowed values are: manager, editor.
The field type determines if it's a user or group.
The field groupType is optional. If not provided, default value is CEC.
The field message is optional. If provided, the message will be sent in Email notification.

Root Schema : ResourcePermissionCreate

Type: object

ResourcePermissionCreate

Show Source

• email(optional): string
  email of the user.
• fullName(optional): string
  full name of the user.
• groupType(optional): string
  Allowed Values: [ "CEC", "IDP" ]

  type of the group.
• id(optional): string
  userId login name of the user.
• links(optional): array links
  Read Only: true

  Links
• message(optional): string
• role(optional): object PermissionRole
  PermissionRole
• roleName(optional): string
  name of the role on the resource. Deprecated. Replaced by the 'role' property.
• type(optional): string
  Allowed Values: [ "user", "group" ]

  type of the user.

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

Nested Schema : links

Type: array

Read Only: true

Links

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : PermissionRole

Type: object

PermissionRole

Show Source

• description(optional): string
  Description of the role. Only applicable to custom editorial or publishing roles.
• id(optional): string
  ID of the role. Only applicable to permission sets and custom editorial or publishing roles.
• links(optional): array links
  Links
• name(optional): string
  Name of the role.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  Type of the role. Values are 'standard', 'custom', 'editorial', and '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"
}

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 : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created.

Body ()

Root Schema : ResourcePermission

Type: object

ResourcePermission

Show Source

• email(optional): string
  email of the user.
• fullName(optional): string
  full name of the user.
• groupType(optional): string
  Allowed Values: [ "CEC", "IDP" ]

  type of the group.
• id(optional): string
  userId login name of the user.
• links(optional): array links
  Read Only: true

  Links
• role(optional): object PermissionRole
  PermissionRole
• roleName(optional): string
  name of the role on the resource. Deprecated. Replaced by the 'role' property.
• type(optional): string
  Allowed Values: [ "user", "group" ]

  type of the user.

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

Nested Schema : links

Type: array

Read Only: true

Links

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : PermissionRole

Type: object

PermissionRole

Show Source

• description(optional): string
  Description of the role. Only applicable to custom editorial or publishing roles.
• id(optional): string
  ID of the role. Only applicable to permission sets and custom editorial or publishing roles.
• links(optional): array links
  Links
• name(optional): string
  Name of the role.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  Type of the role. Values are 'standard', 'custom', 'editorial', and '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"
}

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 : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

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

400 Response

Bad request.

403 Response

Forbidden.

500 Response

Internal server error.

Back to Top