Class SpacePermissionsService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions

Hierarchy

CommonHttpService
- SpacePermissionsService

Index

Constructors

Methods

addCustomContentPermissions addPermissionToSpace removePermission initialize

Constructors

constructor

new SpacePermissionsService(getClientInstance): SpacePermissionsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns SpacePermissionsService
Inherited from CommonHttpService.constructor

Methods

addCustomContentPermissions

addCustomContentPermissions(params): Promise<void>
Adds new custom content permission to space.

If the permission to be added is a group permission, the group can be identified by its group name or group id.

Note: Only apps can access this REST resource and only make changes to the respective app permissions.

Permissions required: 'Admin' permission for the space.
Parameters
- params: {
  spaceKey: string;
  spacePermissionCustomContent: SpacePermissionCustomContent;
  }
  - spaceKey: string
    The key of the space to be queried for its content.
  - spacePermissionCustomContent: SpacePermissionCustomContent
    The permissions to be created.
Returns Promise<void>
Path
POST /wiki/rest/api/space/{spaceKey}/permission/custom-content @scopes-current read:space.permission:confluence, write:space.permission:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-custom-content-post

addPermissionToSpace

addPermissionToSpace(params): Promise<SpacePermissionV2>
Adds new permission to space.

If the permission to be added is a group permission, the group can be identified by its group name or group id.

Note: Apps cannot access this REST resource - including when utilizing user impersonation.

Permissions required: 'Admin' permission for the space.
Parameters
- params: {
  spaceKey: string;
  spacePermissionRequest: SpacePermissionRequest;
  }
  - spaceKey: string
    The key of the space to be queried for its content.
  - spacePermissionRequest: SpacePermissionRequest
    The permission to be created.
Returns Promise<SpacePermissionV2>
Returned if the requested content is returned.

Path
POST /wiki/rest/api/space/{spaceKey}/permission @scopes-current read:space.permission:confluence, write:space.permission:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-post

removePermission

removePermission(params): Promise<void>
Removes a space permission. Note that removing Read Space permission for a user or group will remove all the space permissions for that user or group.

Note: Apps cannot access this REST resource - including when utilizing user impersonation.

Permissions required: 'Admin' permission for the space.
Parameters
- params: {
  id: number;
  spaceKey: string;
  }
  - id: number
    Id of the permission to be deleted.
  - spaceKey: string
    The key of the space to be queried for its content.
Returns Promise<void>
Path
DELETE /wiki/rest/api/space/{spaceKey}/permission/{id} @scopes-current write:space.permission:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-id-delete

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize