Sign in
Directories

Update SCIM directory

Changed on

Update SCIM directory configuration.

<div> <code>update:scim_directories</code> </div>
patch/api/v1/directories/{directory_id}

Request

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

Request body

directory_namestring

A descriptive name for the SCIM directory.

Example request

{
  "directory_name": "Updated Production Directory"
}

Response

SCIM directory successfully updated.

codestring

Response code.

messagestring

Response message.

Example response

{
  "code": "DIRECTORY_UPDATED",
  "message": "SCIM directory updated 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
    • breaking

      the response's property type changed from object to array for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the request property became optional

    • 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