<access-service>/api/v1/users/{userId}/items/count

URL structure

https://access-service.xy-company.com/api/v1/users/{userId}/items/count

where {userId} is the ID of a Covata user.

Supported methods and overview

• GET - used to retrieve the total number of Secure Objects currently owned by a Covata user, based on the user's ID.

Note: This method takes no parameters.

Detailed description

This API endpoint retrieves the total number of Secure Objects currently owned by a Covata user, based on the Covata user's ID.

A Covata user's ID can be obtained by calling the GET method of the <access-service>/api/v1/users API endpoint, which retrieves a list of field information for all Covata Platform users who can be filtered through a variety of 'search' criteria.

This endpoint is useful for determining the number of Secure Objects that a Covata user owns, before transferring the ownership of these items over to another user.

Note: Although this endpoint contains items in its URL, calling it only returns the total number of Secure Objects (i.e. collections are not counted). However, when transferring the ownership of items from one Covata user to another, all of that user's items (i.e. all Secure Objects and collections) are transferred.

Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide):

• User administrator

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Returns

A JSON-formatted response containing the following members:

• count - The total number of Secure Objects currently owned by the Covata user specified in this endpoint's URL.

  Example:

  {
    "count": 16
  }