1--- 2layout: "api" 3page_title: "/sys/mfa/method/pingid - HTTP API" 4sidebar_title: "<code>/sys/mfa/method/pingid</code>" 5sidebar_current: "api-http-system-mfa-pingid" 6description: |- 7 The '/sys/mfa/method/pingid' endpoint focuses on managing PingID MFA behaviors in Vault Enterprise. 8--- 9 10## Configure PingID MFA Method 11 12This endpoint defines a MFA method of type PingID. 13 14| Method | Path | 15| :----------------------------- | :--------------------- | 16| `POST` | `/sys/mfa/method/pingid/:name` | 17 18### Parameters 19 20- `name` `(string: <required>)` – Name of the MFA method. 21 22- `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. 23 24- `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: 25 - alias.name: The name returned by the mount configured via the `mount_accessor` parameter 26 - entity.name: The name configured for the Entity 27 - alias.metadata.`<key>`: The value of the Alias's metadata parameter 28 - entity.metadata.`<key>`: The value of the Entity's metadata parameter 29 30- `settings_file_base64` `(string)` - A base64-encoded third-party settings file retrieved from PingID's configuration page. 31 32### Sample Payload 33 34```json 35{ 36 "mount_accessor": "auth_userpass_1793464a", 37 "settings_file_base64": "AA8owj3..." 38} 39``` 40 41### Sample Request 42 43``` 44$ curl \ 45 --header "X-Vault-Token: ..." \ 46 --request POST \ 47 --data @payload.json \ 48 http://127.0.0.1:8200/v1/sys/mfa/method/pingid/ping 49``` 50 51## Read PingiD MFA Method 52 53This endpoint queries the MFA configuration of PingID type for a given method 54name. 55 56| Method | Path | 57| :----------------------------- | :----------------------- | 58| `GET` | `/sys/mfa/method/pingid/:name` | 59 60### Parameters 61 62- `name` `(string: <required>)` – Name of the MFA method. 63 64### Sample Request 65 66``` 67$ curl \ 68 --header "X-Vault-Token: ..." \ 69 --request GET \ 70 http://127.0.0.1:8200/v1/sys/mfa/method/pingid/ping 71 72``` 73 74### Sample Response 75 76```json 77{ 78 "data": { 79 "use_signature": true, 80 "idp_url": "https://idpxnyl3m.pingidentity.com/pingid", 81 "admin_url": "https://idpxnyl3m.pingidentity.com/pingid", 82 "authenticator_url": "https://authenticator.pingone.com/pingid/ppm", 83 "mount_accessor": "auth_userpass_1793464a", 84 "name": "ping", 85 "org_alias": "181459b0-9fb1-4938-8c86...", 86 "type": "pingid", 87 "username_format": "" 88 } 89} 90``` 91## Delete PingID MFA Method 92 93This endpoint deletes a PingID MFA method. 94 95| Method | Path | 96| :----------------------------- | :----------------------- | 97| `DELETE` | `/sys/mfa/method/pingid/:name` | 98 99 100### Parameters 101 102- `name` `(string: <required>)` - Name of the MFA method. 103 104### Sample Request 105 106``` 107$ curl \ 108 --header "X-Vault-Token: ..." \ 109 --request DELETE \ 110 http://127.0.0.1:8200/v1/sys/mfa/method/pingid/ping 111 112``` 113