Laurel Identity Service API

The Identity Service issues API access and models who belongs to a firm. It carries the OAuth 2.0 client-credentials token exchange every other Laurel API depends on, plus customers (firms), tenants, users (timekeepers and administrators), user identities, roles, permissions, user groups, delegates and SSO connections including SCIM provisioning. 95 operations across v1 and v2.

OpenAPI Specification

laurel-identity-openapi-original.json Raw ↑
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/tenants": {
      "post": {
        "operationId": "TenantController_create_v1",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateTenantDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tenant"
                }
              }
            }
          }
        },
        "tags": [
          "Tenants"
        ]
      },
      "get": {
        "operationId": "TenantController_getAll_v1",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Tenant"
                  }
                }
              }
            }
          }
        },
        "summary": "List all tenants",
        "tags": [
          "Tenants"
        ]
      }
    },
    "/api/v1/tenants/{tenantId}": {
      "get": {
        "operationId": "TenantController_get_v1",
        "parameters": [
          {
            "name": "tenantId",
            "required": true,
            "in": "path",
            "description": "tenant's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tenant"
                }
              }
            }
          }
        },
        "summary": "Get a specific tenant",
        "tags": [
          "Tenants"
        ]
      },
      "patch": {
        "operationId": "TenantController_updateOneById_v1",
        "parameters": [
          {
            "name": "tenantId",
            "required": true,
            "in": "path",
            "description": "tenant's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateTenantDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tenant"
                }
              }
            }
          }
        },
        "summary": "Updates an existing Tenant",
        "tags": [
          "Tenants"
        ]
      }
    },
    "/api/v1/permissions": {
      "get": {
        "operationId": "PermissionController_getAll_v1",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Permission"
                  }
                }
              }
            }
          }
        },
        "summary": "List all permissions",
        "tags": [
          "Permissions"
        ]
      }
    },
    "/api/v1/permissions/{permissionId}": {
      "get": {
        "operationId": "PermissionController_getOne_v1",
        "parameters": [
          {
            "name": "permissionId",
            "required": true,
            "in": "path",
            "description": "permission's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Permission"
                }
              }
            }
          }
        },
        "summary": "Return a specific permission by Id",
        "tags": [
          "Permissions"
        ]
      }
    },
    "/api/v1/ably/auth": {
      "get": {
        "operationId": "AblyController_auth_v1",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "summary": "Generate a token request",
        "tags": [
          "Ably"
        ]
      }
    },
    "/api/v1/clients/on-credentials-exchange": {
      "post": {
        "operationId": "ClientController_onCredentialsExchange_v1",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnCredentialsExchangeRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnCredentialsExchangeResponseDto"
                }
              }
            }
          }
        },
        "tags": [
          "Clients"
        ]
      }
    },
    "/api/v1/clients": {
      "post": {
        "deprecated": true,
        "operationId": "ClientController_create_v1",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateClientDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Client"
                }
              }
            }
          }
        },
        "summary": "creates a new client",
        "tags": [
          "Clients"
        ]
      },
      "get": {
        "deprecated": true,
        "operationId": "ClientController_getAll_v1",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Client"
                  }
                }
              }
            }
          }
        },
        "summary": "lists all existing clients",
        "tags": [
          "Clients"
        ]
      }
    },
    "/api/v1/clients/{clientId}": {
      "get": {
        "deprecated": true,
        "operationId": "ClientController_get_v1",
        "parameters": [
          {
            "name": "clientId",
            "required": true,
            "in": "path",
            "description": "client's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Client"
                }
              }
            }
          }
        },
        "summary": "returns a specific client",
        "tags": [
          "Clients"
        ]
      },
      "patch": {
        "operationId": "ClientController_update_v1",
        "parameters": [
          {
            "name": "clientId",
            "required": true,
            "in": "path",
            "description": "client's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateClientDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Client"
                }
              }
            }
          }
        },
        "summary": "updates an existing client",
        "tags": [
          "Clients"
        ]
      },
      "delete": {
        "deprecated": true,
        "operationId": "ClientController_delete_v1",
        "parameters": [
          {
            "name": "clientId",
            "required": true,
            "in": "path",
            "description": "client's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Client"
                }
              }
            }
          }
        },
        "summary": "deletes an existing client",
        "tags": [
          "Clients"
        ]
      }
    },
    "/api/v1/customers": {
      "post": {
        "operationId": "CustomerController_create_v1",
        "parameters": [
          {
            "name": "disableIdValidation",
            "required": false,
            "in": "query",
            "schema": {
              "nullable": true,
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCustomerDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      },
      "get": {
        "operationId": "CustomerController_getAll_v1",
        "parameters": [
          {
            "name": "tenantName",
            "required": false,
            "in": "query",
            "description": "region code name",
            "schema": {
              "nullable": true,
              "type": "string",
              "enum": [
                "iad",
                "lhr",
                "syd",
                "pdx",
                "yul"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Customer"
                  }
                }
              }
            }
          }
        },
        "summary": "List all customers",
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/lookup": {
      "get": {
        "operationId": "CustomerController_lookup_v1",
        "parameters": [
          {
            "name": "type",
            "required": true,
            "in": "query",
            "description": "type of the external identity",
            "schema": {
              "type": "string",
              "enum": [
                "aderant",
                "auth0",
                "azure",
                "email",
                "external-billing-system",
                "elite",
                "intercom",
                "juris",
                "cisco-cdr",
                "mixpanel",
                "phone",
                "phone-extension",
                "salesforce",
                "segment",
                "vitally",
                "walls",
                "zendesk",
                "zoom",
                "exchange",
                "user-principal-name",
                "cisco-webex",
                "ringcentral",
                "google"
              ]
            }
          },
          {
            "name": "value",
            "required": true,
            "in": "query",
            "description": "external identifier",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "customerId",
            "required": false,
            "in": "query",
            "description": "optional customer id to bind the identity to",
            "schema": {
              "format": "objectid",
              "nullable": true,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}": {
      "get": {
        "operationId": "CustomerController_get_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        },
        "summary": "Get a specific customer",
        "tags": [
          "Customers"
        ]
      },
      "patch": {
        "operationId": "CustomerController_update_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateCustomerDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        },
        "summary": "Update a specific customer",
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/tenant": {
      "get": {
        "operationId": "CustomerController_getTenant_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerTenantResponse"
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/identities": {
      "post": {
        "operationId": "CustomerController_createNewCustomerIdentity_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Identity"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": ""
          }
        },
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/connections": {
      "post": {
        "operationId": "CustomerController_createConnection_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateConnectionDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/connections/{connectionId}": {
      "patch": {
        "operationId": "CustomerController_updateConnection_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          },
          {
            "name": "connectionId",
            "required": true,
            "in": "path",
            "description": "connection's externalId",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateConnectionDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      },
      "delete": {
        "operationId": "CustomerController_deleteConnection_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          },
          {
            "name": "connectionId",
            "required": true,
            "in": "path",
            "description": "connection's externalId",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/connections/{connectionId}/scim": {
      "patch": {
        "operationId": "CustomerController_updateConnectionScim_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          },
          {
            "name": "connectionId",
            "required": true,
            "in": "path",
            "description": "connection's externalId",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateConnectionScimDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectionScimSetupResponseDto"
                }
              }
            }
          }
        },
        "summary": "Enable or disable SCIM provisioning on a connection",
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/connections/{connectionId}/domains": {
      "put": {
        "operationId": "CustomerController_updateConnectionDomains_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          },
          {
            "name": "connectionId",
            "required": true,
            "in": "path",
            "description": "connection's externalId",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateConnectionDomainsDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        },
        "summary": "Update the domains (FQDNs) for a connection, propagating to Auth0 HRD",
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/region": {
      "get": {
        "deprecated": true,
        "operationId": "CustomerController_getCustomerRegion_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerRegionResponseDto"
                }
              }
            }
          }
        },
        "summary": "",
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/clients": {
      "get": {
        "operationId": "CustomerClientController_getCustomerClients_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ClientResponseDto"
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      },
      "post": {
        "operationId": "CustomerClientController_create_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientResponseDto"
                }
              }
            }
          }
        },
        "summary": "creates a new client for the given customer",
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/clients/{clientId}": {
      "get": {
        "operationId": "CustomerClientController_getCustomerClientById_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          },
          {
            "name": "clientId",
            "required": true,
            "in": "path",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientResponseDto"
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      },
      "delete": {
        "operationId": "CustomerClientController_deleteCustomerClientById_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          },
          {
            "name": "clientId",
            "required": true,
            "in": "path",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/managed-clients": {
      "get": {
        "operationId": "CustomerManagedClientController_getCustomerManagedClients_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CustomerManagedClientResponseDto"
                  }
                }
              }
            }
          }
        },
        "summary": "Lists all customer-managed clients for the given customer",
        "tags": [
          "Customers"
        ]
      },
      "post": {
        "operationId": "CustomerManagedClientController_create_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCustomerManagedClientDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerManagedClientResponseDto"
                }
              }
            }
          }
        },
        "summary": "Creates a new customer-managed client for the given customer",
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/customers/{customerId}/managed-clients/{clientId}": {
      "delete": {
        "operationId": "CustomerManagedClientController_deleteCustomerManagedClientById_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "path",
            "description": "customer's id",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          },
          {
            "name": "clientId",
            "required": true,
            "in": "path",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "summary": "Deletes a customer-managed client by ID",
        "tags": [
          "Customers"
        ]
      }
    },
    "/api/v1/data-retention-audits": {
      "post": {
        "operationId": "DataRetentionAuditController_create_v1",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateDataRetentionAuditDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DataRetentionAudit"
                }
              }
            }
          }
        },
        "summary": "Create a new data retention audit log entry\nThis endpoint receives audit data and enqueues it for processing",
        "tags": [
          "Data Retention Audits"
        ]
      },
      "get": {
        "operationId": "DataRetentionAuditController_getAll_v1",
        "parameters": [
          {
            "name": "customerId",
            "required": true,
            "in": "query",
            "schema": {
              "format": "objectid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/DataRetentionAudit"
                  }
                }
              }
            }
          }
        },
        "summary": "List data retention audits for a specific customer",
        "tags": [
          "Data Retention Audits"
        ]
      }
    },
    "/api/v1/data-retention-audits/{auditId}": {
      "get": {
        "operationId": "DataRetentionAuditController_getOne_v1",
        "parameters": [
          {
     

# --- truncated at 32 KB (235 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/laurel/refs/heads/main/openapi/laurel-identity-openapi-original.json