Class ContentPermissionsService

See

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

Hierarchy

CommonHttpService
- ContentPermissionsService

Index

Constructors

Methods

checkContentPermission initialize

Constructors

constructor

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

Methods

checkContentPermission

checkContentPermission(params): Promise<PermissionCheckResponse>
Check if a user or a group can perform an operation to the specified content. The operation to check must be provided. The user’s account ID or the ID of the group can be provided in the subject to check permissions against a specified user or group. The following permission checks are done to make sure that the user or group has the proper access:
- site permissions
- space permissions
- content restrictions
Permissions required: Permission to access the Confluence site ('Can use' global permission) if checking permission for self, otherwise 'Confluence Administrator' global permission is required.
Parameters
- params: {
  contentPermissionRequest: ContentPermissionRequest;
  id: string;
  }
  - contentPermissionRequest: ContentPermissionRequest
    The content permission request.
  - id: string
    The ID of the content to check permissions against.
Returns Promise<PermissionCheckResponse>
Returned if the permission check completed successfully

Path
POST /wiki/rest/api/content/{id}/permission/check @scopes-current read:confluence-content.permission @scopes-beta read:content.permission:confluence

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

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize