strapi/packages/core/admin/shared/contracts/users.ts

import type { errors } from '@strapi/utils';
import type { SanitizedAdminUser, Permission } from './shared';

/**
 * GET /users/me - Log in as an admin user
 */
export declare namespace GetMe {
  export interface Request {
    query: {};
    body: {};
  }

  export interface Response {
    data: SanitizedAdminUser;
    error?: errors.ApplicationError;
  }
}

/**
 * PUT /users/me - Update the current admin user
 */
export declare namespace UpdateMe {
  export interface BaseRequestBody {
    password?: string;
    currentPassword?: string;
    email?: string;
    firstname?: string;
    lastname?: string;
    username?: string;
    preferedLanguage?: string;
  }

  export interface Request {
    query: {};
    body: BaseRequestBody;
  }

  export interface Response {
    data: SanitizedAdminUser;
    error?:
      | errors.ApplicationError
      | errors.ValidationError<'ValidationError', { currentPassword: ['Invalid credentials'] }>
      | errors.YupValidationError;
  }
}

/**
 * GET /getAiToken - Get an AI token for the current admin user
 */
export declare namespace GetAiToken {
  export interface Request {
    query: {};
    body: {};
  }

  export interface Response {
    data: {
      token: string;
      expiresAt?: string;
    };
    error?: errors.ApplicationError;
  }
}

/**
 * GET /users/me/permissions - Get the permissions of the current admin user
 */
export declare namespace GetOwnPermissions {
  export interface Request {
    query: {};
    body: {};
  }

  export interface Response {
    data: Permission[];
    error?: errors.ApplicationError;
  }
}

/**
 * GET /users/me/ai-token - Get AI token for the current admin user
 */
export declare namespace GetAiToken {
  export interface Request {
    query: {};
    body: {};
  }

  export interface Response {
    data: {
      token: string;
      expiresAt?: string;
    };
    error?: errors.ApplicationError;
  }
}