Skip to main content
GET/identity-providers/{epcId}

Get Identity Provider

Retrieves a single end-user federation provider configuration.

Credential fields (bindSecretRef, clientSecretRef) are returned as Kibo vault key references rather than plaintext values.

Requires PROJECT_ADMIN.

Parameters
epcId *path

The identity provider configuration's id (epc_...).

projectSlug *path

The project's slug: the path segment after @.

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
401K9O_SESSION_EXPIREDYour session has expired; authenticate again to continue.
403K9O_ACCESS_DENIEDYou do not have the required role to retrieve this identity provider configuration.
410K9O_SLUG_GONEThe project slug in the URL has been renamed; update your integration to use the current slug.
Response body (200)
data *object

An end-user identity provider configuration.

Secrets are never included.

id *string

The configuration's id (epc_...).

projectId *string

The project's id (proj_...).

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 (saml, ldap, active_directory, scim).

redirectUri *string

The callback the provider redirects to, derived by the platform.

Register it with the provider. not-applicable for scim, ldap and active_directory.

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 { "<claim>": "<provider attribute>" }.

Read by the saml, ldap and active_directory providers: email (default mail for LDAP), name (default cn for LDAP) and sub.

LDAP and Active Directory also read search_base and search_filter_template here.

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. ok; error; disabled_skipped (the configuration was disabled); credential_absent (no service account key); audit_write_failed (the run stopped because its audit record could not be written).

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.

TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.org.gate.idpProviders.get('epc_demo00000001')

Showing example in TypeScript

Response example (200)
{
  "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"
  }
}

More in Federation