リソースでの権限操作の実行
post
/content/management/api/v1.1/permissionOperations
指定されたペイロードのリソースに対して権限操作を実行します。
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- links(optional): string
このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby
ヘッダー・パラメータ
- Prefer(optional): string
このパラメータは、リクエストの相互作用のタイプ(同期/非同期)を制御するために使用されます。 ヘッダーの値がレスポンス/同期で指定されている場合は、非同期相互作用が優先されることを示します。 それ以外の場合は、同期相互作用が優先されます。 非同期リクエストは、ロケーション・ヘッダーにステータス・リンクがある202ステータスで応答します。 同期リクエストは、レスポンス本文とともに200で応答します。許容値:
[ "respond-async" ] - X-Requested-With: string
CSRF攻撃を軽減するためのカスタム・ヘッダー。許容値:
[ "XMLHttpRequest" ]
権限操作の詳細。
ルート・スキーマ : PermissionOperations
型:
object権限操作
ソースを表示
- links(optional): array links
権限操作リソースのリンク。
- operations(optional): object PermissionOperationsActions
実行可能な操作。 現時点では、一度に1つの操作のみがサポートされています。
ネストされたスキーマ: Link
型:
objectリソースのリンク。
ソースを表示
- href(optional): string
ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
- mediaType(optional): string
メディア・タイプ。
- method(optional): string
ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
- profile(optional): string
ターゲット・リソースを記述するメタデータにリンクします。
- rel(optional): string
関連タイプ これはレスポンス取得の必須プロパティです。
- templated(optional): boolean
URIがテンプレートであるかどうか。
ネストされたスキーマ : ResourceId
型:
objectResourceId
ソースを表示
- id(optional): string
リソースのId。
- name(optional): string
リソースの名前
- type(optional): string
許容値:
[ "repository", "collection", "channel", "type", "workflow", "scheduledjob", "translationjob", "editorialrole", "publishingrole", "siteplan", "taxonomy", "retentionpolicy", "hold" ]リソースのタイプ。
ネストされたスキーマ : FailedUserId
型:
objectFailedUserId
ソースを表示
- groupType(optional): string
許容値:
[ "CEC", "IDP" ] - message(optional): string
失敗メッセージです。
- name(optional): string
- type(optional): string
許容値:
[ "user", "group" ]
ネストされたスキーマ : UserId
型:
objectUserId
ソースを表示
- groupType(optional): string
許容値:
[ "CEC", "IDP" ] - name(optional): string
- type(optional): string
許容値:
[ "user", "group" ]
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK。
ルート・スキーマ : PermissionOperations
型:
object権限操作
ソースを表示
- links(optional): array links
権限操作リソースのリンク。
- operations(optional): object PermissionOperationsActions
実行可能な操作。 現時点では、一度に1つの操作のみがサポートされています。
ネストされたスキーマ: Link
型:
objectリソースのリンク。
ソースを表示
- href(optional): string
ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
- mediaType(optional): string
メディア・タイプ。
- method(optional): string
ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
- profile(optional): string
ターゲット・リソースを記述するメタデータにリンクします。
- rel(optional): string
関連タイプ これはレスポンス取得の必須プロパティです。
- templated(optional): boolean
URIがテンプレートであるかどうか。
ネストされたスキーマ : ResourceId
型:
objectResourceId
ソースを表示
- id(optional): string
リソースのId。
- name(optional): string
リソースの名前
- type(optional): string
許容値:
[ "repository", "collection", "channel", "type", "workflow", "scheduledjob", "translationjob", "editorialrole", "publishingrole", "siteplan", "taxonomy", "retentionpolicy", "hold" ]リソースのタイプ。
ネストされたスキーマ : FailedUserId
型:
objectFailedUserId
ソースを表示
- groupType(optional): string
許容値:
[ "CEC", "IDP" ] - message(optional): string
失敗メッセージです。
- name(optional): string
- type(optional): string
許容値:
[ "user", "group" ]
ネストされたスキーマ : UserId
型:
objectUserId
ソースを表示
- groupType(optional): string
許容値:
[ "CEC", "IDP" ] - name(optional): string
- type(optional): string
許容値:
[ "user", "group" ]
202レスポンス
Accepted.
400レスポンス
不正リクエスト
403レスポンス
禁止。
404レスポンス
見つかりません。
500レスポンス
内部サーバー・エラー
例
次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを送信することによって、特定のペイロードを持つリソースに対して権限操作を実行する方法を示しています。
curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/permissionOperations'
例1:
IDがE1F4F961C7224422B0998434E4F4572Eのリポジトリを同期的にユーザーに共有します。 共有ロールは、IDが94950193E96940D7980FA8BA47E73491のカスタム編集ロールです。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/permissionOperations?links=none
リクエスト・ペイロード
{
"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"
}
]
}
}
}
レスポンス本文
{
"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"
}
]
}
]
}
}
例2:
ID 7EFD29110FE041ADAC888CCFAEE2923Bのカスタム編集ロールを同期的にユーザーに共有します。 共有ロールはマネージャである必要があります。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/permissionOperations?links=none
リクエスト・ペイロード
{
"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"}
]
}
]
}
}
}
レスポンス本文
{
"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"
}
]
}
]
}
}
例3 :
スケジュール済ジョブを非同期でユーザーに共有します。 ここで、ae071059448e4c7898cd5b303fc6017eはスケジュール済ジョブのIDです。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/permissionOperations
リクエスト・ペイロード
{
"operations": {
"share": {
"resource" : {
"id" : "ae071059448e4c7898cd5b303fc6017e",
"type" : "scheduledJob"
},
"roles": [
{
"name" : "manager",
"message" : "message1",
"users" : [
{"name" : "ssvrint.admin1", "type" : "user"},
{"name" : "ssvrint.siteadmina", "type" : "user"}
]
}
]
}
}
}