> For the complete documentation index, see [llms.txt](https://docs.enclaive.cloud/vault/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enclaive.cloud/vault/api/secrets-engines/identity/mfa/pingid.md).

# pingid

### Create PingID MFA method <a href="#create-pingid-mfa-method" id="create-pingid-mfa-method"></a>

This endpoint creates an MFA method of type PingID.

| Method | Path                          |
| ------ | ----------------------------- |
| `POST` | `/identity/mfa/method/pingid` |

#### Parameters <a href="#parameters" id="parameters"></a>

* `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 <a href="#sample-payload" id="sample-payload"></a>

```json
{
  "username_format": "{{identity.entity.aliases.auth_userpass_1793464a.name}}",
  "settings_file_base64": "AA8owj3..."
}
```

#### Sample request <a href="#sample-request" id="sample-request"></a>

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/identity/mfa/method/pingid
```

### Update PingID MFA method <a href="#update-pingid-mfa-method" id="update-pingid-mfa-method"></a>

This endpoint updates the configuration of an MFA method of type PingID.

| Method | Path                                     |
| ------ | ---------------------------------------- |
| `POST` | `/identity/mfa/method/pingid/:method_id` |

#### Parameters <a href="#parameters-1" id="parameters-1"></a>

* `method_id` `(string: <required>)` - UUID of the MFA method.
* and all of the parameters documented under the preceding "Create" endpoint.

#### Sample payload <a href="#sample-payload-1" id="sample-payload-1"></a>

Identical to the preceding "Create" endpoint.

#### Sample request <a href="#sample-request-1" id="sample-request-1"></a>

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/identity/mfa/method/pingid/f8381105-67f0-4105-8662-4b07ae5c1233
```

### Read PingID MFA method <a href="#read-pingid-mfa-method" id="read-pingid-mfa-method"></a>

This endpoint queries the MFA configuration of PingID type for a given method name.

| Method | Path                              |
| ------ | --------------------------------- |
| `GET`  | `/identity/mfa/method/pingid/:id` |

#### Parameters <a href="#parameters-2" id="parameters-2"></a>

* `id` `(string: <required>)` – UUID of the MFA method.

#### Sample request <a href="#sample-request-2" id="sample-request-2"></a>

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    --request GET \
    http://127.0.0.1:8200/v1/identity/mfa/method/pingid/f8381105-67f0-4105-8662-4b07ae5c1233
```

#### Sample response <a href="#sample-response" id="sample-response"></a>

```json
{
  "data": {
    "use_signature": true,
    "idp_url": "https://idpxnyl3m.pingidentity.com/pingid",
    "admin_url": "https://idpxnyl3m.pingidentity.com/pingid",
    "authenticator_url": "https://authenticator.pingone.com/pingid/ppm",
    "id": "f8381105-67f0-4105-8662-4b07ae5c1233",
    "org_alias": "181459b0-9fb1-4938-8c86...",
    "type": "pingid",
  }
}
```

### Delete PingID MFA method <a href="#delete-pingid-mfa-method" id="delete-pingid-mfa-method"></a>

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 <a href="#parameters-3" id="parameters-3"></a>

* `id` `(string: <required>)` - UUID of the MFA method.

#### Sample request <a href="#sample-request-3" id="sample-request-3"></a>

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    http://127.0.0.1:8200/v1/identity/mfa/method/pingid/f8381105-67f0-4105-8662-4b07ae5c1233
```

### List PingID MFA methods <a href="#list-pingid-mfa-methods" id="list-pingid-mfa-methods"></a>

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 <a href="#sample-request-4" id="sample-request-4"></a>

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    http://127.0.0.1:8200/v1/identity/mfa/method/pingid
```

#### Sample response <a href="#sample-response-1" id="sample-response-1"></a>

```json
{
  "data": {
    "keys": [
      "f8381105-67f0-4105-8662-4b07ae5c1233"
    ]
  }
}
```