Skip to main content
GET
Get a Directory Provisioning Configuration

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

idp_id
string
required
read-only

Identity provider identifier.

Pattern: ^con_[A-Za-z0-9]{16}$

Response

Directory provisioning configuration successfully retrieved.

connection_id
string
required

Identifier of the connection backing this Identity Provider.

connection_name
string
required

Name of the connection backing this Identity Provider.

strategy
enum<string>
required

The type of the identity provider

Available options:
adfs,
google-apps,
oidc,
okta,
pingfederate,
samlp,
waad
mapping
object[]
required

The Auth0 ↔ IdP attribute mapping used for provisioning.

Required array length: 1 - 100 elements
synchronize_automatically
boolean
required

Whether periodic automatic synchronization is enabled.

status
enum<string>
required

Whether directory provisioning is fully active. incomplete: the configuration exists but automatic synchronization is disabled. complete: the configuration exists and automatic synchronization is enabled.

Available options:
incomplete,
complete
created_at
string<date-time>
required

When the configuration was created.

updated_at
string<date-time>
required

When the configuration was last updated.

synchronize_groups
enum<string>

Group synchronization mode. all: synchronize all groups. off: do not synchronize groups. selected: synchronize only selected groups.

Available options:
all,
off,
selected
last_synchronization_at
string<date-time>

When the last synchronization ran.

last_synchronization_status
string

The status of the most recent synchronization, passed through from the provisioning service. Currently reported as completed (last sync finished successfully) or failed (see last_synchronization_error). Omitted when the directory has never been synchronized.

last_synchronization_error
string

Error from the last synchronization, if any.