Class SpaceRolesService

See

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

Hierarchy

CommonHttpService
- SpaceRolesService

Index

Constructors

Methods

createSpaceRole deleteSpaceRole getAvailableSpaceRoles getSpaceRoleAssignments getSpaceRoleMode getSpaceRolesById setSpaceRoleAssignments updateSpaceRole initialize

Constructors

constructor

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

Methods

createSpaceRole

createSpaceRole(params): Promise<SpaceRole>
Create a space role.

Available as part of the Role-Based Access Controls Beta.

Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.
Parameters
- params: {
      requestBody: {
          description: string;
          name: string;
          spacePermissions: string[];
      } & {
          [key: string]: unknown;
      };
  }
  - requestBody: {
        description: string;
        name: string;
        spacePermissions: string[];
    } & {
        [key: string]: unknown;
    }
Returns Promise<SpaceRole>
Returned if the requested space role is created.

Path
POST /space-roles @scopes-current write:configuration:confluence

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

deleteSpaceRole

deleteSpaceRole(params): Promise<DeleteSpaceRoleResponse>
Delete a space role

Available as part of the Role-Based Access Controls Beta.

Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.
Parameters
- params: {
  id: string;
  }
  - id: string
    Id of the space role
Returns Promise<DeleteSpaceRoleResponse>
Returned if the deletion of the space role was accepted.

Path
DELETE /space-roles/{id} @scopes-current write:configuration:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-space-roles-id-delete

getAvailableSpaceRoles

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

Available as part of the Role-Based Access Controls Beta.

Permissions required: Permission to access the Confluence site; if requesting a certain space's roles, permission to view the space.
Parameters
- params: {
      cursor?: string;
      limit?: number;
      principalId?: string;
      principalType?: PrincipalType;
      roleType?: string;
      spaceId?: string;
  } = {}
  - 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 roles to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.
  - OptionalprincipalId?: string
    The principal ID to filter results by. If specified, a principal-type must also be specified. Paired with a principal-type of ACCESS_CLASS, valid values include [anonymous-users, jsm-project-admins, authenticated-users, all-licensed-users, all-product-admins]
  - OptionalprincipalType?: PrincipalType
    The principal type to filter results by. If specified, a principal-id must also be specified.
  - OptionalroleType?: string
    The space role type to filter results by.
  - OptionalspaceId?: string
    The space ID for which to filter available space roles; if empty, return all available space roles for the tenant.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: SpaceRole[];
} & {
    [key: string]: unknown;
}>
Returned if the requested space roles are retrieved.
Path
GET /space-roles @scopes-current read:space.permission:confluence
See
- https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-space-roles-get
- https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-space-roles-get

getSpaceRoleAssignments

getSpaceRoleAssignments(params): Promise<{
    _links?: MultiEntityLinks;
    results?: SpaceRoleAssignment[];
} & {
    [key: string]: unknown;
}>
Retrieves the space role assignments.

Available as part of the Role-Based Access Controls Beta.

Permissions required: Permission to view the space.
Parameters
- params: {
      cursor?: string;
      id: number;
      limit?: number;
      principalId?: string;
      principalType?: PrincipalType;
      roleId?: string;
      roleType?: string;
  }
  - 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 for which to retrieve assignments.
  - Optionallimit?: number
    Maximum number of space roles to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.
  - OptionalprincipalId?: string
    Filters the returned role assignments to the provided principal id. If specified, a principal-type must also be specified. Paired with a principal-type of ACCESS_CLASS, valid values include [anonymous-users, jsm-project-admins, authenticated-users, all-licensed-users, all-product-admins]
  - OptionalprincipalType?: PrincipalType
    Filters the returned role assignments to the provided principal type. If specified, a principal-id must also be specified.
  - OptionalroleId?: string
    Filters the returned role assignments to the provided role ID.
  - OptionalroleType?: string
    Filters the returned role assignments to the provided role type.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: SpaceRoleAssignment[];
} & {
    [key: string]: unknown;
}>
Returned if the requested space role assignments are retrieved.
Path
GET /spaces/{id}/role-assignments @scopes-current read:space.permission:confluence
See
- https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-spaces-id-role-assignments-get
- https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-spaces-id-role-assignments-get

getSpaceRoleMode

getSpaceRoleMode(): Promise<{
mode?: "PRE_ROLES" | "ROLES_TRANSITION" | "ROLES";
} & {
[key: string]: unknown;
}>
Retrieves the space role mode.

Available as part of the Role-Based Access Controls Beta.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Returns Promise<{
mode?: "PRE_ROLES" | "ROLES_TRANSITION" | "ROLES";
} & {
[key: string]: unknown;
}>
Returned if the requested space role mode is returned.

Path
GET /space-role-mode @scopes-current read:configuration:confluence

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

getSpaceRolesById

getSpaceRolesById(params): Promise<SpaceRole & {
    _links?: {
        base?: string;
    } & {
        [key: string]: unknown;
    };
} & {
    [key: string]: unknown;
}>
Retrieves the space role by ID.

Available as part of the Role-Based Access Controls Beta.

Permissions required: Permission to access the Confluence site.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the space role to retrieve.
Returns Promise<SpaceRole & {
    _links?: {
        base?: string;
    } & {
        [key: string]: unknown;
    };
} & {
    [key: string]: unknown;
}>
Returned if the requested space role is retrieved.
Path
GET /space-roles/{id} @scopes-current read:space.permission:confluence
See
- https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-space-roles-id-get
- https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-space-roles-id-get

setSpaceRoleAssignments

setSpaceRoleAssignments(params): Promise<{
    _links?: MultiEntityLinks;
    results?: SpaceRoleAssignment[];
} & {
    [key: string]: unknown;
}>
Sets space role assignments as specified in the payload.

Available as part of the Role-Based Access Controls Beta.

Permissions required: Permission to manage roles in the space.
Parameters
- params: {
  id: number;
  requestBody: unknown[];
  }
  - id: number
    The ID of the space for which to retrieve assignments.
  - requestBody: unknown[]
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: SpaceRoleAssignment[];
} & {
    [key: string]: unknown;
}>
Returned if the requested update to space role assignments succeeds in its entirety.
Path
POST /spaces/{id}/role-assignments @scopes-current write:space.permission:confluence
See
- https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-eap#api-spaces-id-role-assignments-post
- https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-spaces-id-role-assignments-post

updateSpaceRole

updateSpaceRole(params): Promise<UpdateSpaceRoleResponse>
Update a space role.

Available as part of the Role-Based Access Controls Beta.

Permissions required: User must be an organization or site admin. Connect and Forge app users are not authorized to access this resource.
Parameters
- params: {
      id: string;
      requestBody: {
          anonymousReassignmentRoleId?: string;
          description: string;
          guestReassignmentRoleId?: string;
          name: string;
          spacePermissions: string[];
      } & {
          [key: string]: unknown;
      };
  }
  - id: string
    Id of the space role
  - requestBody: {
        anonymousReassignmentRoleId?: string;
        description: string;
        guestReassignmentRoleId?: string;
        name: string;
        spacePermissions: string[];
    } & {
        [key: string]: unknown;
    }
Returns Promise<UpdateSpaceRoleResponse>
Returned if the update of the space role was accepted.

Path
PUT /space-roles/{id} @scopes-current write:configuration:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles#api-space-roles-id-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class SpaceRolesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns SpaceRolesService

Methods

createSpaceRole

Parameters

requestBody: { description: string; name: string; spacePermissions: string[]; } & { [key: string]: unknown; }

Returns Promise<SpaceRole>

Path

See

deleteSpaceRole

Parameters

id: string

Returns Promise<DeleteSpaceRoleResponse>

Path

See

getAvailableSpaceRoles

Parameters

Optionalcursor?: string

Optionallimit?: number

OptionalprincipalId?: string

OptionalprincipalType?: PrincipalType

OptionalroleType?: string

OptionalspaceId?: string

Returns Promise<{ _links?: MultiEntityLinks; results?: SpaceRole[]; } & { [key: string]: unknown; }>

Path

See

getSpaceRoleAssignments

Parameters

Optionalcursor?: string

id: number

Optionallimit?: number

OptionalprincipalId?: string

OptionalprincipalType?: PrincipalType

OptionalroleId?: string

OptionalroleType?: string

Returns Promise<{ _links?: MultiEntityLinks; results?: SpaceRoleAssignment[]; } & { [key: string]: unknown; }>

Path

See

getSpaceRoleMode

Returns Promise<{ mode?: "PRE_ROLES" | "ROLES_TRANSITION" | "ROLES"; } & { [key: string]: unknown; }>

Path

See

getSpaceRolesById

Parameters

id: number

Returns Promise<SpaceRole & { _links?: { base?: string; } & { [key: string]: unknown; }; } & { [key: string]: unknown; }>

Path

See

setSpaceRoleAssignments

Parameters

id: number

requestBody: unknown[]

Returns Promise<{ _links?: MultiEntityLinks; results?: SpaceRoleAssignment[]; } & { [key: string]: unknown; }>

Path

See

updateSpaceRole

Parameters

id: string

requestBody: { anonymousReassignmentRoleId?: string; description: string; guestReassignmentRoleId?: string; name: string; spacePermissions: string[]; } & { [key: string]: unknown; }

Returns Promise<UpdateSpaceRoleResponse>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

requestBody: {
description: string;
name: string;
spacePermissions: string[];
} & {
[key: string]: unknown;
}

`Optional`cursor?: string

`Optional`limit?: number

`Optional`principalId?: string

`Optional`principalType?: PrincipalType

`Optional`roleType?: string

`Optional`spaceId?: string

Returns Promise<{
_links?: MultiEntityLinks;
results?: SpaceRole[];
} & {
[key: string]: unknown;
}>

`Optional`cursor?: string

`Optional`limit?: number

`Optional`principalId?: string

`Optional`principalType?: PrincipalType

`Optional`roleId?: string

`Optional`roleType?: string

Returns Promise<{
_links?: MultiEntityLinks;
results?: SpaceRoleAssignment[];
} & {
[key: string]: unknown;
}>

Returns Promise<{
mode?: "PRE_ROLES" | "ROLES_TRANSITION" | "ROLES";
} & {
[key: string]: unknown;
}>

Returns Promise<SpaceRole & {
_links?: {
base?: string;
} & {
[key: string]: unknown;
};
} & {
[key: string]: unknown;
}>

Returns Promise<{
_links?: MultiEntityLinks;
results?: SpaceRoleAssignment[];
} & {
[key: string]: unknown;
}>

requestBody: {
anonymousReassignmentRoleId?: string;
description: string;
guestReassignmentRoleId?: string;
name: string;
spacePermissions: string[];
} & {
[key: string]: unknown;
}

`Protected` `Static`initialize