pingid
Configure PingID MFA method
This endpoint defines a MFA method of type PingID.
Method | Path |
---|---|
POST | /sys/mfa/method/pingid/:name |
Parameters
name
(string: <required>)
– Name of the MFA method.mount_accessor
(string: <required>)
- The mount to tie this method to for use in automatic mappings. The mapping will use the Name field of Aliases associated with this mount as the username in the mapping.username_format
(string)
- A format string for mapping Identity names to MFA method names. Values to substitute should be placed in{{}}
. For example,"{{alias.name}}@example.com"
. If blank, the Alias's Name field will be used as-is. Currently-supported mappings:- alias.name: The name returned by the mount configured via the
mount_accessor
parameter - entity.name: The name configured for the Entity
- alias.metadata.
<key>
: The value of the Alias's metadata parameter - entity.metadata.
<key>
: The value of the Entity's metadata parameter
- alias.name: The name returned by the mount configured via the
settings_file_base64
(string)
- A base64-encoded third-party settings file retrieved from PingID's configuration page.
Sample payload
Sample request
Read PingiD MFA method
This endpoint queries the MFA configuration of PingID type for a given method name.
Method | Path |
---|---|
GET | /sys/mfa/method/pingid/:name |
Parameters
name
(string: <required>)
– Name of the MFA method.
Sample request
Sample response
Delete PingID MFA method
This endpoint deletes a PingID MFA method.
Method | Path |
---|---|
DELETE | /sys/mfa/method/pingid/:name |
Parameters
name
(string: <required>)
- Name of the MFA method.
Sample request