Skip to main content

Attributes Interface

Overview​

Each Connector has to implement the Attributes interface. This interface provides information about supported Attributes of the Connector. Attributes are specific to implementation and gives information about the data that can be exchanged and properly parsed by the Connector.

For more information, refer to Connector Architecture.

Connector NG​

How it works​

In Connector NG, the Attributes interface is consolidated and per-operation. Instead of a single attributes endpoint for the whole connector, each operation that requires user input has its own attribute-schema endpoint, whose path ends in /attributes.

There is no separate /validate endpoint — attribute validation is the responsibility of the Core based on the attribute definitions returned by the connector. Validation should be also part of operation at connector side but Core cannot enforce that behavior.

Per-operation listing vs the Attributes v2 API

This per-operation /attributes listing (which attributes an operation needs) is distinct from the Attributes v2 API — the /v2/attributes surface in the connector.common.v2 common-interface package (the versioned namespace of cross-cutting NG interfaces) — a definition registry plus a stateless dependsOn callback surface that resolves dynamic attribute content for NG (stateless) connectors. See Attribute Callbacks — Attributes v2 model.

Endpoint pattern​

The provider API defines the method and the request of each attribute-schema endpoint, so take both from its API reference. For example:

Provider APIEndpointRequest body
Discovery Provider v2GET /v2/discoveryProvider/{resource}/attributesNone: the schema needs no context
Authority Provider v3POST /v3/authorityProvider/certificates/issue/attributesauthorityAttributes and raProfileAttributes, the context the schema depends on
Cryptography Provider v2POST /v2/cryptographyProvider/operations/sign/attributestokenAttributes, tokenProfileAttributes and keyMeta, the context the schema depends on

Each endpoint returns the list of Attributes required or accepted by the operation, or an empty list if no attributes are needed.

Response codes​

Response codeDescription
200Attributes returned (empty array if none)
400Bad request — see Error Handling
404Not found — see Error Handling
422Validation failed — see Error Handling

Developer-friendly design​

Each /attributes endpoint references a specific schema in the OpenAPI specification so that developers can see the exact required fields for that operation when using code generation tools.

This approach:

  • Keeps attribute definitions close to the operation they belong to
  • Enables operation-specific attribute schemas
  • Allows the Core to retrieve and resolve Attributes before executing any operation on the Connector
  • Supports flexible, operation-level attribute definitions that can differ per object or operation type

Processes​

Get Attributes for an operation (NG)​

Get Attributes for an operation (NG) diagram

Get Attributes for an operation (NG) diagram

100%Scroll to explore · Esc to close
Get Attributes for an operation (NG) diagram
Get Attributes for an operation (NG) diagram
Open full diagram ↗

Execute operation with Attributes (NG)​

Execute operation with Attributes (NG) diagram

Execute operation with Attributes (NG) diagram

100%Scroll to explore · Esc to close
Execute operation with Attributes (NG) diagram
Execute operation with Attributes (NG) diagram
Open full diagram ↗

For more information about how Attributes can be used and implemented, refer to Contribution guide - Attributes and Callbacks.


Legacy Connectors​

How it works​

The Attributes interface provides information about all supported mandatory or optional Attributes for the Connector. Attributes are necessary to manage Connector specific objects. For more information about how Attributes can be used and implemented, including details about Attribute types, refer to Contribution guide - Attributes and Callbacks.

Each Connector implements interface for listing available Attributes and their validation.

Processes​

Get Attributes​

Because each Connector defines its own specific Attributes, we need to get information about that before we can start creating and managing objects.

Get Attributes diagram

Get Attributes diagram

100%Scroll to explore · Esc to close
Get Attributes diagram
Get Attributes diagram
Open full diagram ↗

Create object using Attributes​

When you have a list of available Attributes supported by the Connector, you can create objects like Authority, Credential, Discovery, Entity, etc. For this operation you need to provide at least mandatory Attribute values that are validated against the definition and if success, the object is created.

note

The following example is creating Credential object. The same approach can be used for other objects that can be created based on the Attributes definition and specific Connector.

Create object using Attributes diagram

Create object using Attributes diagram

100%Scroll to explore · Esc to close
Create object using Attributes diagram
Create object using Attributes diagram
Open full diagram ↗

Specification and example​

You can find specification and information about the legacy Attributes interface on the following locations: