/identity-providers/{epcId}Update Identity Provider
Partially updates a project-scoped end-user federation provider configuration.
Mutable fields are displayName, config, attributeMap, groupSync, jitProvisioning, and enabled; the type field is immutable after creation.
Credential fields in config follow the same plaintext-on-input / *Ref-on-output rule as creation.
Requires PROJECT_ADMIN.
| epcId * | path | The identity provider configuration's id ( |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| displayName | string | A name for this configuration, 1 to 256 characters. |
| clientId | string | The client (application) id registered with the provider. |
| clientSecretRef | string | The provider's client secret itself, despite the name. It is encrypted at rest and never returned: reads show only For |
| redirectUri | string | The callback the provider redirects to. The platform derives it from the org and project slugs and the provider; omit it, or send exactly the derived value (anything else gets 400 |
| metadataUrl | any | The provider's discovery or metadata URL (for example an OIDC issuer's Must not contain credentials. On update, changing it for |
| One of: string | ||
| or: null | ||
| attributeMap | object | Maps platform claim names to the provider's attribute names, as Read by the LDAP and Active Directory also read Default |
| enabled | boolean | Whether end users can sign in with this provider. Default false on create. |
| allowedRedirectUris | any | The web origins ( Empty or null means SDK sign-in is refused until an origin is added. At most 64. |
| One of: string[] | ||
| or: null | ||
| nativeRedirectUris | any | Exact private-use-scheme URIs a native app receives sign-ins on (RFC 8252), such as Matched character for character. Empty or null for none. At most 10. |
| One of: string[] | ||
| or: null | ||
| directoryPullEnabled | boolean | Turns on the scheduled user-directory sync. Default false. |
| directorySyncIntervalMins | integer | Minutes between directory syncs, 5 to 1440. |
| serviceAccountKey | string | The Google service account key (JSON) the directory sync uses. Encrypted at rest and never returned. |
| directorySyncSubject | string | The Google Workspace admin user the directory sync acts as (domain-wide delegation). |
| 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 update 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. |
| data * | object | An end-user identity provider configuration. Secrets are never included. |
| id * | string | The configuration's id ( |
| projectId * | string | The project's id ( |
| idpProvider * | "google" | "github" | "microsoft" | "oidc" | "saml" | "scim" | "ldap" | "active_directory" | "apple" | "facebook" | "twitter" | The identity provider type. It cannot be changed after create: delete the configuration and create a new one instead. |
| displayName * | string | A name for this configuration, 1 to 256 characters. |
| clientId * | string | The client (application) id registered with the provider. |
| clientSecretSet * | boolean | Whether a client secret is stored. The secret itself is never returned. Always false for providers that use none ( |
| redirectUri * | string | The callback the provider redirects to, derived by the platform. Register it with the provider. |
| metadataUrl * | any | The provider's discovery or metadata URL, or null when none is set. |
| One of: string | ||
| or: null | ||
| attributeMap * | object | Maps platform claim names to the provider's attribute names, as Read by the LDAP and Active Directory also read Default |
| enabled * | boolean | Whether end users can sign in with this provider. |
| allowedRedirectUris * | string[] | The web origins SDK sign-in may return the end user to. Empty means SDK sign-in is refused. |
| nativeRedirectUris * | string[] | The native-app redirect URIs. Empty when there are none. |
| directoryPullEnabled * | boolean | Whether the scheduled directory sync is on. |
| directorySyncSubject * | any | The admin user the directory sync acts as, or null when unset. |
| One of: string | ||
| or: null | ||
| directorySyncIntervalMins * | any | Minutes between directory syncs, or null when unset. |
| One of: integer | ||
| or: null | ||
| directorySyncLastRunAt * | any | When the directory sync last ran, or null if it never has. |
| One of: string <date-time> | ||
| or: null | ||
| directorySyncLastStatus * | any | How the last directory sync ended, or null if it never ran. |
| One of: "ok" | ||
| or: "error" | ||
| or: "disabled_skipped" | ||
| or: "credential_absent" | ||
| or: "audit_write_failed" | ||
| or: null | ||
| createdAt * | string <date-time> | When the configuration was created. |
| updatedAt * | any | When it last changed, or null if it never has. |
| One of: string <date-time> | ||
| or: null | ||
| meta * | any | Request metadata: cost, timing and the request and trace ids. |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.org.gate.idpProviders.configure('epc_demo00000001', {
displayName: 'My Resource',
clientId: 'string',
clientSecretRef: 'string',
redirectUri: 'string',
metadataUrl: null,
attributeMap: {},
enabled: true
})Showing example in TypeScript
{
"displayName": "My Resource",
"clientId": "string",
"clientSecretRef": "string",
"redirectUri": "string",
"metadataUrl": null,
"attributeMap": {},
"enabled": true
}{
"data": {
"id": "string",
"projectId": "string",
"idpProvider": "google",
"displayName": "string",
"clientId": "string",
"clientSecretSet": false,
"redirectUri": "string",
"metadataUrl": "string",
"enabled": false,
"allowedRedirectUris": [
"string"
],
"nativeRedirectUris": [
"string"
],
"directoryPullEnabled": false,
"directorySyncSubject": "string",
"directorySyncIntervalMins": 0,
"directorySyncLastRunAt": "string",
"directorySyncLastStatus": "ok",
"createdAt": "string",
"updatedAt": "string"
}
}