Interface ConfluenceRestClientContentRestrictionsApi

@Generated("io.github.primelib.primecodegen") public interface ConfluenceRestClientContentRestrictionsApi
ConfluenceRestClientContentRestrictionsApi

  • Method Details

    • GetContentByIDRestrictionV1

      ContentRestrictionArray GetContentByIDRestrictionV1(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      GetContentByIDRestrictionV1 Get restrictions Returns the restrictions on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
      Parameters:
      id - The ID of the content to be queried for its restrictions.
      expand - A multi-value parameter indicating which properties of the content restrictions to expand. By default, the following objects are expanded: `restrictions.user`, `restrictions.group`. - `restrictions.user` returns the piece of content that the restrictions are applied to. - `restrictions.group` returns the piece of content that the restrictions are applied to. - `content` returns the piece of content that the restrictions are applied to.
      start - The starting index of the users and groups in the returned restrictions.
      limit - The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.

    • PutContentByIDRestrictionV1

      ContentRestrictionArray PutContentByIDRestrictionV1(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand, @NotNull @NotNull Object payload)
      PutContentByIDRestrictionV1 Update restrictions Updates restrictions for a piece of content. This removes the existing restrictions and replaces them with the restrictions in the request. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
      Parameters:
      id - The ID of the content to update restrictions for.
      expand - A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand. - `restrictions.user` returns the piece of content that the restrictions are applied to. Expanded by default. - `restrictions.group` returns the piece of content that the restrictions are applied to. Expanded by default. - `content` returns the piece of content that the restrictions are applied to.
      payload - The updated restrictions for the content.

    • PostContentByIDRestrictionV1

      ContentRestrictionArray PostContentByIDRestrictionV1(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand, @NotNull @NotNull Object payload)
      PostContentByIDRestrictionV1 Add restrictions Adds restrictions to a piece of content. Note, this does not change any existing restrictions on the content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
      Parameters:
      id - The ID of the content to add restrictions to.
      expand - A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand. - `restrictions.user` returns the piece of content that the restrictions are applied to. Expanded by default. - `restrictions.group` returns the piece of content that the restrictions are applied to. Expanded by default. - `content` returns the piece of content that the restrictions are applied to.
      payload - The restrictions to be added to the content.

    • DeleteContentByIDRestrictionV1

      ContentRestrictionArray DeleteContentByIDRestrictionV1(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand)
      DeleteContentByIDRestrictionV1 Delete restrictions Removes all restrictions (read and update) on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
      Parameters:
      id - The ID of the content to remove restrictions from.
      expand - A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand. - `restrictions.user` returns the piece of content that the restrictions are applied to. Expanded by default. - `restrictions.group` returns the piece of content that the restrictions are applied to. Expanded by default. - `content` returns the piece of content that the restrictions are applied to.

    • GetContentByIDRestrictionByOperationV1

      GetRestrictionsByOperation GetContentByIDRestrictionByOperationV1(@NotNull @NotNull String id, @Nullable @Nullable List<String> expand)
      GetContentByIDRestrictionByOperationV1 Get restrictions by operation Returns restrictions on a piece of content by operation. This method is similar to [Get restrictions](#api-content-id-restriction-get) except that the operations are properties of the return object, rather than items in a results array. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
      Parameters:
      id - The ID of the content to be queried for its restrictions.
      expand - A multi-value parameter indicating which properties of the content restrictions to expand. - `restrictions.user` returns the piece of content that the restrictions are applied to. Expanded by default. - `restrictions.group` returns the piece of content that the restrictions are applied to. Expanded by default. - `content` returns the piece of content that the restrictions are applied to.

    • GetContentByIDRestrictionByOperationByOperationKeyV1

      ContentRestriction GetContentByIDRestrictionByOperationByOperationKeyV1(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @Nullable @Nullable List<String> expand, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      GetContentByIDRestrictionByOperationByOperationKeyV1 Get restrictions for operation Returns the restictions on a piece of content for a given operation (read or update). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
      Parameters:
      id - The ID of the content to be queried for its restrictions.
      operationKey - The operation type of the restrictions to be returned.
      expand - A multi-value parameter indicating which properties of the content restrictions to expand. - `restrictions.user` returns the piece of content that the restrictions are applied to. Expanded by default. - `restrictions.group` returns the piece of content that the restrictions are applied to. Expanded by default. - `content` returns the piece of content that the restrictions are applied to.
      start - The starting index of the users and groups in the returned restrictions.
      limit - The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.

    • GetContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1

      void GetContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupId)
      GetContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 Get content restriction status for group Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a `read` restriction for the `123456` group id, the following request will return `true`: `/wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456` Note that a response of `true` does not guarantee that the group can view the page, as it does not account for account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence permissions](https://confluence.atlassian.com/x/_AozKw). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
      Parameters:
      id - The ID of the content that the restriction applies to.
      operationKey - The operation that the restriction applies to.
      groupId - The id of the group to be queried for whether the content restriction applies to it.

    • PutContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1

      void PutContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupId)
      PutContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 Add group to content restriction Adds a group to a content restriction by Group Id. That is, grant read or update permission to the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
      Parameters:
      id - The ID of the content that the restriction applies to.
      operationKey - The operation that the restriction applies to.
      groupId - The groupId of the group to add to the content restriction.

    • DeleteContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1

      void DeleteContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @NotNull @NotNull String groupId)
      DeleteContentByIDRestrictionByOperationByOperationKeyByGroupIDByGroupIDV1 Remove group from content restriction Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
      Parameters:
      id - The ID of the content that the restriction applies to.
      operationKey - The operation that the restriction applies to.
      groupId - The id of the group to remove from the content restriction.

    • GetContentByIDRestrictionByOperationByOperationKeyUserV1

      void GetContentByIDRestrictionByOperationByOperationKeyUserV1(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      GetContentByIDRestrictionByOperationByOperationKeyUserV1 Get content restriction status for user Returns whether the specified content restriction applies to a user. For example, if a page with `id=123` has a `read` restriction for a user with an account ID of `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`, the following request will return `true`: `/wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192` Note that a response of `true` does not guarantee that the user can view the page, as it does not account for account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence permissions](https://confluence.atlassian.com/x/_AozKw). **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
      Parameters:
      id - The ID of the content that the restriction applies to.
      operationKey - The operation that is restricted.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • PutContentByIDRestrictionByOperationByOperationKeyUserV1

      void PutContentByIDRestrictionByOperationByOperationKeyUserV1(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      PutContentByIDRestrictionByOperationByOperationKeyUserV1 Add user to content restriction Adds a user to a content restriction. That is, grant read or update permission to the user for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
      Parameters:
      id - The ID of the content that the restriction applies to.
      operationKey - The operation that the restriction applies to.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • DeleteContentByIDRestrictionByOperationByOperationKeyUserV1

      void DeleteContentByIDRestrictionByOperationByOperationKeyUserV1(@NotNull @NotNull String id, @NotNull @NotNull String operationKey, @Nullable @Nullable String key, @Nullable @Nullable String username, @Nullable @Nullable String accountId)
      DeleteContentByIDRestrictionByOperationByOperationKeyUserV1 Remove user from content restriction Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
      Parameters:
      id - The ID of the content that the restriction applies to.
      operationKey - The operation that the restriction applies to.
      key - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      username - This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      accountId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.