Use the GET /authenticationSelectors/descriptors
endpoint to get the list of available authentication selector descriptors.
Code | Reason |
---|---|
200 | Success. |
403 | PingFederate does not have the appropriate IdP/SP role enabled. Operation not available. |
AuthenticationSelectorDescriptors
- A collection of Authentication Selector descriptors.
Property | Type | Description |
---|---|---|
items | array[AuthenticationSelectorDescriptor] | The list of Authentication Selector descriptors. |
AuthenticationSelectorDescriptor
- An Authentication Selector descriptor.
Property | Type | Description |
---|---|---|
attributeContract | array[string] | The attribute contract for this plugin. |
className | string | Full class name of the class that implements this plugin. |
configDescriptor | PluginConfigDescriptor | The descriptor which defines the configuration fields available for this plugin. |
id | string | Unique ID of the plugin. |
name | string | Friendly name for the plugin. |
supportsExtendedContract | boolean | Determines whether this plugin supports extending the attribute contract. |
PluginConfigDescriptor
- Defines the configuration fields available for a plugin.
Property | Type | Description |
---|---|---|
actionDescriptors | array[ActionDescriptor] | The available actions for this plugin. |
description | string | The description of this plugin. |
fields | array[FieldDescriptor] | The configuration fields available for this plugin. |
tables | array[TableDescriptor] | Configuration tables available for this plugin. |
FieldDescriptor
- Describes a plugin configuration field.
Property | Type | Description |
---|---|---|
advanced | boolean | Whether this is an advanced field or not. |
defaultValue | string | Default value of the field. |
description | string | Description of the field. |
label | string | Label of the field to be displayed in the administrative console. |
name | string | Name of the field. |
required | boolean | Whether a value is required for this field or not. |
type | FieldDescriptorType | The type of field descriptor. |
RadioGroupFieldDescriptor : BaseSelectionFieldDescriptor
- A selection-type field intended to be rendered as a group of radio buttons in a UI.
Property | Type | Description |
---|---|---|
advanced | boolean | Whether this is an advanced field or not. |
defaultValue | string | Default value of the field. |
description | string | Description of the field. |
label | string | Label of the field to be displayed in the administrative console. |
name | string | Name of the field. |
optionValues | array[OptionValue] | The list of option values for this selection field. |
required | boolean | Whether a value is required for this field or not. |
type | FieldDescriptorType | The type of field descriptor. |
OptionValue
- An option name and value associated with a selection field.
Property | Type | Description |
---|---|---|
name | string | The name of the option. |
value | string | The value associated with this option. |
SelectFieldDescriptor : BaseSelectionFieldDescriptor
- A selection field that is intended to be rendered as a dropdown list of options.
Property | Type | Description |
---|---|---|
advanced | boolean | Whether this is an advanced field or not. |
defaultValue | string | Default value of the field. |
description | string | Description of the field. |
label | string | Label of the field to be displayed in the administrative console. |
name | string | Name of the field. |
optionValues | array[OptionValue] | The list of option values for this selection field. |
required | boolean | Whether a value is required for this field or not. |
type | FieldDescriptorType | The type of field descriptor. |
CheckBoxFieldDescriptor : FieldDescriptor
- A boolean field typically rendered as a checkbox in a configuration UI.
Property | Type | Description |
---|---|---|
advanced | boolean | Whether this is an advanced field or not. |
defaultValue | string | Default value of the field. |
description | string | Description of the field. |
label | string | Label of the field to be displayed in the administrative console. |
name | string | Name of the field. |
required | boolean | Whether a value is required for this field or not. |
type | FieldDescriptorType | The type of field descriptor. |
UploadFileFieldDescriptor : FieldDescriptor
- A field which allows the user to upload a file.
Property | Type | Description |
---|---|---|
advanced | boolean | Whether this is an advanced field or not. |
defaultValue | string | Default value of the field. |
description | string | Description of the field. |
label | string | Label of the field to be displayed in the administrative console. |
name | string | Name of the field. |
required | boolean | Whether a value is required for this field or not. |
type | FieldDescriptorType | The type of field descriptor. |
TextAreaFieldDescriptor : FieldDescriptor
- A field intended to be rendered as a text box in a UI.
Property | Type | Description |
---|---|---|
advanced | boolean | Whether this is an advanced field or not. |
columns | integer | The number of columns for the text box. |
defaultValue | string | Default value of the field. |
description | string | Description of the field. |
label | string | Label of the field to be displayed in the administrative console. |
name | string | Name of the field. |
required | boolean | Whether a value is required for this field or not. |
rows | integer | The number of rows for the text box. |
type | FieldDescriptorType | The type of field descriptor. |
TextFieldDescriptor : FieldDescriptor
- A text field.
Property | Type | Description |
---|---|---|
advanced | boolean | Whether this is an advanced field or not. |
defaultValue | string | Default value of the field. |
description | string | Description of the field. |
encrypted | boolean | Determines whether the field value should be masked in the UI and encrypted on disk. |
label | string | Label of the field to be displayed in the administrative console. |
name | string | Name of the field. |
required | boolean | Whether a value is required for this field or not. |
size | integer | The size of the text field. |
type | FieldDescriptorType | The type of field descriptor. |
HashedTextFieldDescriptor : FieldDescriptor
- A text field that will contain a secure salted hash.
Property | Type | Description |
---|---|---|
advanced | boolean | Whether this is an advanced field or not. |
defaultValue | string | Default value of the field. |
description | string | Description of the field. |
label | string | Label of the field to be displayed in the administrative console. |
name | string | Name of the field. |
required | boolean | Whether a value is required for this field or not. |
size | integer | The size of the text field. |
type | FieldDescriptorType | The type of field descriptor. |
TableDescriptor
- Defines a plugin configuration table.
Property | Type | Description |
---|---|---|
columns | array[FieldDescriptor] | Get the columns in the table. |
description | string | Description for the table. |
label | string | Label for the table to be displayed in the administrative console. |
name | string | The name of the table. |
requireDefaultRow | boolean | Configure whether this table requires default row to be set. |
ActionDescriptor
- Describes an arbitrary action that is available for a plugin.
Property | Type | Description |
---|---|---|
description | string | The description of this action |
download | boolean | Whether this action will trigger a download or invoke an internal action that will return a string result. |
downloadContentType | string | If this is a download, this is the Content-Type of the downloaded file. Otherwise, this is null. |
downloadFileName | string | If this is a download, this is the suggested file name of the downloaded file. Otherwise, this is null. |
name | string | The name of this action |