Retrieve a Directory Sync

GET {{cryptr_service_url}}/api/v2/org/:org_domain/directory-sync

Fetch a Directory Sync by its organization owner and environment (production, sandbox...).

Note: When you fetch a Directory Sync, the environment of your API key determines where your Directory Sync is stored. For example, your Directory Sync in the sandbox environment is fetched only if this resource is stored in sandbox. You cannot fetch a Directory Sync from the Production environment with this API key; you need an API key dedicated to the Production environment.

RETURNS

Returns the Directory Sync for a valid organization/environment pair. If the Directory Sync has been deleted, a NoResult response is returned.

RESPONSES

status: OK

{&quot;__type__&quot;:&quot;DirectorySync&quot;,&quot;active&quot;:false,&quot;auth_secret_token&quot;:{&quot;hint&quot;:&quot;This value is only displayed at creation and in the Onboarding of your customer.&quot;,&quot;provider_key&quot;:null,&quot;value&quot;:&quot;hidden&quot;},&quot;environment&quot;:{&quot;name&quot;:&quot;sandbox&quot;,&quot;status&quot;:&quot;up&quot;},&quot;id&quot;:&quot;directory-sync_2jgWFqVZhNIZhA6znP9vzqEx2Uq&quot;,&quot;inserted_at&quot;:&quot;2024-07-24T08:18:19&quot;,&quot;organization&quot;:{&quot;__type__&quot;:&quot;Organization&quot;,&quot;allowed_email_domains&quot;:[&quot;cpromo.com&quot;],&quot;color&quot;:&quot;sky-400&quot;,&quot;domain&quot;:&quot;cpromo&quot;,&quot;environments&quot;:[{&quot;name&quot;:&quot;sandbox&quot;,&quot;status&quot;:&quot;up&quot;},{&quot;name&quot;:&quot;production&quot;,&quot;status&quot;:&quot;down&quot;}],&quot;icon_logo_url&quot;:null,&quot;inline_logo_url&quot;:null,&quot;inserted_at&quot;:&quot;2024-07-24T07:26:37&quot;,&quot;locale&quot;:&quot;en-US&quot;,&quot;name&quot;:&quot;Cpromo&quot;,&quot;status&quot;:{&quot;errors&quot;:[],&quot;estimated_time_to_complete_in_seconds&quot;:null,&quot;progress_in_percentage&quot;:null,&quot;state&quot;:&quot;terminated&quot;},&quot;timezone&quot;:null,&quot;updated_at&quot;:&quot;2024-07-24T07:26:45&quot;},&quot;provider_type&quot;:null,&quot;updated_at&quot;:&quot;2024-07-24T08:48:05&quot;}