API

List Provider business members

Generated from the checked-in source. Do not edit this reference by hand.

GET /api/v1/providers/{provider}/members

Requires platform management permission. Lists saved memberships ordered by member name and internal identity. active is false when membership is disabled or the member account is revoked; revoked reports account revocation separately. No tokens, merchant secrets or procurement amounts are returned. Internal operator identities are for routing, not product labels.

Operation: listProviderMembers.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

[
  {
    "bearerAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

curl --fail-with-body -X GET "$NIU_ORIGIN/api/v1/providers/{provider}/members" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN"

Parameters

provider

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

Request body

No request body is declared.

Responses

HTTP 200

Saved membership list, including inactive or revoked members

Content type: application/json.

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "operator_id",
          "name",
          "role",
          "active",
          "revoked"
        ],
        "properties": {
          "operator_id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "role": {
            "type": "string",
            "enum": [
              "manager",
              "viewer"
            ]
          },
          "active": {
            "type": "boolean"
          },
          "revoked": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

HTTP 400

Invalid identifier

HTTP 401

Authentication required

HTTP 403

Platform management permission required

HTTP 409

Provider missing or deleted

HTTP 503

Storage unavailable

Behavior and supported scope

Supported scope: implemented