cloudflare/src/resources/zero-trust/access/users/active-sessions.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../../core/resource';
import { APIPromise } from '../../../../core/api-promise';
import { PagePromise, SinglePage } from '../../../../core/pagination';
import { RequestOptions } from '../../../../internal/request-options';
import { path } from '../../../../internal/utils/path';

export class BaseActiveSessions extends APIResource {
  static override readonly _key: readonly ['zeroTrust', 'access', 'users', 'activeSessions'] = Object.freeze([
    'zeroTrust',
    'access',
    'users',
    'activeSessions',
  ] as const);

  /**
   * Get active sessions for a single user.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const activeSessionListResponse of client.zeroTrust.access.users.activeSessions.list(
   *   'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * )) {
   *   // ...
   * }
   * ```
   */
  list(
    userID: string,
    params: ActiveSessionListParams,
    options?: RequestOptions,
  ): PagePromise<ActiveSessionListResponsesSinglePage, ActiveSessionListResponse> {
    const { account_id } = params;
    return this._client.getAPIList(
      path`/accounts/${account_id}/access/users/${userID}/active_sessions`,
      SinglePage<ActiveSessionListResponse>,
      options,
    );
  }

  /**
   * Get an active session for a single user.
   *
   * @example
   * ```ts
   * const activeSession =
   *   await client.zeroTrust.access.users.activeSessions.get(
   *     'X1aXj1lFVcqqyoXF',
   *     {
   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *       user_id: 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
   *     },
   *   );
   * ```
   */
  get(
    nonce: string,
    params: ActiveSessionGetParams,
    options?: RequestOptions,
  ): APIPromise<ActiveSessionGetResponse> {
    const { account_id, user_id } = params;
    return (
      this._client.get(
        path`/accounts/${account_id}/access/users/${user_id}/active_sessions/${nonce}`,
        options,
      ) as APIPromise<{ result: ActiveSessionGetResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class ActiveSessions extends BaseActiveSessions {}

export type ActiveSessionListResponsesSinglePage = SinglePage<ActiveSessionListResponse>;

export interface ActiveSessionListResponse {
  expiration?: number;

  metadata?: ActiveSessionListResponse.Metadata;

  name?: string;
}

export namespace ActiveSessionListResponse {
  export interface Metadata {
    apps?: { [key: string]: Metadata.Apps };

    expires?: number;

    iat?: number;

    nonce?: string;

    ttl?: number;
  }

  export namespace Metadata {
    export interface Apps {
      hostname?: string;

      name?: string;

      type?: string;

      uid?: string;
    }
  }
}

export interface ActiveSessionGetResponse {
  account_id?: string;

  auth_status?: string;

  common_name?: string;

  device_id?: string;

  device_sessions?: { [key: string]: ActiveSessionGetResponse.DeviceSessions };

  devicePosture?: { [key: string]: ActiveSessionGetResponse.DevicePosture };

  email?: string;

  geo?: ActiveSessionGetResponse.Geo;

  iat?: number;

  idp?: ActiveSessionGetResponse.IdP;

  ip?: string;

  is_gateway?: boolean;

  is_warp?: boolean;

  isActive?: boolean;

  mtls_auth?: ActiveSessionGetResponse.MTLSAuth;

  service_token_id?: string;

  service_token_status?: boolean;

  user_uuid?: string;

  version?: number;
}

export namespace ActiveSessionGetResponse {
  export interface DeviceSessions {
    last_authenticated?: number;
  }

  export interface DevicePosture {
    id?: string;

    check?: DevicePosture.Check;

    data?: unknown;

    description?: string;

    error?: string;

    rule_name?: string;

    success?: boolean;

    timestamp?: string;

    type?: string;
  }

  export namespace DevicePosture {
    export interface Check {
      exists?: boolean;

      path?: string;
    }
  }

  export interface Geo {
    country?: string;
  }

  export interface IdP {
    id?: string;

    type?: string;
  }

  export interface MTLSAuth {
    auth_status?: string;

    cert_issuer_dn?: string;

    cert_issuer_ski?: string;

    cert_presented?: boolean;

    cert_serial?: string;
  }
}

export interface ActiveSessionListParams {
  /**
   * Identifier.
   */
  account_id: string;
}

export interface ActiveSessionGetParams {
  /**
   * Identifier.
   */
  account_id: string;

  /**
   * UUID.
   */
  user_id: string;
}

export declare namespace ActiveSessions {
  export {
    type ActiveSessionListResponse as ActiveSessionListResponse,
    type ActiveSessionGetResponse as ActiveSessionGetResponse,
    type ActiveSessionListResponsesSinglePage as ActiveSessionListResponsesSinglePage,
    type ActiveSessionListParams as ActiveSessionListParams,
    type ActiveSessionGetParams as ActiveSessionGetParams,
  };
}