Use the POST /sp/adapters endpoint to create a new SP adapter instance. If the SP adapter is not properly configured, a 422 status code is returned along with a list of validation errors that must be corrected.

Status codes

Code Reason
201 Adapter created.
400 The request was improperly formatted or contained invalid fields.
403 PingFederate does not have its SP role enabled. Operation not available.
404 Resource not found.
422 Validation error(s) occurred.

SpAdapter - An SP adapter instance.

Property Type Description
attributeContract SpAdapterAttributeContract The list of attributes that the SP adapter provides.
configuration * PluginConfiguration Plugin instance configuration.
id * string The ID of the plugin instance. The ID cannot be modified once the instance is created.
Note: Ignored when specifying a connection’s adapter override.
name * string The plugin instance name. The name cannot be modified once the instance is created.
Note: Ignored when specifying a connection’s adapter override.
parentRef ResourceLink The reference to this plugin’s parent instance. The parent reference is only accepted if the plugin type supports parent instances.
Note: This parent reference is required if this plugin instance is used as an overriding plugin (e.g. connection adapter overrides)
pluginDescriptorRef * ResourceLink Reference to the plugin descriptor for this instance. The plugin descriptor cannot be modified once the instance is created.
Note: Ignored when specifying a connection’s adapter override.
targetApplicationInfo SpAdapterTargetApplicationInfo The target application’s name and icon URL

ResourceLink - A reference to a resource.

Property Type Description
id * string The ID of the resource.
location string A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null.

PluginConfiguration - Configuration settings for a plugin instance.

Property Type Description
fields array[ConfigField] List of configuration fields.
tables array[ConfigTable] List of configuration tables.

ConfigTable - A plugin configuration table populated with values.

Property Type Description
inherited boolean Whether this table is inherited from its parent instance. If true, the rows become read-only. The default value is false.
name * string The name of the table.
rows array[ConfigRow] List of table rows.

ConfigRow - A row of configuration values for a plugin configuration table.

Property Type Description
defaultRow boolean Whether this row is the default.
fields * array[ConfigField] The configuration fields in the row.

ConfigField - A plugin configuration field value.

Property Type Description
encryptedValue string For encrypted or hashed fields, this attribute contains the encrypted representation of the field’s value, if a value is defined. If you do not want to update the stored value, this attribute should be passed back unchanged.
inherited boolean Whether this field is inherited from its parent instance. If true, the value/encrypted value properties become read-only. The default value is false.
name * string The name of the configuration field.
value string The value for the configuration field. For encrypted or hashed fields, GETs will not return this attribute. To update an encrypted or hashed field, specify the new value in this attribute.

SpAdapterAttributeContract - A set of attributes exposed by an SP adapter.

Property Type Description
coreAttributes array[SpAdapterAttribute] A list of read-only attributes that are automatically populated by the SP adapter descriptor.
extendedAttributes array[SpAdapterAttribute] A list of additional attributes that can be returned by the SP adapter. The extended attributes are only used if the adapter supports them.
inherited boolean Whether this attribute contract is inherited from its parent instance. If true, the rest of the properties in this model become read-only. The default value is false.

SpAdapterAttribute - An attribute for the SP adapter attribute contract.

Property Type Description
name * string The name of this attribute.

SpAdapterTargetApplicationInfo - Target Application Information exposed by an SP adapter.

Property Type Description
applicationIconUrl string The application icon URL.
applicationName string The application name.
inherited boolean Specifies Whether target application information is inherited from its parent instance. If true, the rest of the properties in this model become read-only. The default value is false.