cloudflare
Version:
The official TypeScript library for the Cloudflare API
135 lines • 4.2 kB
TypeScript
import { APIResource } from "../../../../resource.js";
import * as Core from "../../../../core.js";
import * as UserPolicyChecksAPI from "../applications/user-policy-checks.js";
import { SinglePage } from "../../../../pagination.js";
export declare class ActiveSessions extends APIResource {
/**
* 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?: Core.RequestOptions): Core.PagePromise<ActiveSessionListResponsesSinglePage, ActiveSessionListResponse>;
/**
* Get an active session for a single user.
*
* @example
* ```ts
* const activeSession =
* await client.zeroTrust.access.users.activeSessions.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* 'X1aXj1lFVcqqyoXF',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(userId: string, nonce: string, params: ActiveSessionGetParams, options?: Core.RequestOptions): Core.APIPromise<ActiveSessionGetResponse>;
}
export declare class ActiveSessionListResponsesSinglePage extends SinglePage<ActiveSessionListResponse> {
}
export interface ActiveSessionListResponse {
expiration?: number;
metadata?: ActiveSessionListResponse.Metadata;
name?: string;
}
export declare namespace ActiveSessionListResponse {
interface Metadata {
apps?: {
[key: string]: Metadata.Apps;
};
expires?: number;
iat?: number;
nonce?: string;
ttl?: number;
}
namespace Metadata {
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?: UserPolicyChecksAPI.UserPolicyCheckGeo;
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 declare namespace ActiveSessionGetResponse {
interface DeviceSessions {
last_authenticated?: number;
}
interface DevicePosture {
id?: string;
check?: DevicePosture.Check;
data?: unknown;
description?: string;
error?: string;
rule_name?: string;
success?: boolean;
timestamp?: string;
type?: string;
}
namespace DevicePosture {
interface Check {
exists?: boolean;
path?: string;
}
}
interface IdP {
id?: string;
type?: string;
}
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;
}
export declare namespace ActiveSessions {
export { type ActiveSessionListResponse as ActiveSessionListResponse, type ActiveSessionGetResponse as ActiveSessionGetResponse, ActiveSessionListResponsesSinglePage as ActiveSessionListResponsesSinglePage, type ActiveSessionListParams as ActiveSessionListParams, type ActiveSessionGetParams as ActiveSessionGetParams, };
}
//# sourceMappingURL=active-sessions.d.ts.map