External Identities API

Add and remove identities to a Limio Customer.

The External Identities API empower multiple end-users to seamlessly access Limio Self-Service for the same subscription(s). The full API documentation is available: https://api.limio.com/#tag/Identities

This is especially beneficial in B2B scenarios, where an end-user might have originally purchased a subscription, however multiple end-user (owner, finance director, operations...) require the ability to change the subscription, access invoices, and process new purchases such as add-ons.

With this endpoint, developers and integrators have a mechanism to add multiple end-users to access the same subscription(s) while maintaining the safety of the data.

Access Control:

Currently, Limio operates on a flat-level access control system. This means each end-user granted access to the subscription will possess equivalent permissions to other end-users (including the original end-user who made the purchase).

Once a new end-user is added via the External Identity API, the end-user will be able to perform similar actions:

• See all subscriptions

• Modify payment methods

• Cancel or switch between offers

• Edit add-ons

• View invoices

How do I use it?

Add external identity (Admin)

post

This API allows a Limio administrator to add an external identity to any Limio identity on behalf of an organization. It is intended for administrative purposes and requires full OAuth API key authentication.Use Case: Admins can link external identities to any owner without needing the user to be logged in.Authentication: This API uses OAuth bearer tokens. See Limio OAuth Authentication for details.

Authorizations

Path parameters

ownerstringRequired

The ID of the Limio owner to which the external identity will be linked.

Example: id-23252f4950f5efe7de30de37da283149

Body

Responses

200

External identity successfully linked to the specified owner.

application/json

401

Unauthorized

application/json

502

Bad Gateway

application/json

post

HTTPcURLJavaScriptPython

POST /api/objects/externalidentity/{owner} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id_token": {
    "iss": "https://domain.com",
    "sub": "sub"
  }
}

{
  "name": "John Doe",
  "data": {
    "iss": "https://domain.com",
    "sub": "sub"
  },
  "status": "active",
  "record_type": "identity",
  "record_variant": "@limio/external-id",
  "owner": "123456789012345678901",
  "id": "12345678901234564923810",
  "service": "limio",
  "created": "2021-01-01T00:00:00.000Z",
  "updated": "2021-01-01T00:00:00.000Z",
  "mode": "production"
}

Remove external identity (Admin)

delete

This API allows a Limio administrator to remove an external identity from any Limio identity on behalf of an organization. It is intended for administrative purposes and requires full OAuth API key authentication.Use Case: Admins can unlink external identities from any owner without the user being logged in.Authentication: This API uses OAuth bearer tokens. See Limio OAuth Authentication for details.

Authorizations

Path parameters

ownerstringRequired

The ID of the Limio owner from which the external identity will be removed.

Example: id-23252f4950f5efe7de30de37da283149

Body

Responses

200

External identity successfully removed from the specified owner.

application/json

Responseobject

401

Unauthorized

application/json

502

Bad Gateway

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/objects/externalidentity/{owner} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id_token": {
    "iss": "https://domain.com",
    "sub": "sub"
  }
}

{}

A few notes:

This endpoint is currently only available if externally implemented from your application. Limio does not provide a mechanism within Limio Self-Service to add a user.

To maintain integrity and avoid duplication, the system is designed with specific constraints:

• Existing Limio end-users cannot be reassigned to an additional subscription.

• Deletion requests must originate from the same overarching subscription; otherwise, the request will be denied.

If there are any issues please reach out to Limio Support.