Leaseaccelerator Authentication

generated: '2026-07-19'
method: searched
source: >-
  https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895814655245-Application-Programming-Interface-API-for-Developers
description: >-
  How a client authenticates to the LeaseAccelerator API. LeaseAccelerator does not issue API keys or
  OAuth tokens. Access is secured by SAML2 against the customer's own identity provider: the client
  performs a SAML2 ECP exchange with the LeaseAccelerator service provider endpoint, receives a text
  security token, and submits that token as a form field on every subsequent API POST.
summary:
  types:
  - saml2
  - session-token
  api_keys: false
  oauth2: false
  oidc: false
  mtls: false
  prerequisite: >-
    The customer must be integrated with LeaseAccelerator's Single Sign-On (SSO) solution, which is
    generally a matter of exchanging SAML2 Metadata (certificate and configuration information) with a
    SAML2-compliant identity provider.
schemes:
- name: saml2Token
  type: saml2-bearer-token
  transport: multipart/form-data field `token` on the operation POST
  description: >-
    A text security token obtained from the LeaseAccelerator SAML2 authentication layer. Instantiates a
    secure session that can be used for multiple, concurrent, stateless method requests.
  token_endpoint: https://{environment}.leaseaccelerator.com/auth/api
  token_endpoint_production: https://www.leaseaccelerator.com/auth/api
  flow:
  - step: 1
    action: >-
      Obtain the URL for your identity provider (IdP) and login credentials for a user already federated
      for access in LeaseAccelerator.
  - step: 2
    action: >-
      Submit a SAML2 GET request to the LeaseAccelerator service provider (SP) URL
      https://{environment}.leaseaccelerator.com/auth/api, identifying the IdP and the credentials to use.
      This requires an identity provider that supports Enhanced Client or Proxy (ECP) mode.
  - step: 3
    action: Extract the response, which takes the form of a text security token.
  - step: 4
    action: >-
      POST to https://{environment}.leaseaccelerator.com/lease_accelerator/api/LeaseAccelerator/{operation}
      with the `token` field set to that security token and the `file` field set to the <APIRequest>
      document.
  standards:
  - SAML 2.0 (OASIS)
  - SAML 2.0 Enhanced Client or Proxy (ECP) profile
  reference_implementation:
    language: java
    library: shib-http-client
    url: https://github.com/DARIAH-DE/shib-http-client
    note: >-
      The LeaseAccelerator developer documentation recommends this library for Java clients and publishes
      a complete Java test client as an appendix, using the IdP endpoint
      {idpBaseUrl}/idp/profile/SAML2/SOAP/ECP.
    first_party: false
transport_security:
  protocol: HTTPS
  note: >-
    LeaseAccelerator's API uses industry standard HTTPS (secure hypertext transfer protocol) with SAML 2
    authentication for data transfer.
  detail: security/leaseaccelerator-domain-security.yml
user_provisioning:
  note: >-
    LeaseAccelerator exposes SSO user lifecycle management as API operations rather than a separate SCIM
    endpoint. These operations are intended for use only in environments where Single Sign-On is in use.
  operations:
  - FederateUser
  - UpdateUser
  - RevokeUser
scopes:
  model: role-and-scope-of-access
  note: >-
    Authorization is not expressed as OAuth scopes. Access is governed by LeaseAccelerator Access Control
    roles and a ScopeOfAccess assigned to the federated user (set via the UpdateUser and FederateUser
    operations). Because there is no OAuth surface, this repo carries no scopes/ artifact.
docs: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895814655245-Application-Programming-Interface-API-for-Developers