import {z} from 'zod' export type GetApiAccessCertificationCampaignsCampaignIdArgs = {campaignId: string}; export type GetApiAccessCertificationCampaignsCampaignIdOptions = {baseUrl?: string | undefined, xApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const jumpcloudHttpAccesscertificationCampaignTemplateStatus = z.enum(["scheduled", "active", "completed", "canceled"]); export const jumpcloudHttpAccesscertificationScopeType = z.enum(["application", "group"]); export const jumpcloudHttpAccesscertificationScopeConfig = z.object({scopeType: jumpcloudHttpAccesscertificationScopeType, applicationId: z.string().optional(), userGroupId: z.string().optional()}); export const jumpcloudHttpAccesscertificationCampaignFrequency = z.enum(["one_time", "recurring"]); export const jumpcloudHttpAccesscertificationRecurringCadence = z.enum(["monthly", "quarterly", "semi_annual", "annual"]); export const jumpcloudHttpAccesscertificationScheduleConfig = z.object({frequency: jumpcloudHttpAccesscertificationCampaignFrequency, cadence: jumpcloudHttpAccesscertificationRecurringCadence.optional(), reviewStartAt: z.string(), reviewDurationDays: z.number().int().gte(1).lte(180)}); export const jumpcloudHttpAccesscertificationReviewerType = z.enum(["administrator", "users_manager", "resource_owner", "user_group"]); export const jumpcloudHttpAccesscertificationReviewerStageConfig = z.object({stageIndex: z.number().int().gte(1), reviewerType: jumpcloudHttpAccesscertificationReviewerType, fallbackApproverUserId: z.string().optional(), resourceOwnerUserId: z.string().optional(), reviewerUserGroupId: z.string().optional(), allGroupMembersMustReview: z.boolean().optional()}); export const jumpcloudHttpAccesscertificationReviewerCompletionMode = z.enum(["any", "all", "sequential"]); export const jumpcloudHttpAccesscertificationReviewerChainConfig = z.object({stages: z.array(jumpcloudHttpAccesscertificationReviewerStageConfig), completionMode: jumpcloudHttpAccesscertificationReviewerCompletionMode.optional(), responseWindowDaysPerReviewer: z.number().int().gte(1).optional(), requireJustification: z.boolean().optional(), allowReassign: z.boolean().optional()}); export const jumpcloudHttpAccesscertificationOnRevokeAction = z.enum(["no_action", "suspend_identity", "remove_user_from_group"]); export const jumpcloudHttpAccesscertificationIfNoResponseAction = z.enum(["no_action", "automatic_removal", "suspend_identity"]); export const jumpcloudHttpAccesscertificationRemediationPolicy = z.object({onRevoke: jumpcloudHttpAccesscertificationOnRevokeAction, ifNoResponse: jumpcloudHttpAccesscertificationIfNoResponseAction, remediationDelayDays: z.number().int().gte(0), remediationCustomAt: z.string().optional()}); export const jumpcloudHttpAccesscertificationNotificationPlatformType = z.enum(["email", "slack", "webhook"]); export const jumpcloudHttpAccesscertificationCampaignNotificationPlatform = z.object({type: jumpcloudHttpAccesscertificationNotificationPlatformType, enabled: z.boolean(), channelIds: z.array(z.string())}); export const jumpcloudHttpAccesscertificationCampaignNotificationPreferences = z.object({platforms: z.array(jumpcloudHttpAccesscertificationCampaignNotificationPlatform)}); export const jumpcloudHttpAccesscertificationCampaignConfig = z.object({name: z.string().min(1), description: z.string().optional(), enabled: z.boolean().optional(), scope: jumpcloudHttpAccesscertificationScopeConfig, schedule: jumpcloudHttpAccesscertificationScheduleConfig, reviewerChain: jumpcloudHttpAccesscertificationReviewerChainConfig, remediationPolicy: jumpcloudHttpAccesscertificationRemediationPolicy, notificationPreferences: jumpcloudHttpAccesscertificationCampaignNotificationPreferences.optional()}); export const jumpcloudHttpAccesscertificationCampaignRunStatus = z.enum(["active", "closed", "canceled"]); export const jumpcloudHttpAccesscertificationCampaignRemediationStatus = z.enum(["not_started", "no_action", "in_progress", "scheduled", "completed", "failed", "canceled"]); export const jumpcloudHttpAccesscertificationCampaignMaterializationStatus = z.enum(["in_progress", "complete", "failed"]); export const jumpcloudHttpAccesscertificationCampaignListTarget = z.enum(["application", "group"]); export const jumpcloudHttpAccesscertificationUserGroup = z.object({id: z.string(), name: z.string().optional()}); export const jumpcloudHttpAccesscertificationGroupResourceCounts = z.object({userGroupId: z.string(), counts: z.record(z.string(), z.number().int())}); export const jumpcloudHttpAccesscertificationCampaignRunScope = z.object({type: jumpcloudHttpAccesscertificationCampaignListTarget, applicationId: z.string().optional(), applicationName: z.string().optional(), userGroups: z.array(jumpcloudHttpAccesscertificationUserGroup).optional(), resourceCounts: z.array(jumpcloudHttpAccesscertificationGroupResourceCounts).optional()}); export const jumpcloudHttpAccesscertificationCampaignRunSummary = z.object({runId: z.string().optional(), status: jumpcloudHttpAccesscertificationCampaignRunStatus.optional(), reviewWindowStart: z.string().optional(), reviewWindowEnd: z.string().optional(), reviewProgressPercent: z.number().int().gte(0).lte(100).optional(), remediationStatus: jumpcloudHttpAccesscertificationCampaignRemediationStatus.optional(), activatedAt: z.string().optional(), closedAt: z.string().optional(), materializationStatus: jumpcloudHttpAccesscertificationCampaignMaterializationStatus.optional(), reviewItemsMaterialized: z.number().int().optional(), scope: jumpcloudHttpAccesscertificationCampaignRunScope.optional()}); export const jumpcloudHttpAccesscertificationCampaignResponse = z.object({id: z.string(), orgId: z.string(), status: jumpcloudHttpAccesscertificationCampaignTemplateStatus, config: jumpcloudHttpAccesscertificationCampaignConfig, currentRun: jumpcloudHttpAccesscertificationCampaignRunSummary.optional(), createdAt: z.string(), updatedAt: z.string()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get campaign template * * GET /access-certification/campaigns/{campaignId} */ export const getApiAccessCertificationCampaignsCampaignId = async (args: GetApiAccessCertificationCampaignsCampaignIdArgs, options?: GetApiAccessCertificationCampaignsCampaignIdOptions) => { const {baseUrl = "https://console.jumpcloud.com/api/v2", fetch: fetchFn = fetch, xApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (xApiKey !== undefined) headers.set("x-api-key", xApiKey) const url = `${baseUrl.replace(/\/+$/, '')}/access-certification/campaigns/${encodeURIComponent(String(args.campaignId))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(jumpcloudHttpAccesscertificationCampaignResponse, await res.json()) };