DELETE
/identity-providers/{epcId}Delete Identity Provider
Deletes a project-scoped end-user federation provider configuration.
End-users previously federated through the deleted provider remain in the user table but cannot sign in via that provider; an org admin re-attaches them to a different provider via the user-management surface.
Requires PROJECT_ADMIN.
Parameters
| epcId * | path | The identity provider configuration's id ( |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
Responses
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 401 | K9O_SESSION_EXPIRED | Your session has expired; authenticate again to continue. |
| 403 | K9O_ACCESS_DENIED | You do not have the required role to delete this identity provider configuration. |
| 410 | K9O_SLUG_GONE | The project slug in the URL has been renamed; update your integration to use the current slug. |
Response body (200)
| data * | object | The configuration that was deleted. |
| id * | string | The deleted configuration's id ( |
| deleted * | true | Always End users cannot sign in with this provider. |
| meta * | any | Request metadata: cost, timing and the request and trace ids. |
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.org.gate.idpProviders.delete('epc_demo00000001')Showing example in TypeScript
Response example (200)
{
"data": {
"id": "string",
"deleted": true
}
}