IRironcorelabs
Tenant

Tenant List

List all tenants associated with the calling vendor organization.

get/1/tenants

Request

Query parameters

querystring

Tenant ID or name to filter to

sortColumn'name' | 'id' | 'created' | 'updated'

Field to use for sorting

status'accepted' | 'not-accepted' | 'archived'

Tenant status to filter to

sortDirection'asc' | 'desc'

Direction to sort

pageSizeinteger

Number of entries returned per page

pageinteger

Page number to return

Headers

icl-requestor-idstring required

ID of requesting user/service

Response

Result of listing all tenants associated with the calling vendor.

pageinteger required

Current response page number

totalPagesinteger required

Total number of response pages

Example response

{
  "result": [
    {
      "id": "tenant-icl",
      "tags": [
        {
          "created": "2022-01-13T21:44:43.653Z"
        }
      ],
      "createdBy": {
        "id": "vendor",
        "name": "Vendor",
        "type": "Vaa"
      },
      "created": "2022-01-13T21:44:43.653Z",
      "updated": "2022-01-13T21:44:43.653Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.