Class SpacePermissionsService

See

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

Hierarchy

CommonHttpService
- SpacePermissionsService

Index

Constructors

Methods

getAvailableSpacePermissions getSpacePermissionsAssignments 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

getAvailableSpacePermissions

getAvailableSpacePermissions(params?): Promise<{
    _links?: MultiEntityLinks;
    results?: SpacePermission[];
} & {
    [key: string]: unknown;
}>
Retrieves the available space permissions.

Available on tenants with Role-Based Access Control.

Permissions required: Permission to access the Confluence site.
Parameters
- params: {
  cursor?: string;
  limit?: number;
  } = {}
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - Optionallimit?: number
    Maximum number of space permissions to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: SpacePermission[];
} & {
    [key: string]: unknown;
}>
Returned if the requested space permissions are retrieved.

Path
GET /space-permissions @scopes-current read:space.permission:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions#api-space-permissions-get

getSpacePermissionsAssignments

getSpacePermissionsAssignments(params): Promise<{
    _links?: MultiEntityLinks;
    results?: SpacePermissionAssignment[];
} & {
    [key: string]: unknown;
}>
Returns space permission assignments for a specific space.

Permissions required: Permission to view the space.
Parameters
- params: {
      cursor?: string;
      id: number;
      limit?: number;
  }
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - id: number
    The ID of the space to be returned.
  - Optionallimit?: number
    Maximum number of assignments to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: SpacePermissionAssignment[];
} & {
    [key: string]: unknown;
}>
Returned if the requested assignments are returned.

Path
GET /spaces/{id}/permissions @scopes-current read:space:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions#api-spaces-id-permissions-get

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize