Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "subject": {
// "type": "<string>",
// "identifier": "<string>"
// },
// "operation": "<string>"
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("subject.type","<string>")
loJson.UpdateString("subject.identifier","<string>")
loJson.UpdateString("operation","<string>")
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://your-domain.atlassian.net/wiki/rest/api/content/:id/permission/check","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "hasPermission": true,
// "errors": [
// {
// "translation": "anim ex commodo nulla quis",
// "args": [
// ]
// },
// {
// "translation": "aute",
// "args": [
// ]
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
llHasPermission = loJResp.BoolOf("hasPermission")
i = 0
lnCount_i = loJResp.SizeOfArray("errors")
do while i < lnCount_i
loJResp.I = i
lcTranslation = loJResp.StringOf("errors[i].translation")
j = 0
lnCount_j = loJResp.SizeOfArray("errors[i].args")
do while j < lnCount_j
loJResp.J = j
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loJson
release loSbResponseBody
release loJResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-d '{
"subject": {
"type": "<string>",
"identifier": "<string>"
},
"operation": "<string>"
}'
https://your-domain.atlassian.net/wiki/rest/api/content/:id/permission/check
Postman Collection Item JSON
{
"name": "Check content permissions",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/permission/check",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"permission",
"check"
],
"variable": [
{
"key": "id",
"value": "<string>",
"type": "string",
"description": "(Required) The ID of the content to check permissions against."
}
]
},
"description": "Check if a user or a group can perform an operation to the specified content. The `operation` to check\nmust be provided. The user’s account ID or the ID of the group can be provided in the `subject` to check\npermissions against a specified user or group. The following permission checks are done to make sure that the\nuser or group has the proper access:\n\n- site permissions\n- space permissions\n- content restrictions\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission) if checking permission for self,\notherwise 'Confluence Administrator' global permission is required."
},
"response": [
{
"name": "Returned if the permission check completed successfully",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/permission/check",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"permission",
"check"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"hasPermission\": true,\n \"errors\": [\n {\n \"translation\": \"anim ex commodo nulla quis\",\n \"args\": []\n },\n {\n \"translation\": \"aute\",\n \"args\": []\n }\n ]\n}"
},
{
"name": "Returned if;\n\n- If any of the required fields are missing.\n- If specified `subject` or `operation` is invalid.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/permission/check",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"permission",
"check"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the authentication credentials are incorrect or missing\nfrom the request.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/permission/check",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"permission",
"check"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if the user does not have permission perform the check.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/permission/check",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"permission",
"check"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Returned if there is no content with the given ID.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"subject\": {\n \"type\": \"<string>\",\n \"identifier\": \"<string>\"\n },\n \"operation\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/content/:id/permission/check",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"content",
":id",
"permission",
"check"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
