Sign in
Directories

Create SCIM directory

Changed on

Create a new SCIM directory for user and group synchronization.

<div> <code>create:scim_directories</code> </div>
post/api/v1/directories

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/directories
  • Auth: HTTP bearer

Request body

org_codestring required

The organization code to create the SCIM directory for.

directory_namestring required

A descriptive name for the SCIM directory.

provider_code'entra_id_azure_ad' | 'okta' | 'google_workspace' | 'custom_scim_v2' | 'cyberark' | 'jumpcloud' | 'onelogin' | 'pingfederate' | 'rippling' required

The SCIM provider code to use for this directory.

enterprise_connection_idstring

The enterprise connection ID to associate with this directory for SCIM-provisioned users. Required when the organization has multiple enabled enterprise connections.

Example request

{
  "org_code": "org_1ccfb819462",
  "directory_name": "Production Directory",
  "provider_code": "entra_id_azure_ad",
  "enterprise_connection_id": "conn_01h9xyzabc123"
}

Response

SCIM directory successfully created.

codestring

Response code.

messagestring

Response message.

Example response

{
  "code": "DIRECTORY_CREATED",
  "message": "SCIM directory created successfully",
  "directory": {
    "id": "directory_0192b1941f125645fa15bf28a662a0b3",
    "directory_name": "Production Directory",
    "directory_endpoint_id": "ksde_0192b1941f125645fa15bf28a662a0b3",
    "secret_token": "kstkn_0192b1941f125645fa15bf28a662a0b3",
    "status": "Pending",
    "organization_code": "org_1ccfb819462",
    "enterprise_connection_id": "conn_01h9xyzabc123",
    "enterprise_connection_name": "ACME SAML",
    "last_sync_started_at": "2024-11-18T13:32:03+11",
    "last_sync_completed_at": "2024-11-18T13:32:03+11",
    "last_sync_error": "Connection timeout",
    "created_on": "2024-11-18T13:32:03+11"
  }
}

Changes

  • bfffc845554dRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 6a0714404d1aRevision changes
    • info

      endpoint added