{"apiVersion":"v1","swaggerVersion":"1.2","basePath":"https://pingfederate:443/pf-admin-api/v1","resourcePath":"/authenticationSelectors","produces":["application/json"],"apis":[{"path":"/authenticationSelectors/descriptors","operations":[{"method":"GET","summary":"Get the list of available Authentication Selector descriptors.","notes":"","type":"AuthenticationSelectorDescriptors","nickname":"getAuthenticationSelectorDescriptors","parameters":[],"responseMessages":[{"code":200,"message":"Success."},{"code":403,"message":"PingFederate does not have the appropriate IdP/SP role enabled. Operation not available."}]}]},{"path":"/authenticationSelectors/descriptors/{id}","operations":[{"method":"GET","summary":"Get the description of an Authentication Selector plugin by ID.","notes":"Get the description of an Authentication Selector plugin by ID. A 404 status code is returned for nonexistent IDs.","type":"AuthenticationSelectorDescriptor","nickname":"getAuthenticationSelectorDescriptorsById","parameters":[{"name":"id","description":"ID of Authentication Selector descriptor to fetch.","required":true,"allowMultiple":false,"type":"string","paramType":"path"}],"responseMessages":[{"code":200,"message":"Success."},{"code":403,"message":"PingFederate does not have the appropriate IdP/SP role enabled. Operation not available."},{"code":404,"message":"Resource not found."}]}]},{"path":"/authenticationSelectors","operations":[{"method":"GET","summary":"Get the list of configured Authentication Selector instances.","notes":"","type":"AuthenticationSelectors","nickname":"getAuthenticationSelectors","parameters":[],"responseMessages":[{"code":200,"message":"Success."},{"code":403,"message":"PingFederate does not have the appropriate IdP/SP role enabled. Operation not available."}]},{"method":"POST","summary":"Create a new authentication selector instance.","notes":"Create a new authentication selector instance. If the authentication selector is not properly configured, a 422 status code is returned along with a list of validation errors that must be corrected.","type":"AuthenticationSelector","nickname":"createAuthenticationSelector","parameters":[{"name":"body","description":"Configuration for a new authentication selector instance.","required":true,"allowMultiple":false,"type":"AuthenticationSelector","paramType":"body"}],"responseMessages":[{"code":201,"message":"Authentication selector created."},{"code":403,"message":"PingFederate does not have the appropriate IdP/SP role enabled. Operation not available."},{"code":422,"message":"Validation error(s) occurred.","responseModel":"ApiResult"}]}]},{"path":"/authenticationSelectors/{id}","operations":[{"method":"GET","summary":"Get an Authentication Selector instance by ID.","notes":"Get the configured Authentication Selector instance with the specified ID. A 404 status code is returned for nonexistent IDs.","type":"AuthenticationSelector","nickname":"getAuthenticationSelector","parameters":[{"name":"id","description":"ID of Authentication Selector instance to fetch.","required":true,"allowMultiple":false,"type":"string","paramType":"path"}],"responseMessages":[{"code":200,"message":"Success."},{"code":403,"message":"PingFederate does not have the appropriate IdP/SP role enabled. Operation not available."},{"code":404,"message":"Resource not found.","responseModel":"ApiResult"}]},{"method":"PUT","summary":"Update an authentication selector instance.","notes":"Update an authentication selector instance. If the authentication selector is not properly configured, a 422 status code is returned along with a list of validation errors that must be corrected.","type":"AuthenticationSelector","nickname":"updateAuthenticationSelector","parameters":[{"name":"id","description":"ID of the authentication selector instance.","required":true,"allowMultiple":false,"type":"string","paramType":"path"},{"name":"body","description":"Configuration for updated authentication selector instance.","required":true,"allowMultiple":false,"type":"AuthenticationSelector","paramType":"body"}],"responseMessages":[{"code":204,"message":"Authentication selector updated."},{"code":403,"message":"PingFederate does not have the appropriate IdP/SP role enabled. Operation not available."},{"code":404,"message":"Resource not found."},{"code":422,"message":"Validation error(s) occurred.","responseModel":"ApiResult"}]},{"method":"DELETE","summary":"Delete an Authentication Selector instance.","notes":"Delete an Authentication Selector instance with the specified ID. A 404 status code is returned for nonexistent IDs. Note: Only selectors not in use can be deleted. If the request succeeds, the response body is empty. If the request fails, an ApiResult is returned with details of the error.","type":"ApiResult","nickname":"deleteAuthenticationSelector","parameters":[{"name":"id","description":"ID of Authentication Selector to delete.","required":true,"allowMultiple":false,"type":"string","paramType":"path"}],"responseMessages":[{"code":204,"message":"Authentication selector deleted."},{"code":403,"message":"PingFederate does not have its IdP role enabled. Operation not available."},{"code":404,"message":"Resource not found."},{"code":422,"message":"Resource is in use and cannot be deleted.","responseModel":"ApiResult"}]}]}],"models":{"PluginInstance":{"id":"PluginInstance","description":"A plugin instance.","required":["id","name","pluginDescriptorRef","configuration"],"properties":{"id":{"type":"string","description":"The ID of the plugin instance. The ID cannot be modified once the instance is created."},"name":{"type":"string","description":"The plugin instance name. The name cannot be modified once the instance is created."},"pluginDescriptorRef":{"$ref":"ResourceLink","description":"Reference to the plugin descriptor for this instance. The plugin descriptor cannot be modified once the instance is created."},"parentRef":{"$ref":"ResourceLink","description":"The reference to this plugin's parent instance. The parent reference is only accepted if the plugin type supports parent instances."},"configuration":{"$ref":"PluginConfiguration","description":"Plugin instance configuration."}}},"TextFieldDescriptor":{"id":"TextFieldDescriptor","description":"A text field.","extends":"FieldDescriptor","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."},"encrypted":{"type":"boolean","description":"Determines whether the field value should be masked in the UI and encrypted on disk."},"size":{"type":"integer","format":"int32","description":"The size of the text field."}}},"TableDescriptor":{"id":"TableDescriptor","description":"Defines a plugin configuration table.","properties":{"name":{"type":"string","description":"The name of the table."},"description":{"type":"string","description":"Description for the table."},"columns":{"type":"array","description":"Get the columns in the table.","items":{"$ref":"FieldDescriptor"}}}},"OptionValue":{"id":"OptionValue","description":"An option name and value associated with a selection field.","properties":{"name":{"type":"string","description":"The name of the option."},"value":{"type":"string","description":"The value associated with this option."}}},"CheckBoxFieldDescriptor":{"id":"CheckBoxFieldDescriptor","description":"A boolean field typically rendered as a checkbox in a configuration UI.","extends":"FieldDescriptor","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."}}},"ConfigField":{"id":"ConfigField","description":"A plugin configuration field value.","required":["name"],"properties":{"name":{"type":"string","description":"The name of the configuration field."},"value":{"type":"string","description":"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."},"encryptedValue":{"type":"string","description":"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":{"type":"boolean","description":"Whether this field is inherited from its parent instance. If true, the value/encrypted value properties become read-only. The default value is false."}}},"HashedTextFieldDescriptor":{"id":"HashedTextFieldDescriptor","description":"A text field that will contain a secure salted hash.","extends":"FieldDescriptor","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."},"size":{"type":"integer","format":"int32","description":"The size of the text field."}}},"AuthenticationSelectorAttribute":{"id":"AuthenticationSelectorAttribute","description":"An attribute for the Authentication Selector attribute contract.","required":["name"],"properties":{"name":{"type":"string","description":"The name of this attribute."}}},"ConfigRow":{"id":"ConfigRow","description":"A row of configuration values for a plugin configuration table.","required":["fields"],"properties":{"fields":{"type":"array","description":"The configuration fields in the row.","items":{"$ref":"ConfigField"}}}},"AuthenticationSelectorAttributeContract":{"id":"AuthenticationSelectorAttributeContract","description":"A set of attributes exposed by an Authentication Selector.","properties":{"extendedAttributes":{"type":"array","description":"A list of additional attributes that can be returned by the Authentication Selector. The extended attributes are only used if the Authentication Selector supports them.","items":{"$ref":"AuthenticationSelectorAttribute"}}}},"AuthenticationSelectors":{"id":"AuthenticationSelectors","description":"A collection of Authentication Selector instances.","properties":{"items":{"type":"array","description":"The actual list of Authentication Selectors.","items":{"$ref":"AuthenticationSelector"}}}},"AuthenticationSelector":{"id":"AuthenticationSelector","description":"An Authentication Selector instance.","required":["id","name","pluginDescriptorRef","configuration"],"extends":"PluginInstance","properties":{"id":{"type":"string","description":"The ID of the plugin instance. The ID cannot be modified once the instance is created."},"name":{"type":"string","description":"The plugin instance name. The name cannot be modified once the instance is created."},"pluginDescriptorRef":{"$ref":"ResourceLink","description":"Reference to the plugin descriptor for this instance. The plugin descriptor cannot be modified once the instance is created."},"configuration":{"$ref":"PluginConfiguration","description":"Plugin instance configuration."},"attributeContract":{"$ref":"AuthenticationSelectorAttributeContract","description":"The list of attributes that the Authentication Selector provides."}}},"PluginDescriptor":{"id":"PluginDescriptor","description":"Defines a plugin type, including available configuration parameters.","properties":{"id":{"type":"string","description":"Unique ID of the plugin."},"name":{"type":"string","description":"Friendly name for the plugin."},"className":{"type":"string","description":"Full class name of the class that implements this plugin."},"attributeContract":{"type":"array","description":"The attribute contract for this plugin.","items":{"type":"string"}},"supportsExtendedContract":{"type":"boolean","description":"Determines whether this plugin supports extending the attribute contract."},"configDescriptor":{"$ref":"PluginConfigDescriptor","description":"The descriptor which defines the configuration fields available for this plugin."}}},"ConfigTable":{"id":"ConfigTable","description":"A plugin configuration table populated with values.","required":["name"],"properties":{"name":{"type":"string","description":"The name of the table."},"rows":{"type":"array","description":"List of table rows.","items":{"$ref":"ConfigRow"}},"inherited":{"type":"boolean","description":"Whether this table is inherited from its parent instance. If true, the rows become read-only. The default value is false."}}},"ActionDescriptor":{"id":"ActionDescriptor","description":"Describes an arbitrary action that is available for a plugin.","properties":{"name":{"type":"string","description":"The name of this action"},"description":{"type":"string","description":"The description of this action"},"download":{"type":"boolean","description":"Whether this action will trigger a download or invoke an internal action that will return a string result."},"downloadContentType":{"type":"string","description":"If this is a download, this is the Content-Type of the downloaded file. Otherwise, this is null."},"downloadFileName":{"type":"string","description":"If this is a download, this is the suggested file name of the downloaded file. Otherwise, this is null."}}},"ValidationError":{"id":"ValidationError","description":"A data input validation error.","properties":{"errorId":{"type":"string","description":"Error identifier."},"message":{"type":"string","description":"User-friendly error description."},"developerMessage":{"type":"string","description":"Developer-oriented error message, if available."},"fieldPath":{"type":"string","description":"The path to the model field to which the error relates, if one exists."}}},"AuthenticationSelectorDescriptors":{"id":"AuthenticationSelectorDescriptors","description":"A collection of Authentication Selector descriptors.","properties":{"items":{"type":"array","description":"The list of Authentication Selector descriptors.","items":{"$ref":"AuthenticationSelectorDescriptor"}}}},"PluginConfiguration":{"id":"PluginConfiguration","description":"Configuration settings for a plugin instance.","properties":{"tables":{"type":"array","description":"List of configuration tables.","items":{"$ref":"ConfigTable"}},"fields":{"type":"array","description":"List of configuration fields.","items":{"$ref":"ConfigField"}}}},"BaseSelectionFieldDescriptor":{"id":"BaseSelectionFieldDescriptor","description":"Holds fields that are shared by all selection-type field descriptors.","extends":"FieldDescriptor","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."},"optionValues":{"type":"array","description":"The list of option values for this selection field.","items":{"$ref":"OptionValue"}}},"subTypes":["RadioGroupFieldDescriptor","SelectFieldDescriptor"]},"RadioGroupFieldDescriptor":{"id":"RadioGroupFieldDescriptor","description":"A selection-type field intended to be rendered as a group of radio buttons in a UI.","extends":"BaseSelectionFieldDescriptor","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."},"optionValues":{"type":"array","description":"The list of option values for this selection field.","items":{"$ref":"OptionValue"}}}},"TextAreaFieldDescriptor":{"id":"TextAreaFieldDescriptor","description":"A field intended to be rendered as a text box in a UI.","extends":"FieldDescriptor","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."},"rows":{"type":"integer","format":"int32","description":"The number of rows for the text box."},"columns":{"type":"integer","format":"int32","description":"The number of columns for the text box."}}},"ResourceLink":{"id":"ResourceLink","description":"A reference to a resource.","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the resource."},"location":{"type":"string","description":"A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null."}}},"PluginConfigDescriptor":{"id":"PluginConfigDescriptor","description":"Defines the configuration fields available for a plugin.","properties":{"description":{"type":"string","description":"The description of this plugin."},"fields":{"type":"array","description":"The configuration fields available for this plugin.","items":{"$ref":"FieldDescriptor"}},"tables":{"type":"array","description":"Configuration tables available for this plugin.","items":{"$ref":"TableDescriptor"}},"actionDescriptors":{"type":"array","description":"The available actions for this plugin.","items":{"$ref":"ActionDescriptor"}}}},"ApiResult":{"id":"ApiResult","description":"Details on the result of the operation.","properties":{"resultId":{"type":"string","description":"Result identifier."},"message":{"type":"string","description":"Success or error message."},"developerMessage":{"type":"string","description":"Developer-oriented error message, if available."},"validationErrors":{"type":"array","description":"List of validation errors, if any.","items":{"$ref":"ValidationError"}}}},"UploadFileFieldDescriptor":{"id":"UploadFileFieldDescriptor","description":"A field which allows the user to upload a file.","extends":"FieldDescriptor","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."}}},"SelectFieldDescriptor":{"id":"SelectFieldDescriptor","description":"A selection field that is intended to be rendered as a dropdown list of options.","extends":"BaseSelectionFieldDescriptor","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."},"optionValues":{"type":"array","description":"The list of option values for this selection field.","items":{"$ref":"OptionValue"}}}},"FieldDescriptor":{"id":"FieldDescriptor","description":"Describes a plugin configuration field.","discriminator":"type","properties":{"type":{"$ref":"FieldDescriptorType","description":"The type of field descriptor.","enum":["RADIO_GROUP","SELECT","CHECK_BOX","TEXT_AREA","TEXT","UPLOAD_FILE","HASHED_TEXT"]},"name":{"type":"string","description":"Name of the field."},"description":{"type":"string","description":"Description of the field."},"defaultValue":{"type":"string","description":"Default value of the field."},"advanced":{"type":"boolean","description":"Whether this is an advanced field or not."},"required":{"type":"boolean","description":"Whether a value is required for this field or not."}},"subTypes":["RadioGroupFieldDescriptor","SelectFieldDescriptor","CheckBoxFieldDescriptor","UploadFileFieldDescriptor","TextAreaFieldDescriptor","TextFieldDescriptor","HashedTextFieldDescriptor"]},"AuthenticationSelectorDescriptor":{"id":"AuthenticationSelectorDescriptor","description":"An Authentication Selector descriptor.","extends":"PluginDescriptor","properties":{"id":{"type":"string","description":"Unique ID of the plugin."},"name":{"type":"string","description":"Friendly name for the plugin."},"className":{"type":"string","description":"Full class name of the class that implements this plugin."},"attributeContract":{"type":"array","description":"The attribute contract for this plugin.","items":{"type":"string"}},"supportsExtendedContract":{"type":"boolean","description":"Determines whether this plugin supports extending the attribute contract."},"configDescriptor":{"$ref":"PluginConfigDescriptor","description":"The descriptor which defines the configuration fields available for this plugin."}}}}}