Identities

Manage Limio identities — link or unlink external identity providers, transfer object ownership between identities, and scrub personal customer data (GDPR right-to-be-forgotten).

Transfer Limio owner

post

This API allows a Limio administrator to transfer ownership of all objects from one owner to another. - The source owner is the current owner of the objects being transferred. - The destination owner will become the new owner of these objects. - Both the source and destination owners must use the "@limio/id" format. Important: This transfer only moves ownership of the objects. The source owner's ID itself is not transferred or changed.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Body

application/json

sourceIdstringOptionalExample: id-6306ee777d16170f96338bcaec7e825f

destinationIdstringOptionalExample: id-459605d1dac621bc8b0201cce6ca6f11

messagestringOptionalExample: Transfer ownership

Responses

200

All objects successfully transferred to the destination owner.

application/json

successbooleanOptionalExample: true

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

post

/objects/owner_change

HTTPcURLJavaScriptPython

POST /api/objects/owner_change HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "sourceId": "id-6306ee777d16170f96338bcaec7e825f",
  "destinationId": "id-459605d1dac621bc8b0201cce6ca6f11",
  "message": "Transfer ownership"
}

{
  "result": {
    "sourceId": "id-e3cdd2126f13a7cfd0bcb526384a3b2c",
    "destinationId": "id-dbf94081308168b4057f2b41035ded82",
    "updatedIds": [
      "subscription_offer-8b9e945bba16exx5f875a566eecccbc7",
      "sub-8b6bd55194a0b23b49fd8xx1822c507f",
      "schedule-3159cb9c9b4fa7655xx1179cb1fb4059",
      "schedule-21029311834d0cfxx0a2693cff4359b7",
      "pm-1413873b06d82097xxd94bdf23210d7c",
      "order-sprint-105-vxtzyxxRLEMzqsOVT_7i4SoDSsBnKjKZJo3dVtZ3HlY",
      "zuora/id-17359482xx",
      "salesforce/id-RNS7PMxxUQlUa3mZZC",
      "salesforce/id-3Rxx6B9hG0mJ8YwV7X",
      "zuora/id-101086xx0007",
      "id-bWlncmF0ZWQvOExxQWUwMDAwMFlEQ1FDUlYw",
      "cus-1bbb47ac9f4b92c5875c34bxxacb9bcf",
      "address-48b6ed42821xx35ea845bcbebecf70dc",
      "address-0c3ef6f5a606ce6403d93xxc5f1f6afe"
    ],
    "failedIds": [],
    "eventId": "event-6309e8123d80df483e7e2ad3463b0a00"
  },
  "success": true
}

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

ownerstringRequired

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

Example: id-23252f4950f5efe7de30de37da283149

Body

application/json

Responses

200

External identity successfully linked to the specified owner.

application/json

namestringOptionalExample: John Doe

statusstringOptionalExample: active

record_typestringOptionalExample: identity

record_variantstringOptionalExample: @limio/external-id

ownerstringOptionalExample: 123456789012345678901

idstringOptionalExample: 12345678901234564923810

servicestringOptionalExample: limio

createdstringOptionalExample: 2021-01-01T00:00:00.000Z

updatedstringOptionalExample: 2021-01-01T00:00:00.000Z

modestringOptionalExample: production

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

post

/objects/externalidentity/{owner}

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

ownerstringRequired

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

Example: id-23252f4950f5efe7de30de37da283149

Body

application/json

Responses

200

External identity successfully removed from the specified owner.

application/json

objectOptional

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

delete

/objects/externalidentity/{owner}

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"
  }
}

{}

Forget Customer Data

post

This API allows you to obfuscate personal customer data associated with a specific customer ID, including first name, last name and email. The customer ID must be provided in the request path. Please beware this action is irreversible.

Required scopes

This endpoint requires the following scopes:

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

idstringRequired

The unique customer ID of the customer's data you wish to be scrubbed.

Example: cus-fc689f05092b27605bb622a6ca7871b0

Responses

200

Data successfully scrubbed

application/json

customerIdstringOptionalExample: cus-fc689f05092b27605bb622a6ca7871b0

eventIdstringOptionalExample: event-596b708a4e9794466d7c7d9841d0d2d9

successbooleanOptionalExample: true

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

post

/customer/{id}/forget_customer

HTTPcURLJavaScriptPython

POST /api/customer/{id}/forget_customer HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "customerId": "cus-fc689f05092b27605bb622a6ca7871b0",
  "eventId": "event-596b708a4e9794466d7c7d9841d0d2d9",
  "success": true
}