POpolytomic
Harbors

List Harbor Users

Changed on

Lists Harbor-only users assigned to a Harbor.

The response contains only Harbor-only users currently assigned to this Harbor.

get/api/harbors/{harbor_id}/users

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

harbor_idstring uuid required

Unique identifier of the Harbor

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Query parameters

limitinteger

Maximum number of assigned users to return. Defaults to 50 and cannot exceed 50.

Example:50
page_tokenstring

Opaque pagination cursor returned by the previous request

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "email": "analyst@example.com",
      "harbor_ids": [
        "248df4b7-aa70-47b8-a036-33ac447e668d"
      ],
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "status": "invited"
    }
  ],
  "pagination": {
    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
  }
}

Changes

  • d80b0fdea14eRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

  • 42f4cfea0ea3Revision changes
    • breaking

      for the query request parameter limit, default value 50 was added

    • warning

      for the query request parameter limit, the max was set to 50.00

    • warning

      for the query request parameter limit, the min was set to 1.00