Operations

This set of API calls allows you to fetch operations on various Keyless entities.

Get Pending Operations

Return all pending operations associated with the tenant sdk key

GET/v2/users/{user_id}/operations/pending

Authorization

APIKeyHeader

Path parameters

user_id*User Id

Response

200401403404408409422503

Successful Response

Body

application/json

operationId*Operationid

operationPayloadOperationpayload

externalUserIdExternaluserid

Request

JavaScriptCurl

const response = await fetch('/v2/users/{user_id}/operations/pending', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "operationId": "text",
    "operationPayload": "text",
    "externalUserId": "text"
  }
]

Get Operation

The operation_id is the id previously passed to the Keyless backend by the Keyless Client SDK through an operation attempt or created up-front

GET/v2/operations/{operation_id}

Authorization

APIKeyHeader

Path parameters

operation_id*Operation Id

Response

200401403404408409422503

Successful Response

Body

application/json

resultResult

userId*Userid

timestamp*Timestamp

externalUserIdExternaluserid

operationPayloadOperationpayload

Request

JavaScriptCurl

const response = await fetch('/v2/operations/{operation_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "result": true,
  "userId": "text",
  "timestamp": "2024-04-24T02:53:19.119Z",
  "externalUserId": "text",
  "operationPayload": "text"
}

Post Operation

POST/v2/users/{user_id}/operations

Authorization

APIKeyHeader

Path parameters

user_id*User Id

Body

application/json

externalUserId*Externaluserid

operationId*Operationid

operationPayload*Operationpayload

Response

200401403404408409422503

Successful Response

Body

application/json

successSuccess

Request

JavaScriptCurl

const response = await fetch('/v2/users/{user_id}/operations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "externalUserId": "text",
      "operationId": "text",
      "operationPayload": "text"
    }),
});
const data = await response.json();

Response

{
  "success": true
}