Auth Entity Storage Models Examples

Use these snippets to shape request and response data consistently across sign-in flows, admin operations, and token refresh handling.

Authentication Requests

import type {
  ILoginRequest,
  IRefreshTokenRequest,
  IUpdatePasswordRequest
} from '@twin.org/api-auth-entity-storage-models';

const loginRequest: ILoginRequest = {
  body: {
    email: '[email protected]',
    password: 'correct-horse-battery-staple'
  }
};

const refreshRequest: IRefreshTokenRequest = {
  body: {
    token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.refresh'
  }
};

const updatePasswordRequest: IUpdatePasswordRequest = {
  body: {
    currentPassword: 'old-password',
    newPassword: 'new-password-2026'
  }
};

console.log(loginRequest.body.email); // [email protected]

Admin User Models

import type {
  IAdminUserCreateRequest,
  IAdminUserUpdateRequest
} from '@twin.org/api-auth-entity-storage-models';

const createRequest: IAdminUserCreateRequest = {
  body: {
    email: '[email protected]',
    password: 'initial-password',
    userIdentity: 'did:example:bob',
    organizationIdentity: 'did:example:org',
    scope: ['admin', 'auditor']
  }
};

const updateRequest: IAdminUserUpdateRequest = {
  pathParams: {
    email: '[email protected]'
  },
  body: {
    userIdentity: 'did:example:bob:ops',
    scope: ['admin']
  }
};

console.log(createRequest.body.scope.length); // 2

Authentication Responses

import type { ILoginResponse } from '@twin.org/api-auth-entity-storage-models';

const loginResponse: ILoginResponse = {
  body: {
    expiry: 3600
  }
};

console.log(loginResponse.body.expiry); // 3600