Use the PUT /oauth/outOfBandAuthPlugins/{{instanceId}} endpoint to update an Out of Band authenticator plugin instance.

Path parameters

Parameter Value Description
instanceId string(required) ID of Out of Band authenticator plugin instance.

Status codes

Code Reason
200 Out of Band Authenticator updated.
400 The request was improperly formatted or contained invalid fields.
404 Resource not found.
422 Validation error(s) occurred.

OutOfBandAuthenticator - An out of band authenticator plugin instance.

Property Type Description
attributeContract OutOfBandAuthAttributeContract The list of attributes that the out of band authenticator plugin 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.

OutOfBandAuthAttributeContract - A set of attributes exposed by an out of band authenticator plugin instance.

Property Type Description
coreAttributes * array[OutOfBandAuthAttribute] A list of out of band authenticator attributes.
extendedAttributes array[OutOfBandAuthAttribute] A list of additional attributes that can be returned by the out of band authenticator plugin instance. The extended attributes are only used if the plugin supports them.

OutOfBandAuthAttribute - An attribute for the out of band authenticator plugin instance attribute contract.

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

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.