List Provider Customers
Authorization<token>
Bearer token
In: header
X-Organization-ID<token>
Tenant or organization identifier
In: header
Query Parameters
page?integer
0-based page (default 0).
Format
int32pageSize?integer
-1 = all matches (no server row cap; prefer paginated 1..100 for large data sets). Otherwise 1..100 per page (see ListVirtualMachinesRequest).
Format
int32search?string
Case-insensitive match on client organization name or any member email (owners/members via roles & groups).
activityFilter?string
Default / UNSPECIFIED means ALL (same as PROVIDER_CUSTOMER_ACTIVITY_FILTER_ALL).
- PROVIDER_CUSTOMER_ACTIVITY_FILTER_ALL: All customers (any VM history with this provider, including when every VM is soft-deleted).
Value in
"PROVIDER_CUSTOMER_ACTIVITY_FILTER_UNSPECIFIED" | "PROVIDER_CUSTOMER_ACTIVITY_FILTER_ALL" | "PROVIDER_CUSTOMER_ACTIVITY_FILTER_ACTIVE" | "PROVIDER_CUSTOMER_ACTIVITY_FILTER_INACTIVE"Response Body
application/json
curl -X GET "https://api.nrings.io/v1/provider/customers?page&pageSize&search&activityFilter" \ -H "Authorization: Bearer {your_token}" \ -H "X-Organization-ID: {your_org_id}"{
"customers": [
{
"organizationId": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"organizationEnforceMfa": true,
"lastLoginTime": "2019-08-24T14:15:22Z",
"organizationName": "string",
"addressSummary": "string",
"vmActivityStatus": "PROVIDER_CUSTOMER_VM_ACTIVITY_STATUS_UNSPECIFIED"
}
],
"totalCount": 0
}