LeaseAccelerator User Provisioning API
The User Provisioning API from LeaseAccelerator — 3 operation(s) for user provisioning.
OpenAPI Specification
openapi: 3.1.0
info:
title: LeaseAccelerator Documents User Provisioning API
version: '26.3'
summary: REST-addressed, XML-RPC style API for the LeaseAccelerator enterprise lease lifecycle platform.
description: 'The LeaseAccelerator API combines the simplicity of REST requests with the data exchange capabilities of XML Remote Procedure Calls (RPC). Each request is stateless and multiple method requests can be submitted concurrently from the same secure session.
Access is secured by SAML2. Before submitting API requests you authenticate through the LeaseAccelerator SAML2 authentication layer (service provider URL `https://{environment}.leaseaccelerator.com/auth/api`, ECP mode against your own identity provider) and receive a text security token. Requests are then POSTed to `https://{environment}.leaseaccelerator.com/lease_accelerator/api/LeaseAccelerator/{operation}` with the `token` and `file` form fields, where `file` carries an `<APIRequest>` document.
This description was generated by the API Evangelist enrichment pipeline from the publicly published LeaseAccelerator developer documentation. Operation keys, the URL template, the authentication model, and the request/response envelopes are taken verbatim from that documentation; per-field payload schemas are documented per operation in the API Methods reference and are not reproduced here.'
termsOfService: https://insightsoftware.com/legal/terms-of-use/
contact:
name: LeaseAccelerator Support (insightsoftware)
url: https://insightsoftware.com/support/
x-generated-by: api-evangelist enrichment pipeline
x-source-documentation: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895814655245-Application-Programming-Interface-API-for-Developers
servers:
- url: https://{environment}.leaseaccelerator.com/lease_accelerator/api/LeaseAccelerator
description: LeaseAccelerator API endpoint. `environment` is the LeaseAccelerator environment being accessed (www for production); contact LeaseAccelerator Support for other environment URLs.
variables:
environment:
default: www
description: LeaseAccelerator environment; www is production.
security:
- saml2Token: []
tags:
- name: User Provisioning
paths:
/FederateUser:
post:
operationId: FederateUser
summary: Federate User
description: 'This method is used to provision credentials in LeaseAccelerator and is intended for use only in environments where Single Sign-On (SSO) is in use.
Operation key: `FederateUser`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
tags:
- User Provisioning
externalDocs:
description: API Methods reference
url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- token
- file
properties:
token:
type: string
description: The security token returned by the SAML2 authentication service at /auth/api.
file:
type: string
description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
responses:
'200':
description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
content:
application/xml:
schema:
$ref: '#/components/schemas/APIResponse'
'405':
description: Method not allowed — the API accepts POST only.
'500':
description: Server error, or an invalid/expired security token.
/RevokeUser:
post:
operationId: RevokeUser
summary: Revoke User Credentials
description: 'This method is used to revoke credentials in LeaseAccelerator and is intended for use only in environments where Single Sign-On (SSO) is in use.
Operation key: `RevokeUser`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
tags:
- User Provisioning
externalDocs:
description: API Methods reference
url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- token
- file
properties:
token:
type: string
description: The security token returned by the SAML2 authentication service at /auth/api.
file:
type: string
description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
responses:
'200':
description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
content:
application/xml:
schema:
$ref: '#/components/schemas/APIResponse'
'405':
description: Method not allowed — the API accepts POST only.
'500':
description: Server error, or an invalid/expired security token.
/UpdateUser:
post:
operationId: UpdateUser
summary: Update User Credentials
description: 'The UpdateUser operation is used to update credentials in LeaseAccelerator and is intended for use only in environments where Single Sign-On (SSO) is in use. The ScopeOfAccess and ScopeOfLedgers attributes will replace any current privileges for the specified user.
Operation key: `UpdateUser`. Reference: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods'
tags:
- User Provisioning
externalDocs:
description: API Methods reference
url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895853166093-API-Methods
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- token
- file
properties:
token:
type: string
description: The security token returned by the SAML2 authentication service at /auth/api.
file:
type: string
description: The XML <APIRequest> document carrying the Request envelope (RequestId, WarningPolicy, ErrorPolicy) and the operation-specific <Payload>.
responses:
'200':
description: An <APIResponse> document. A Status of 0 with Context "Ok" indicates success; any other Status value is an error described by Context.
content:
application/xml:
schema:
$ref: '#/components/schemas/APIResponse'
'405':
description: Method not allowed — the API accepts POST only.
'500':
description: Server error, or an invalid/expired security token.
components:
schemas:
APIResponse:
type: object
description: The generic LeaseAccelerator API response envelope.
xml:
name: APIResponse
properties:
Response:
type: object
properties:
RequestId:
type: string
description: The unique identifier specified in the request.
Status:
type: integer
description: A code indicating success or failure. Zero (0) always means success; any other value represents an error.
Context:
type: string
description: A description of the overall request results. "Ok" always means success; any other value describes the error encountered.
Payload:
type: string
description: The operation-specific XML response payload.
securitySchemes:
saml2Token:
type: apiKey
in: query
name: token
description: 'SAML2-issued text security token, submitted as the `token` form field on every POST. Obtain it by submitting a SAML2 ECP GET request to https://{environment}.leaseaccelerator.com/auth/api identifying your identity provider and a user federated for access in LeaseAccelerator. Note: OpenAPI has no native representation for a form-field credential, so it is modelled here as an apiKey; the token is transmitted in the multipart body, not the query string.'
externalDocs:
description: Application Programming Interface (API) for Developers
url: https://docs-leaseaccelerator.insightsoftware.com/hc/en-us/articles/33895814655245-Application-Programming-Interface-API-for-Developers