pingid
Create PingID MFA method
This endpoint creates an MFA method of type PingID.
Method | Path |
---|---|
POST | /identity/mfa/method/pingid |
Parameters
method_name
(string)
- The unique name identifier for this MFA method. Supported from Vault 1.13.0.username_format
(string)
- A template string for mapping Identity names to MFA method names. Values to substitute should be placed in{{}}
. For example,"{{identity.entity.name}}@example.com"
. If blank, the Entity's Name field is used as-is.settings_file_base64
(string: <required>)
- A base64-encoded third-party settings file retrieved from PingID's configuration page.
Sample payload
Sample request
Update PingID MFA method
This endpoint updates the configuration of an MFA method of type PingID.
Method | Path |
---|---|
POST | /identity/mfa/method/pingid/:method_id |
Parameters
method_id
(string: <required>)
- UUID of the MFA method.and all of the parameters documented under the preceding "Create" endpoint.
Sample payload
Identical to the preceding "Create" endpoint.
Sample request
Read PingID MFA method
This endpoint queries the MFA configuration of PingID type for a given method name.
Method | Path |
---|---|
GET | /identity/mfa/method/pingid/:id |
Parameters
id
(string: <required>)
– UUID of the MFA method.
Sample request
Sample response
Delete PingID MFA method
This endpoint deletes a PingID MFA method. MFA methods can only be deleted if they're not currently in use by a login enforcement.
Method | Path |
---|---|
DELETE | /identity/mfa/method/pingid/:id |
Parameters
id
(string: <required>)
- UUID of the MFA method.
Sample request
List PingID MFA methods
This endpoint lists PingID MFA methods that are visible in the current namespace or in parent namespaces.
Method | Path |
---|---|
LIST | /identity/mfa/method/pingid |
Sample request
Sample response