logo

Identities

APIs related to Limio Identities

Transfer Limio owner

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.

SecuritybearerAuth
Request
Request Body schema: application/json
required
sourceId
string
destinationId
string
message
string
Responses
200

All objects successfully transferred to the destination owner.

401

Unauthorized

502

Bad Gateway

post/objects/owner_change
Request samples
application/json
{
  • "sourceId": "id-6306ee777d16170f96338bcaec7e825f",
  • "destinationId": "id-459605d1dac621bc8b0201cce6ca6f11",
  • "message": "Transfer ownership"
}
Response samples
application/json
{
  • "result": {
    },
  • "success": true
}

Add external identity (Admin)

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.

SecuritybearerAuth
Request
path Parameters
owner
required
string

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

Example: id-23252f4950f5efe7de30de37da283149
Request Body schema: application/json
required
object

id_token

iss
string
sub
string
Responses
200

External identity successfully linked to the specified owner.

401

Unauthorized

502

Bad Gateway

post/objects/externalidentity/{owner}
Request samples
application/json
{}
Response samples
application/json
{
  • "name": "John Doe",
  • "data": {},
  • "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)

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.

SecuritybearerAuth
Request
path Parameters
owner
required
string

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

Example: id-23252f4950f5efe7de30de37da283149
Request Body schema: application/json
required
object

id_token

iss
string
sub
string
Responses
200

External identity successfully removed from the specified owner.

401

Unauthorized

502

Bad Gateway

delete/objects/externalidentity/{owner}
Request samples
application/json
{}
Response samples
application/json
{ }

Forget Customer Data

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.

SecuritybearerAuth
Request
path Parameters
id
required
string

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

Example: cus-fc689f05092b27605bb622a6ca7871b0
Responses
200

Data successfully scrubbed

401

Unauthorized

502

Bad Gateway

post/customer/{id}/forget_customer
Request samples 
Response samples 
application/json
{
  • "customerId": "cus-fc689f05092b27605bb622a6ca7871b0",
  • "eventId": "event-596b708a4e9794466d7c7d9841d0d2d9",
  • "success": true
}
➔ Next to Basket