Method: OryClient::IdentityApi#delete_identity_credentials

Defined in:
lib/ory-client/api/identity_api.rb

#delete_identity_credentials(id, type, opts = {}) ⇒ nil

Delete a credential for a specific identity Delete an [identity](www.ory.sh/docs/kratos/concepts/identity-user-model) credential by its type. You cannot delete password or code auth credentials through this API.

Parameters:

  • id (String)

    ID is the identity's ID.

  • type (String)

    Type is the type of credentials to delete. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth passkey CredentialsTypePasskey profile CredentialsTypeProfile saml CredentialsTypeSAML link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :identifier (String)

    Identifier is the identifier of the OIDC credential to delete. Find the identifier by calling the `GET /admin/identities/id?include_credential=oidc` endpoint.

Returns:

  • (nil)


351
352
353
354
# File 'lib/ory-client/api/identity_api.rb', line 351

def delete_identity_credentials(id, type, opts = {})
  delete_identity_credentials_with_http_info(id, type, opts)
  nil
end