Generic types for RBAC + Audit Logs

[julian-WorkOS]

Description

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[ ] Yes

If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

[julian-WorkOS]

Example types that would be consumed:

export interface RandallTestEvent {
  action: 'randall_test_event';
  occurredAt: string;
  version?: number;
  actor: {
    id: string;
    name?: string;
  };
  targets: ({
    type: 'test_message';
    id: string;
    name?: string;
})[];
  context: {
    location: string;
    userAgent?: string;
  };
}

export interface Asd {
  action: 'asd';
  occurredAt: string;
  version?: number;
  actor: {
    id: string;
    name?: string;
    metadata: {
      key: string;
    };
  };
  targets: ({
    type: 'environment';
    id: string;
    name?: string;
})[];
  context: {
    location: string;
    userAgent?: string;
  };
}

export interface UserEnvironmentCreate {
  action: 'user.environment_create';
  occurredAt: string;
  version?: number;
  actor: {
    id: string;
    name?: string;
  };
  targets: ({
    type: 'environment';
    id: string;
    name?: string;
})[];
  context: {
    location: string;
    userAgent?: string;
  };
}

export type AuditLogEvent = RandallTestEvent | Asd | UserEnvironmentCreate

export type WorkOSRole = 'admin' | 'member' | 'auditor';
export type WorkOSPermission = 'user.read' | 'user.write' | 'organization.read';