Commit API | SDK Docs

Create an uncommitted user

Create an uncommitted user from a user server-state generated by the keyless agent

POST/v2/uncommitted-users

Body

server-state*string

Response

Uncommitted user created

Body

userId*string

Request

const response = await fetch('/v2/uncommitted-users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "server-state": "text"
    }),
});
const data = await response.json();

Response

{
  "userId": "text"
}

Delete all uncommitted users matching the request

Delete all uncommitted users created before a given timestamp

DELETE/v2/uncommitted-users

Query parameters

Response

Uncommitted users deleted

Request

const response = await fetch('/v2/uncommitted-users', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Delete the uncommitted user with the specified userId

DELETE/v2/uncommitted-users/{userId}

Path parameters

userId*string

The user id

Response

Uncommitted user deleted

Request

const response = await fetch('/v2/uncommitted-users/{userId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Commit the uncommitted user

Commit the uncommitted user.

POST/v2/uncommitted-users/{userId}/commit

Path parameters

userId*string

The user id

Response

Server state committed

Request

const response = await fetch('/v2/uncommitted-users/{userId}/commit', {
    method: 'POST',
    headers: {},
});
const data = await response.json();