[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator

Get Paginated Tenants

Description

Retrieves all customer organizations managed by a specified provider organization.

Request

Request

URL

URL


post
https://{api_host}/mgmt/orgs/{orgId}/tenants/paginated
Copy

Path Parameters

Path Parameters

string
orgId Required

  • ID of the MSP organization in CSP.

Parameter Serialization Style: simple

Query Parameters

Query Parameters

string
order_by Optional

  • Sequence to retrieves customer organizations.

Parameter Serialization Style: form

integer
page_limit Optional

  • Maximum number to return in response. Defaults to 100

Parameter Serialization Style: form

integer
page_start Optional

  • Start index of records to fetch. Defaults to 1

Parameter Serialization Style: form

Header Parameters

Header Parameters

string
csp-auth-token Optional

  • Access token generated from refresh token for authentication.

Parameter Serialization Style: simple

Request Body

Request Body

CustomerFilter of mimetype application/json Required

Payload to retrieve customer organizations managed by a specified provider organization.

This request body class requires all of the following: SearchFilter, InlineCustomerFilter1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns array of Org of type */*
This response body class contains all of the following: BaseEntity, InlineOrg1

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "csp-auth-token: string" -H "Content-Type: application/json" -d '{}' https://{api_host}/mgmt/orgs/{orgId}/tenants/paginated


Feedback

Was this page helpful?