POST /wiki/rest/api/space/_private
Creates a new space that is only visible to the creator. This method is the same as the Create space method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space.
Permissions required: 'Create Space(s)' global permission.
Servers
- https://your-domain.atlassian.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
The name of the new space. |
description |
Object | No |
The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space. |
description.plain |
Object | Yes | |
description.plain.representation |
String | No |
Set to 'plain'. |
description.plain.value |
String | No |
The space description. |
key |
String | No |
The key for the new space. Format: See Space
keys. If |
permissions[] |
Array | No |
The permissions for the new space. If no permissions are provided, the Confluence default space permissions are applied. Note that if permissions are provided, the space is created with only the provided set of permissions, not including the default space permissions. Space permissions can be modified after creation using the space permissions endpoints, and a private space can be created using the create private space endpoint. |
permissions[].operation |
Object | Yes |
An operation and the target entity that it applies to, e.g. create page. |
permissions[].operation.targetType |
String | Yes |
The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space |
permissions[].operation.operation |
String | Yes |
The operation itself. Possible values:
|
permissions[].anonymousAccess |
Boolean | Yes |
Grant anonymous users permission to use the operation. Default value: false |
permissions[].unlicensedAccess |
Boolean | Yes |
Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation. Default value: false |
permissions[].subjects |
Object | No |
The users and/or groups that the permission applies to. |
permissions[].subjects.group |
Object | No | |
permissions[].subjects.group.results[] |
Array | Yes | |
permissions[].subjects.group.results[].id |
String | No | |
permissions[].subjects.group.results[].type |
String | Yes |
Possible values:
Default value: "group" |
permissions[].subjects.group.size |
Integer | Yes | |
permissions[].subjects.user |
Object | No | |
permissions[].subjects.user.results[] |
Array | Yes | |
permissions[].subjects.user.results[].username |
String | No |
This property is no longer available and will be removed from the documentation soon.
Use |
permissions[].subjects.user.results[].accountId |
String | No |
The account ID of the user, which uniquely identifies the user across all Atlassian products.
For example, |
permissions[].subjects.user.results[]._expandable |
Object | No | |
permissions[].subjects.user.results[]._expandable.personalSpace |
String | No | |
permissions[].subjects.user.results[]._expandable.operations |
String | No | |
permissions[].subjects.user.results[]._expandable.details |
String | No | |
permissions[].subjects.user.results[].publicName |
String | No |
The public name or nickname of the user. Will always contain a value. |
permissions[].subjects.user.results[].displayName |
String | No |
The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. |
permissions[].subjects.user.results[].isGuest |
Boolean | No |
Whether the user is a guest user |
permissions[].subjects.user.results[].profilePicture |
Object | No |
This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. |
permissions[].subjects.user.results[].profilePicture.height |
Integer | Yes | |
permissions[].subjects.user.results[].profilePicture.width |
Integer | Yes | |
permissions[].subjects.user.results[].profilePicture.isDefault |
Boolean | Yes | |
permissions[].subjects.user.results[].profilePicture.path |
String | Yes | |
permissions[].subjects.user.results[].details |
Object | No | |
permissions[].subjects.user.results[].details.business |
Object | No | |
permissions[].subjects.user.results[].details.business.location |
String | No |
This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details. |
permissions[].subjects.user.results[].details.business.department |
String | No |
This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details. |
permissions[].subjects.user.results[].details.business.position |
String | No |
This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details. |
permissions[].subjects.user.results[].details.personal |
Object | No | |
permissions[].subjects.user.results[].details.personal.email |
String | No |
This property has been deprecated due to privacy changes. Use the |
permissions[].subjects.user.results[].details.personal.phone |
String | No |
This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details. |
permissions[].subjects.user.results[].details.personal.im |
String | No |
This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details. |
permissions[].subjects.user.results[].details.personal.website |
String | No |
This property has been deprecated due to privacy changes. There is no replacement. See the migration guide for details. |
permissions[].subjects.user.results[]._links |
Object | No | |
permissions[].subjects.user.results[]._links.Embeddable |
Object | No | |
permissions[].subjects.user.results[]._links.ContentId |
String | No | |
permissions[].subjects.user.results[].userKey |
String | No |
This property is no longer available and will be removed from the documentation soon.
Use |
permissions[].subjects.user.results[].email |
String | No |
The email address of the user. Depending on the user's privacy setting, this may return an empty string. |
permissions[].subjects.user.results[].type |
String | Yes |
Possible values:
|
permissions[].subjects.user.results[].accountType |
String | No |
The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app. Possible values:
|
permissions[].subjects.user.results[].isExternalCollaborator |
Boolean | No |
This is deprecated. Use |
permissions[].subjects.user.results[].timeZone |
String | No |
This displays user time zone. Depending on the user's privacy setting, this may return null. |
permissions[].subjects.user.results[].externalCollaborator |
Boolean | No |
This is deprecated. Use |
permissions[].subjects.user.results[].operations[] |
Array | No | |
permissions[].subjects.user.results[].operations[].targetType |
String | Yes |
The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space |
permissions[].subjects.user.results[].operations[].operation |
String | Yes |
The operation itself. Possible values:
|
permissions[].subjects.user.size |
Integer | Yes | |
alias |
String | No |
This field will be used as the new identifier for the space in confluence page URLs. If the property is not provided the alias will be the provided key. This property is experimental and may be changed or removed in the future. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.