Package com.atlassian.confluence.plugins.restapi.resources

Class GlobalPermissionResource

java.lang.Object
com.atlassian.confluence.plugins.restapi.resources.GlobalPermissionResource
@Consumes("application/json") @Produces("application/json") @Path("/permissions") public class GlobalPermissionResource extends Object
REST API for global permission.
Since:
9.2.6

  • Constructor Details

    • GlobalPermissionResource

      @Inject public GlobalPermissionResource(GlobalPermissionService globalPermissionService)

  • Method Details

    • getAllGlobalPermissions

      @GET public jakarta.ws.rs.core.Response getAllGlobalPermissions()

      Get all global permissions

      Returns:
      all permissions granted to users and groups globally

    • getPermissionsGrantedToUser

      @GET @Path("/user/{user}") public jakarta.ws.rs.core.Response getPermissionsGrantedToUser(@PathParam("user") String user)

      Gets the global permissions granted to a user.

      Parameters:
      user - the key or username of the user to look up

    • getPermissionsGrantedToGroup

      @GET @Path("/group/{groupName}") public jakarta.ws.rs.core.Response getPermissionsGrantedToGroup(@PathParam("groupName") String groupName)

      Gets the global permissions granted to a group.

      Parameters:
      groupName - the group name

    • getPermissionsGrantedToAnonymousUsers

      @GET @Path("/anonymous") public jakarta.ws.rs.core.Response getPermissionsGrantedToAnonymousUsers()

      Get the permissions granted to an anonymous users.

    • getPermissionsGrantedToUnlicensedUsers

      @GET @Path("/unlicensed") public jakarta.ws.rs.core.Response getPermissionsGrantedToUnlicensedUsers()

      Get the permissions granted to an unlicensed users.

    • grantPermissionsToGroup

      @PUT @Path("group/{groupName}/grant") public jakarta.ws.rs.core.Response grantPermissionsToGroup(@PathParam("groupName") String groupName, Set<OperationDescription> permissions)

      Grant global permissions to a group.

      Parameters:
      permissions - the permissions being added

    • revokePermissionsFromGroup

      @PUT @Path("group/{groupName}/revoke") public jakarta.ws.rs.core.Response revokePermissionsFromGroup(@PathParam("groupName") String groupName, Set<OperationDescription> permissions)

      Revoke global permissions from a group.

      Parameters:
      permissions - the permissions being revoked

    • grantPermissionsToUser

      @PUT @Path("user/{user}/grant") public jakarta.ws.rs.core.Response grantPermissionsToUser(@PathParam("user") String user, Set<OperationDescription> permissions)

      Grant global permissions to a user.

      Parameters:
      user - userKey or username of the user to look up
      permissions - the permissions being added

    • revokePermissionsFromUser

      @PUT @Path("user/{user}/revoke") public jakarta.ws.rs.core.Response revokePermissionsFromUser(@PathParam("user") String user, Set<OperationDescription> permissions)

      Revoke global permissions from a user.

      Parameters:
      user - userKey or username of the user to look up
      permissions - the permissions being revoked

    • grantPermissionsToAnonymousUsers

      @PUT @Path("anonymous/grant") public jakarta.ws.rs.core.Response grantPermissionsToAnonymousUsers(Set<OperationDescription> permissions)

      Grant global permissions to anonymous users.

      Parameters:
      permissions - the permissions being added

    • revokePermissionsFromAnonymousUsers

      @PUT @Path("anonymous/revoke") public jakarta.ws.rs.core.Response revokePermissionsFromAnonymousUsers(Set<OperationDescription> permissions)

      Revoke global permissions from anonymous users.

      Parameters:
      permissions - the permissions being revoked

    • grantPermissionsToUnlicensedUsers

      @PUT @Path("unlicensed/grant") public jakarta.ws.rs.core.Response grantPermissionsToUnlicensedUsers(Set<OperationDescription> permissions)

      Grant global permissions to unlicensed users.

      Parameters:
      permissions - the permissions being added

    • revokePermissionsFromUnlicensedUsers

      @PUT @Path("unlicensed/revoke") public jakarta.ws.rs.core.Response revokePermissionsFromUnlicensedUsers(Set<OperationDescription> permissions)

      Revoke global permissions from unlicensed users.

      Parameters:
      permissions - the permissions being revoked

    • setPermissions

      @PUT public jakarta.ws.rs.core.Response setPermissions(Set<SpacePermissionsForSubject> permissionsForSubjects)

      Sets global permissions to multiple users/groups. Request should contain all permissions that user/group will have. If permission is absent in the request, but was granted before, it will be revoked.

      Parameters:
      permissionsForSubjects - the global permissions being set to multiple users/groups