getUserProperties method

Future<UserPropertyKeyArray> getUserProperties({
  1. required String userId,
  2. int? start,
  3. int? limit,
})

Returns the properties for a user as list of property keys. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

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

Implementation

Future<UserPropertyKeyArray> getUserProperties(
    {required String userId, int? start, int? limit}) async {
  return UserPropertyKeyArray.fromJson(await _client.send(
    'get',
    'wiki/rest/api/user/{userId}/property',
    pathParameters: {
      'userId': userId,
    },
    queryParameters: {
      if (start != null) 'start': '$start',
      if (limit != null) 'limit': '$limit',
    },
  ));
}