Sign in
Directories

Get SCIM directories

Changed on

Returns a list of SCIM directories for your organization.

<div> <code>read:scim_directories</code> </div>
get/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

Query parameters

page_sizeinteger nullable

Number of results per page. Defaults to 50 if parameter not sent.

starting_afterstring nullable

The ID of the directory to start after.

organization_codestring nullable

Filter by organization code to get directories for a specific organization.

Response

SCIM directories successfully retrieved.

codestring

Response code.

messagestring

Response message.

has_moreboolean

Whether more records exist.

Example response

{
  "code": "OK",
  "message": "Success",
  "directories": [
    {
      "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 optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 6a0714404d1aRevision changes
    • info

      endpoint added