Package io.github.primelib.confluence4j.rest.v1.client

Interface ConfluenceRestClientUserPropertiesApi

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

  • Method Details

    • GetUserByUserIDPropertyV1

      UserPropertyKeyArray GetUserByUserIDPropertyV1(@NotNull @NotNull String userId, @Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      GetUserByUserIDPropertyV1 Get user properties Returns the properties for a user as list of property keys. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored against a user are on a Confluence site level and not space/content level. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      userId - The account ID of the user to be queried for its properties.
      start - The starting index of the returned properties.
      limit - The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.

    • GetUserByUserIDPropertyByKeyV1

      UserProperty GetUserByUserIDPropertyByKeyV1(@NotNull @NotNull String userId, @NotNull @NotNull String key)
      GetUserByUserIDPropertyByKeyV1 Get user property Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored against a user are on a Confluence site level and not space/content level. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      userId - The account ID of the user to be queried for its properties.
      key - The key of the user property.

    • PutUserByUserIDPropertyByKeyV1

      void PutUserByUserIDPropertyByKeyV1(@NotNull @NotNull String userId, @NotNull @NotNull String key, @NotNull @NotNull UserPropertyUpdate payload)
      PutUserByUserIDPropertyByKeyV1 Update user property Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored against a user are on a Confluence site level and not space/content level. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      userId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
      key - The key of the user property.
      payload - The user property to be updated.

    • PostUserByUserIDPropertyByKeyV1

      void PostUserByUserIDPropertyByKeyV1(@NotNull @NotNull String userId, @NotNull @NotNull String key, @NotNull @NotNull UserPropertyCreate payload)
      PostUserByUserIDPropertyByKeyV1 Create user property by key Creates a property for a user. For more information about user properties, see [Confluence entity properties] (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored against a user are on a Confluence site level and not space/content level. `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      userId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
      key - The key of the user property.
      payload - The user property to be created.

    • DeleteUserByUserIDPropertyByKeyV1

      void DeleteUserByUserIDPropertyByKeyV1(@NotNull @NotNull String userId, @NotNull @NotNull String key)
      DeleteUserByUserIDPropertyByKeyV1 Delete user property Deletes a property for the given user. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored against a user are on a Confluence site level and not space/content level. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).
      Parameters:
      userId - The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
      key - The key of the user property.