Axway · Schema

Client

API ManagementEnterpriseIntegrationSecurity

Properties

Name	Type	Description
_id	string	Document ID of the client.
client_id	string	Identifier of the client to use for authentication.
guid	string	`guid` of the client.
name	string	Name of the client.
org_guid	string	`guid` of the organization the client belongs to.
roles	array	Array of org-level role identifiers that are assigned to the client.
tags	array	Tags assigned to the client.
type	string	Authentication method for the client.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Client",
  "title": "Client",
  "type": "object",
  "required": [
    "guid",
    "name",
    "org_guid",
    "roles",
    "tags"
  ],
  "unevaluatedProperties": false,
  "allOf": [
    {
      "$ref": "#/components/schemas/DefaultFields"
    }
  ],
  "if": {
    "type": "object",
    "title": "Certificate Auth",
    "required": [
      "type"
    ],
    "properties": {
      "type": {
        "type": "string",
        "enum": [
          "certificate"
        ]
      }
    }
  },
  "then": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "key_id": {
        "type": "string",
        "description": "Identifier of the public key used for the client.",
        "readOnly": true
      }
    }
  },
  "else": {
    "type": "object",
    "title": "Secret Auth",
    "additionalProperties": false
  },
  "properties": {
    "_id": {
      "type": "string",
      "description": "Document ID of the client.",
      "readOnly": true,
      "deprecated": true,
      "example": "507f1f77bcf86cd799439011"
    },
    "client_id": {
      "type": "string",
      "description": "Identifier of the client to use for authentication.",
      "example": "507f1f77bcf86cd799439011"
    },
    "guid": {
      "type": "string",
      "format": "uuid",
      "description": "`guid` of the client.",
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "description": "Name of the client.",
      "x-no-tags": true,
      "example": "Example Name"
    },
    "org_guid": {
      "type": "string",
      "format": "uuid",
      "description": "`guid` of the organization the client belongs to.",
      "example": "example_value"
    },
    "roles": {
      "type": "array",
      "description": "Array of org-level role identifiers that are assigned to the client.",
      "default": [],
      "items": {
        "type": "string",
        "enum": [
          "administrator",
          "developer",
          "auditor",
          "consumer",
          "usage_reporter",
          "api_central_admin"
        ]
      },
      "example": [
        "administrator"
      ]
    },
    "tags": {
      "type": "array",
      "description": "Tags assigned to the client.",
      "default": [],
      "minItems": 0,
      "uniqueItems": true,
      "maxItems": 30,
      "items": {
        "type": "string",
        "maxLength": 40
      },
      "example": [
        "example_value"
      ]
    },
    "type": {
      "type": "string",
      "description": "Authentication method for the client.",
      "default": "secret",
      "enum": [
        "secret",
        "certificate"
      ],
      "example": "secret"
    }
  }
}