Create a Directory Sync
POST {{cryptr_service_url}}/api/v2/org/:org_domain/directory-sync?provider=okta
Create a Directory Sync
Creates a new Directory Sync in an Organization. When you create a Directory Sync, you will receive the associated bearer token. Keep it secure. If you lose your bearer token, you will need to reset it.
Note: When you create a Directory Sync, the environment of your API key determines where your Directory Sync is stored. For example, a Directory Sync in the sandbox environment is created only if the API key used belongs to the sandbox environment. You cannot create a Directory Sync for the Production environment with an API key meant for another environment; you need an API key dedicated to the Production environment.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
provider | string | (Required) The provider name, e.g., okta, azure_ad, ping_one... |
RESPONSES
status: Created
{"__type__":"DirectorySync","active":true,"auth_secret_token":{"hint":"This value is only displayed at creation and in the Onboarding of your customer.","provider_key":null,"value":"auth_secret_token_cpromo_sandbox__KEQXaSwEOqRBh3FzdUT90HZ5cFD9k5HYyTQpIaAelM3kkQ5QQDs6taGOhFXeVlTr3PlBGz2UXbkbIGuUBdFAUlcjc_EyPK1G3eGrxUZF9LUPHHFDuUQOIGVEX35jGJ2o"},"environment":{"name":"sandbox","status":"up"},"id":"directory-sync_2jgWFqVZhNIZhA6znP9vzqEx2Uq","inserted_at":"2024-07-24T08:18:19","organization":{"__type__":"Organization","allowed_email_domains":["cpromo.com"],"color":"sky-400","domain":"cpromo","environments":[{"name":"sandbox","status":"up"},{"name":"production","status":"down"}],"icon_logo_url":null,"inline_logo_url":null,"inserted_at":"2024-07-24T07:26:37","locale":"en-US","name":"Cpromo","status":{"errors":[],"estimated_time_to_complete_in_seconds":null,"progress_in_percentage":null,"state":"terminated"},"timezone":null,"updated_at":"2024-07-24T07:26:45"},"provider_type":null,"updated_at":"2024-07-24T08:18:19"}