Chilkat Online Tools

Objective-C / Atlassian Confluence Cloud / Add new permission to space

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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": {
//     "key": "<string>",
//     "target": "<string>"
//   },
//   "id": "<long>",
//   "_links": {}
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"subject.type" value: @"<string>"];
[json UpdateString: @"subject.identifier" value: @"<string>"];
[json UpdateString: @"operation.key" value: @"<string>"];
[json UpdateString: @"operation.target" value: @"<string>"];
[json UpdateString: @"id" value: @"<long>"];
[json UpdateNewObject: @"_links"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/permission" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "subject": {
//     "type": "<string>",
//     "identifier": "<string>"
//   },
//   "operation": {
//     "key": "<string>",
//     "target": "<string>"
//   },
//   "id": "<long>",
//   "_links": {}
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *v_Type = [jResp StringOf: @"subject.type"];
NSString *Identifier = [jResp StringOf: @"subject.identifier"];
NSString *Key = [jResp StringOf: @"operation.key"];
NSString *Target = [jResp StringOf: @"operation.target"];
NSString *id = [jResp StringOf: @"id"];

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-d '{
    "subject": {
        "type": "<string>",
        "identifier": "<string>"
    },
    "operation": {
        "key": "<string>",
        "target": "<string>"
    },
    "id": "<long>",
    "_links": {}
}'
https://your-domain.atlassian.net/wiki/rest/api/space/:spaceKey/permission

Postman Collection Item JSON

{
  "name": "Add new permission to space",
  "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\": {\n        \"key\": \"<string>\",\n        \"target\": \"<string>\"\n    },\n    \"id\": \"<long>\",\n    \"_links\": {}\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/api/space/:spaceKey/permission",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "space",
        ":spaceKey",
        "permission"
      ],
      "variable": [
        {
          "key": "spaceKey",
          "value": "<string>",
          "type": "string",
          "description": "(Required) The key of the space to be queried for its content."
        }
      ]
    },
    "description": "Adds new permission to space.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Admin' permission for the space."
  },
  "response": [
    {
      "name": "Returned if the requested content is returned.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"subject\": {\n        \"type\": \"<string>\",\n        \"identifier\": \"<string>\"\n    },\n    \"operation\": {\n        \"key\": \"<string>\",\n        \"target\": \"<string>\"\n    },\n    \"id\": \"<long>\",\n    \"_links\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/space/:spaceKey/permission",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "space",
            ":spaceKey",
            "permission"
          ],
          "variable": [
            {
              "key": "spaceKey"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"subject\": {\n  \"type\": \"<string>\",\n  \"identifier\": \"<string>\"\n },\n \"operation\": {\n  \"key\": \"<string>\",\n  \"target\": \"<string>\"\n },\n \"id\": \"<long>\",\n \"_links\": {}\n}"
    },
    {
      "name": "Used for various errors. Such as:\n- Permission already exists for the given user or group.\n- 'read space' permission doesn't exist for the given user or group.\n- No group found with the given groupName",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"subject\": {\n        \"type\": \"<string>\",\n        \"identifier\": \"<string>\"\n    },\n    \"operation\": {\n        \"key\": \"<string>\",\n        \"target\": \"<string>\"\n    },\n    \"id\": \"<long>\",\n    \"_links\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/space/:spaceKey/permission",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "space",
            ":spaceKey",
            "permission"
          ],
          "variable": [
            {
              "key": "spaceKey"
            }
          ]
        }
      },
      "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\": {\n        \"key\": \"<string>\",\n        \"target\": \"<string>\"\n    },\n    \"id\": \"<long>\",\n    \"_links\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/space/:spaceKey/permission",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "space",
            ":spaceKey",
            "permission"
          ],
          "variable": [
            {
              "key": "spaceKey"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Returned if the user isn't authorized.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"subject\": {\n        \"type\": \"<string>\",\n        \"identifier\": \"<string>\"\n    },\n    \"operation\": {\n        \"key\": \"<string>\",\n        \"target\": \"<string>\"\n    },\n    \"id\": \"<long>\",\n    \"_links\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/space/:spaceKey/permission",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "space",
            ":spaceKey",
            "permission"
          ],
          "variable": [
            {
              "key": "spaceKey"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Returned if any of the following is true:\n- There is no space with the given key.\n- The calling user does not have permission to view the space.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"subject\": {\n        \"type\": \"<string>\",\n        \"identifier\": \"<string>\"\n    },\n    \"operation\": {\n        \"key\": \"<string>\",\n        \"target\": \"<string>\"\n    },\n    \"id\": \"<long>\",\n    \"_links\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/api/space/:spaceKey/permission",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "space",
            ":spaceKey",
            "permission"
          ],
          "variable": [
            {
              "key": "spaceKey"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}