Read the Provider owning an API configuration

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

GET /api/v1/vendors/{id}/supplier

Installation credential or explicitly granted platform administrator required. Provider membership and customer ownership alone do not grant access. Returns the Provider identity and name, or null when no association exists, including an unknown configuration. Never returns credentials or procurement values.

Operation: getConfigurationProvider.

Authentication

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

JSON

[
  {
    "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.

Shell

curl --fail-with-body -X GET "$NIU_ORIGIN/api/v1/vendors/{id}/supplier" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN"

Parameters

id

Location: path. Required.

JSON

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

Request body

No request body is declared.

Responses

HTTP 200

Provider association or null.

Content type: application/json.

JSON

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "required": [
            "id",
            "name"
          ],
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string"
            }
          }
        }
      ]
    }
  }
}

HTTP 401

Invalid or missing administrative credential.

HTTP 403

Installation administration required.

HTTP 503

Storage unavailable.

Behavior and supported scope

Installation credential or explicitly granted platform administrator required. Provider membership and customer ownership alone do not grant access. Returns the Provider identity and name, or null when no association exists, including an unknown configuration. Never returns credentials or procurement values.

Supported scope: implemented