Jump to

• Request
• Response
• Examples

Performs Permission Operations on resource

post

/content/management/api/v1.1/permissionOperations

Performs permission operations on resource with given payload.

Request

Supported Media Types

• application/json

Query Parameters

• 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

Header Parameters

• Prefer(optional): string
  This parameter is used to control the interaction type (synchronous/asynchronous) of the request. If the header is provided with value respond-async, it indicates that asynchronous interaction is preferred. Otherwise, synchronous interaction is preferred. Asynchronous request is responded with 202 status with a status link in the location header. Synchronous request is responded with 200 along with response body.

  Allowed Values: [ "respond-async" ]
• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Details of the permission operations.

Root Schema : PermissionOperations

Type: object

Permission Operations

Show Source

• links(optional): array links
  Links of the permission operations resource.
• operations(optional): object PermissionOperationsActions
  Operations that can be performed. Currently only one operation at a time is supported.

{
    "type":"object",
    "properties":{
        "operations":{
            "description":"Operations to perform. It is a required property in the post request.",
            "$ref":"#/definitions/PermissionOperationsActions"
        },
        "links":{
            "type":"array",
            "description":"Links of the permission operations resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Permission Operations"
}

Nested Schema : links

Type: array

Links of the permission operations resource.

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : PermissionOperationsActions

Type: object

Operations that can be performed. Currently only one operation at a time is supported.

Show Source

• share(optional): object SharePermission
  Details of the share operation
• unshare(optional): object UnSharePermission
  Details of the unshare operation

{
    "type":"object",
    "properties":{
        "share":{
            "description":"Share resource with other users or groups.",
            "$ref":"#/definitions/SharePermission"
        },
        "unshare":{
            "description":"Unshare resource with other users or groups.",
            "$ref":"#/definitions/UnSharePermission"
        }
    },
    "description":"Operations that can be performed. Currently only one operation at a time is supported."
}

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

Type: object

Details of the share operation

Show Source

• failedRoles(optional): array failedRoles
  failed share list.
• resource(optional): object ResourceId
  ResourceId
• roles(optional): array roles
  details of the roles to be granted.
• successRoles(optional): array successRoles
  successful share list.

{
    "type":"object",
    "properties":{
        "resource":{
            "description":"resource to be shared.",
            "$ref":"#/definitions/ResourceId"
        },
        "roles":{
            "type":"array",
            "description":"details of the roles to be granted.",
            "items":{
                "$ref":"#/definitions/SharePermissionRole"
            }
        },
        "successRoles":{
            "type":"array",
            "description":"successful share list.",
            "items":{
                "$ref":"#/definitions/SuccessSharePermissionRole"
            }
        },
        "failedRoles":{
            "type":"array",
            "description":"failed share list.",
            "items":{
                "$ref":"#/definitions/FailedSharePermissionRole"
            }
        }
    },
    "description":"Details of the share operation"
}

Nested Schema : UnSharePermission

Type: object

Details of the unshare operation

Show Source

• failedUsers(optional): array failedUsers
• message(optional): string
• resource(optional): object ResourceId
  ResourceId
• successUsers(optional): array successUsers
• users(optional): array users

{
    "type":"object",
    "properties":{
        "resource":{
            "description":"resource to be unshared.",
            "$ref":"#/definitions/ResourceId"
        },
        "message":{
            "type":"string"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        },
        "successUsers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        },
        "failedUsers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FailedUserId"
            }
        }
    },
    "description":"Details of the unshare operation"
}

Nested Schema : failedRoles

Type: array

failed share list.

Show Source

• Array of: object FailedSharePermissionRole
  Details of share operation role failed.

{
    "type":"array",
    "description":"failed share list.",
    "items":{
        "$ref":"#/definitions/FailedSharePermissionRole"
    }
}

Nested Schema : ResourceId

Type: object

ResourceId

Show Source

• id(optional): string
  id of the resource.
• name(optional): string
  Name of the resource.
• type(optional): string
  Allowed Values: [ "repository", "collection", "channel", "type", "workflow", "scheduledjob", "translationjob", "editorialrole", "publishingrole", "siteplan", "taxonomy", "retentionpolicy", "hold" ]

  Type of the resource.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the resource."
        },
        "name":{
            "type":"string",
            "description":"Name of the resource."
        },
        "type":{
            "type":"string",
            "description":"Type of the resource.",
            "enum":[
                "repository",
                "collection",
                "channel",
                "type",
                "workflow",
                "scheduledjob",
                "translationjob",
                "editorialrole",
                "publishingrole",
                "siteplan",
                "taxonomy",
                "retentionpolicy",
                "hold"
            ]
        }
    },
    "description":"ResourceId"
}

Nested Schema : roles

Type: array

details of the roles to be granted.

Show Source

• Array of: object SharePermissionRole
  Details of share operation role.

{
    "type":"array",
    "description":"details of the roles to be granted.",
    "items":{
        "$ref":"#/definitions/SharePermissionRole"
    }
}

Nested Schema : successRoles

Type: array

successful share list.

Show Source

• Array of: object SuccessSharePermissionRole
  Details of successful share operation role.

{
    "type":"array",
    "description":"successful share list.",
    "items":{
        "$ref":"#/definitions/SuccessSharePermissionRole"
    }
}

Nested Schema : FailedSharePermissionRole

Type: object

Details of share operation role failed.

Show Source

• id(optional): string
  id of the role to be granted.
• name(optional): string
  name of the role to be granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role to be granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role to be granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role to be granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role to be granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FailedUserId"
            }
        }
    },
    "description":"Details of share operation role failed."
}

Nested Schema : users

Type: array

Show Source

• Array of: object FailedUserId
  FailedUserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FailedUserId"
    }
}

Nested Schema : FailedUserId

Type: object

FailedUserId

Show Source

• groupType(optional): string
  Allowed Values: [ "CEC", "IDP" ]
• message(optional): string
  failure message.
• name(optional): string
• type(optional): string
  Allowed Values: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        },
        "message":{
            "type":"string",
            "description":"failure message."
        }
    },
    "description":"FailedUserId"
}

Nested Schema : SharePermissionRole

Type: object

Details of share operation role.

Show Source

• id(optional): string
  id of the role to be granted.
• message(optional): string
• name(optional): string
  name of the role to be granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role to be granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role to be granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role to be granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role to be granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "message":{
            "type":"string"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        }
    },
    "description":"Details of share operation role."
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : UserId

Type: object

UserId

Show Source

• groupType(optional): string
  Allowed Values: [ "CEC", "IDP" ]
• name(optional): string
• type(optional): string
  Allowed Values: [ "user", "group" ]

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

Nested Schema : SuccessSharePermissionRole

Type: object

Details of successful share operation role.

Show Source

• id(optional): string
  id of the role granted.
• name(optional): string
  name of the role granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        }
    },
    "description":"Details of successful share operation role."
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : failedUsers

Type: array

Show Source

• Array of: object FailedUserId
  FailedUserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FailedUserId"
    }
}

Nested Schema : successUsers

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : PermissionOperations

Type: object

Permission Operations

Show Source

• links(optional): array links
  Links of the permission operations resource.
• operations(optional): object PermissionOperationsActions
  Operations that can be performed. Currently only one operation at a time is supported.

{
    "type":"object",
    "properties":{
        "operations":{
            "description":"Operations to perform. It is a required property in the post request.",
            "$ref":"#/definitions/PermissionOperationsActions"
        },
        "links":{
            "type":"array",
            "description":"Links of the permission operations resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Permission Operations"
}

Nested Schema : links

Type: array

Links of the permission operations resource.

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : PermissionOperationsActions

Type: object

Operations that can be performed. Currently only one operation at a time is supported.

Show Source

• share(optional): object SharePermission
  Details of the share operation
• unshare(optional): object UnSharePermission
  Details of the unshare operation

{
    "type":"object",
    "properties":{
        "share":{
            "description":"Share resource with other users or groups.",
            "$ref":"#/definitions/SharePermission"
        },
        "unshare":{
            "description":"Unshare resource with other users or groups.",
            "$ref":"#/definitions/UnSharePermission"
        }
    },
    "description":"Operations that can be performed. Currently only one operation at a time is supported."
}

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

Type: object

Details of the share operation

Show Source

• failedRoles(optional): array failedRoles
  failed share list.
• resource(optional): object ResourceId
  ResourceId
• roles(optional): array roles
  details of the roles to be granted.
• successRoles(optional): array successRoles
  successful share list.

{
    "type":"object",
    "properties":{
        "resource":{
            "description":"resource to be shared.",
            "$ref":"#/definitions/ResourceId"
        },
        "roles":{
            "type":"array",
            "description":"details of the roles to be granted.",
            "items":{
                "$ref":"#/definitions/SharePermissionRole"
            }
        },
        "successRoles":{
            "type":"array",
            "description":"successful share list.",
            "items":{
                "$ref":"#/definitions/SuccessSharePermissionRole"
            }
        },
        "failedRoles":{
            "type":"array",
            "description":"failed share list.",
            "items":{
                "$ref":"#/definitions/FailedSharePermissionRole"
            }
        }
    },
    "description":"Details of the share operation"
}

Nested Schema : UnSharePermission

Type: object

Details of the unshare operation

Show Source

• failedUsers(optional): array failedUsers
• message(optional): string
• resource(optional): object ResourceId
  ResourceId
• successUsers(optional): array successUsers
• users(optional): array users

{
    "type":"object",
    "properties":{
        "resource":{
            "description":"resource to be unshared.",
            "$ref":"#/definitions/ResourceId"
        },
        "message":{
            "type":"string"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        },
        "successUsers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        },
        "failedUsers":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FailedUserId"
            }
        }
    },
    "description":"Details of the unshare operation"
}

Nested Schema : failedRoles

Type: array

failed share list.

Show Source

• Array of: object FailedSharePermissionRole
  Details of share operation role failed.

{
    "type":"array",
    "description":"failed share list.",
    "items":{
        "$ref":"#/definitions/FailedSharePermissionRole"
    }
}

Nested Schema : ResourceId

Type: object

ResourceId

Show Source

• id(optional): string
  id of the resource.
• name(optional): string
  Name of the resource.
• type(optional): string
  Allowed Values: [ "repository", "collection", "channel", "type", "workflow", "scheduledjob", "translationjob", "editorialrole", "publishingrole", "siteplan", "taxonomy", "retentionpolicy", "hold" ]

  Type of the resource.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the resource."
        },
        "name":{
            "type":"string",
            "description":"Name of the resource."
        },
        "type":{
            "type":"string",
            "description":"Type of the resource.",
            "enum":[
                "repository",
                "collection",
                "channel",
                "type",
                "workflow",
                "scheduledjob",
                "translationjob",
                "editorialrole",
                "publishingrole",
                "siteplan",
                "taxonomy",
                "retentionpolicy",
                "hold"
            ]
        }
    },
    "description":"ResourceId"
}

Nested Schema : roles

Type: array

details of the roles to be granted.

Show Source

• Array of: object SharePermissionRole
  Details of share operation role.

{
    "type":"array",
    "description":"details of the roles to be granted.",
    "items":{
        "$ref":"#/definitions/SharePermissionRole"
    }
}

Nested Schema : successRoles

Type: array

successful share list.

Show Source

• Array of: object SuccessSharePermissionRole
  Details of successful share operation role.

{
    "type":"array",
    "description":"successful share list.",
    "items":{
        "$ref":"#/definitions/SuccessSharePermissionRole"
    }
}

Nested Schema : FailedSharePermissionRole

Type: object

Details of share operation role failed.

Show Source

• id(optional): string
  id of the role to be granted.
• name(optional): string
  name of the role to be granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role to be granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role to be granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role to be granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role to be granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FailedUserId"
            }
        }
    },
    "description":"Details of share operation role failed."
}

Nested Schema : users

Type: array

Show Source

• Array of: object FailedUserId
  FailedUserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FailedUserId"
    }
}

Nested Schema : FailedUserId

Type: object

FailedUserId

Show Source

• groupType(optional): string
  Allowed Values: [ "CEC", "IDP" ]
• message(optional): string
  failure message.
• name(optional): string
• type(optional): string
  Allowed Values: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        },
        "message":{
            "type":"string",
            "description":"failure message."
        }
    },
    "description":"FailedUserId"
}

Nested Schema : SharePermissionRole

Type: object

Details of share operation role.

Show Source

• id(optional): string
  id of the role to be granted.
• message(optional): string
• name(optional): string
  name of the role to be granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role to be granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role to be granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role to be granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role to be granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "message":{
            "type":"string"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        }
    },
    "description":"Details of share operation role."
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : UserId

Type: object

UserId

Show Source

• groupType(optional): string
  Allowed Values: [ "CEC", "IDP" ]
• name(optional): string
• type(optional): string
  Allowed Values: [ "user", "group" ]

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

Nested Schema : SuccessSharePermissionRole

Type: object

Details of successful share operation role.

Show Source

• id(optional): string
  id of the role granted.
• name(optional): string
  name of the role granted.
• type(optional): string
  Allowed Values: [ "standard", "custom", "editorial", "publishing" ]

  type of the role granted.
• users(optional): array users

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the role granted."
        },
        "name":{
            "type":"string",
            "description":"name of the role granted."
        },
        "type":{
            "type":"string",
            "description":"type of the role granted.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        }
    },
    "description":"Details of successful share operation role."
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : failedUsers

Type: array

Show Source

• Array of: object FailedUserId
  FailedUserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FailedUserId"
    }
}

Nested Schema : successUsers

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserId
  UserId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

202 Response

Accepted.

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 perform permission operations on resource with given payload by submitting a POST request on the REST resource using cURL.

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/permissionOperations'

Example 1:

Share a repository with id E1F4F961C7224422B0998434E4F4572E to a user in a synchronous way. Here the shared role is a custom editorial role with id 94950193E96940D7980FA8BA47E73491. Replace payload with your own data.

/content/management/api/v1.1/permissionOperations?links=none

Request Payload

{
		  "operations": {
			"share": {
			  "resource": {
				"id": "E1F4F961C7224422B0998434E4F4572E",
				"name": "repository7",
				"type": "repository"
			  },
			  "roles": [
				{
				  "message": "message1",
				  "users": [
					{
					  "name": "cecuserLoginIdName2",
					  "type": "user"
					}
				  ],
				  "id": "94950193E96940D7980FA8BA47E73491",
				  "name": "Custom Editorial Role3",
				  "type": "editorial"
				}
			  ]
			}
		  }
      }

Response Body

{
		"operations": {
			"share": {
				"resource": {
					"id": "E1F4F961C7224422B0998434E4F4572E",
					"name": "repository7",
					"type": "repository"
				},
				"roles": [
					{
						"id": "94950193E96940D7980FA8BA47E73491",
						"name": "Custom Editorial Role3",
						"type": "editorial",
						"message": "message1",
						"users": [
							{
								"name": "cecuserLoginIdName2",
								"type": "user"
							}
						]
					}
				],
				"successRoles": [
					{
						"id": "94950193E96940D7980FA8BA47E73491",
						"name": "Custom Editorial Role3",
						"type": "editorial",
						"users": [
							{
								"name": "cecuserLoginIdName2",
								"type": "user"
							}
						]
					}
				]
			}
		}

Example 2:

Share a custom editorial role with id 7EFD29110FE041ADAC888CCFAEE2923B to users in a synchronous way. The shared role must be manager. Replace payload with your own data.

/content/management/api/v1.1/permissionOperations?links=none

Request Payload

{
        "operations": {
          "share": {
            "resource" : {
              "id" : "7EFD29110FE041ADAC888CCFAEE2923B",
			  "name": "Custom Editor Role",
              "type" : "editorialRole"
            },
            "roles": [
              {
                "name" : "manager",
                "message" : "message1",
                "users" : [
                  {"name" : "cecuserLoginIdName1", "type" : "user"},
                  {"name" : "cecgroupLoginIdName1", "type" : "group"}
                ]
              }
            ]
          }
        }
      }

Response Body

{
		"operations": {
			"share": {
				"resource": {
					"id": "7EFD29110FE041ADAC888CCFAEE2923B",
					"name": "Custom Editor Role",
					"type": "editorialRole"
				},
				"roles": [
					{
						"name": "manager",
						"message": "message1",
						"users": [
							{
								"name": "cecgroupLoginIdName1",
								"type": "group",
								"groupType": "CEC"
							},
							{
								"name": "cecuserLoginIdName1",
								"type": "user"
							}
						]
					}
				],
				"successRoles": [
					{
						"name": "manager",
						"users": [
							{
								"name": "cecgroupLoginIdName1",
								"type": "group",
								"groupType": "CEC"
							},
							{
								"name": "cecuserLoginIdName1",
								"type": "user"
							}
						]
					}
				]
			}
		}

Example 3:

Share a scheduled job to users in an asynchronous way. Here ae071059448e4c7898cd5b303fc6017e is id of the scheduled job. Replace payload with your own data.

/content/management/api/v1.1/permissionOperations

Request Payload

{
        "operations": {
          "share": {
            "resource" : {
              "id" : "ae071059448e4c7898cd5b303fc6017e",
              "type" : "scheduledJob"
            },
            "roles": [
              {
                "name" : "manager",
                "message" : "message1",
                "users" : [
                  {"name" : "ssvrint.admin1", "type" : "user"},
                  {"name" : "ssvrint.siteadmina", "type" : "user"}
                ]
              }
            ]
          }
        }
      }

Back to Top