Delete OpenID Connect Identity Provider

This method deletes a specific OIDC Identity Provider. Any user who is a member of the Vault admins group can run this web service.

 

This API must be used with the Delete authentication method API in order to have a complete authentication configuration.

For example, when you delete an OIDC Identity provider, you must also delete the provider from the list of authentication methods using the same ID.

URL

 
https://{PVWA_SERVER}/passwordvault/api/Configuration/OIDC/Providers/{id}/
  • Make sure there are no spaces in the URL.

  • The following characters are not supported in URL values: + & %

  • If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

Resource information

HTTP method

Content type

DELETE

application/json

Header parameter

Parameter

Description

Authorization

The token that identifies the session, encoded in BASE 64.

Type: string

Mandatory: yes

Default value: none

URL parameter

Parameter

Description

id

The unique identifier of the provider.

This ID is used to identify the OIDC Identity Provider in PVWA.

Type: string

Mandatory: yes

Default value: none

Max length: 50

Result

Message indicating provider was deleted successfully.

Return codes

For a complete list of return codes, see Return Codes.