Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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>"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"subject.type","<string>")
CkJsonObject::ckUpdateString(json,"subject.identifier","<string>")
CkJsonObject::ckUpdateString(json,"operation","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://your-domain.atlassian.net/wiki/rest/api/content/:id/permission/check","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
translation.s
j.i
count_j.i
hasPermission.i = CkJsonObject::ckBoolOf(jResp,"hasPermission")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"errors")
While i < count_i
CkJsonObject::setCkI(jResp, i)
translation = CkJsonObject::ckStringOf(jResp,"errors[i].translation")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"errors[i].args")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}