Resource Domain

Client

Type

import { Realm } from '@authup/core-kit';

interface Client {
    id: string,

    // ------------------------------------------------------------------

    active: boolean;

    built_in: boolean;

    is_confidential: boolean,

    // ------------------------------------------------------------------

    name: string,

    display_name: string | null;

    description: string | null,

    // ------------------------------------------------------------------

    secret: string | null,

    secret_hashed: boolean,

    secret_encrypted: boolean,

    // ------------------------------------------------------------------

    redirect_uri: string | null,

    grant_types: string | null,

    scope: string | null,

    base_url: string | null,

    root_url: string | null,

    // ------------------------------------------------------------------

    created_at: string,

    updated_at: string,

    // ------------------------------------------------------------------

    realm_id: Realm['id'],

    realm: Realm,
}

References

• Realm

IdentityProvider

Type

import {
    IdentityProviderProtocol,
    IdentityProviderPreset,
    Realm
} from '@authup/core-kit';

interface IdentityProvider {
    id: string,

    name: string,

    display_name: string | null;

    protocol: `${IdentityProviderProtocol}` | null;

    preset: `${IdentityProviderPreset}` | null;

    enabled: boolean;

    created_at: string;

    updated_at: string;

    realm_id: Realm['id'];

    realm: Realm;
}

References

• IdentityProviderProtocol
• IdentityProviderPreset
• Realm

IdentityProviderProtocol

Type

enum IdentityProviderProtocol {
    LDAP = 'ldap',
    OAUTH2 = 'oauth2',
    OIDC = 'oidc',
}

IdentityProviderPreset

Type

enum IdentityProviderPreset {
    FACEBOOK = 'facebook',
    GITHUB = 'github',
    GITLAB = 'gitlab',
    GOOGLE = 'google',
    PAYPAL = 'paypal',
    INSTAGRAM = 'instagram',
    STACKOVERFLOW = 'stackoverflow',
    TWITTER = 'twitter',
}

IdentityProviderAccount

Type

import {
    IdentityProvider,
    Realm,
    User
} from '@authup/core-kit';

interface IdentityProviderAccount {
    id: string;

    provider_user_id: string;

    provider_user_name: string;

    provider_user_email: string;

    created_at: Date;

    updated_at: Date;

    // -----------------------------------------------

    user_id: string;

    user: User;

    user_realm_id: Realm['id'] | null;

    user_realm: Realm | null;

    provider_id: IdentityProvider['id'];

    provider: IdentityProvider;

    provider_realm_id: Realm['id'] | null;

    provider_realm: Realm | null;
}

References

• IdentityProvider
• Realm
• User

IdentityProviderRoleMapping

Type

import {
    IdentityProviderBaseMapping,
    Realm,
    Role
} from '@authup/core-kit';

interface IdentityProviderRoleMapping extends IdentityProviderBaseMapping {
    id: string;

    created_at: Date;

    updated_at: Date;

    // -----------------------------------------------

    role_id: string;

    role: Role;

    role_realm_id: Realm['id'] | null;

    role_realm: Realm | null;
}

References

• IdentityProviderBaseMapping
• Realm
• Role

IdentityProviderBaseMapping

Type

import {
    IdentityProvider,
    IdentityProviderMappingSyncMode,
    Realm
} from '@authup/core-kit';

interface IdentityProviderBaseMapping {
    name: string | null;

    value: string | null;

    value_is_regex: boolean;

    synchronization_mode: `${IdentityProviderMappingSyncMode}` | null;

    provider_id: IdentityProvider['id'];

    provider: IdentityProvider;

    provider_realm_id: Realm['id'];

    provider_realm: Realm;
}

References

• IdentityProvider
• IdentityProviderMappingSyncMode
• Realm

IdentityProviderMappingSyncMode

Type

enum IdentityProviderMappingSyncMode {
    ONCE = 'once',
    ALWAYS = 'always',
    INHERIT = 'inherit',
}

Policy

Type

import { PolicyWithType, Realm } from '@authup/core-kit';

interface Policy {
    id: string;

    built_in: boolean;

    type: string;

    name: string;

    display_name: string | null;

    description: string | null;

    invert: boolean;

    children: PolicyWithType<Policy>[];

    parent_id: Policy['id'] | null;

    parent: PolicyWithType<Policy> | null;

    // ------------------------------------------------------------------

    realm_id: Realm['id'] | null;

    realm: Realm | null;

    // ------------------------------------------------------------------

    created_at: string;

    updated_at: string;
}

References

• Realm

Permission

Type

import { Client, Policy, Realm } from '@authup/core-kit';

interface Permission {
    id: string;

    built_in: boolean;

    name: string;

    display_name: string | null;

    description: string | null;

    // ------------------------------------------------------------------

    policy_id: Policy['id'] | null;

    policy: Policy | null;

    // ------------------------------------------------------------------

    client_id: Client['id'] | null;

    client: Client | null;

    // ------------------------------------------------------------------

    realm_id: Realm['id'] | null;

    realm: Realm | null;

    // ------------------------------------------------------------------

    created_at: string;

    updated_at: string;
}

References

• Client
• Policy
• Realm

PermissionRelation

Type

import { Permission, Policy, Realm } from '@authup/core-kit';

interface PermissionRelation {
    policy_id: Policy['id'] | null;

    policy: Policy | null;

    permission_id: Permission['id'];

    permission: Permission;

    permission_realm_id: Realm['id'] | null;

    permission_realm: Realm | null;
}

References

• Permission
• Policy
• Realm

Realm

Type

interface Realm {
    id: string;

    name: string;

    display_name: string | null;

    description: string | null;

    built_in: boolean;

    created_at: string;

    updated_at: string;
}

Robot

Type

import { Client, Realm, User } from '@authup/core-kit';

interface Robot {
    id: string;

    secret: string;

    name: string;

    display_name: string | null;

    description: string;

    active: boolean;

    // ------------------------------------------------------------------

    created_at: Date;

    updated_at: Date;

    // ------------------------------------------------------------------

    user_id: User['id'] | null;

    user: User | null;

    // ------------------------------------------------------------------

    client_id: Client['id'] | null;

    client: Client | null;

    // ------------------------------------------------------------------

    realm_id: Realm['id'];

    realm: Realm;
}

References

• Client
• Realm
• User

RobotPermission

Type

import { PermissionRelation, Robot, Realm } from '@authup/core-kit';

interface RobotPermission extends PermissionRelation {
    id: string;

    // ------------------------------------------------------------------

    created_at: Date;

    updated_at: Date;

    // ------------------------------------------------------------------

    robot_id: string;

    robot: Robot;

    robot_realm_id: Realm['id'] | null;

    robot_realm: Realm | null;
}

References

• PermissionRelation
• Realm
• Robot

RobotRole

Type

import { Realm, Robot, Role } from '@authup/core-kit';

interface RobotRole {
    id: string;

    robot_id: string;

    role_id: string;

    // ------------------------------------------------------------------

    role: Role;

    role_realm_id: Realm['id'] | null;

    role_realm: Realm | null;

    robot: Robot;

    robot_realm_id: Realm['id'] | null;

    robot_realm: Realm | null;

    // ------------------------------------------------------------------

    created_at: string;

    updated_at: string;
}

References

• Realm
• Robot
• Role

Role

Type

import { Client, Realm } from '@authup/core-kit';

interface Role {
    id: string;

    built_in: boolean;

    name: string;

    display_name: string | null;

    target: string | null;

    description: string | null;

    // ------------------------------------------------------------------

    client_id: Client['id'] | null;

    client: Client | null;

    // ------------------------------------------------------------------

    realm_id: Realm['id'] | null;

    realm: Realm | null;

    // ------------------------------------------------------------------

    created_at: string;

    updated_at: string;
}

References

• Client
• Realm

RoleAttribute

Type

import { Realm, Role } from '@authup/core-kit';

interface RoleAttribute {
    id: string;

    name: string;

    value: string | null;

    // ------------------------------------------------------------------

    role_id: Role['id'];

    role: Role;

    realm_id: Realm['id'] | null;

    realm: Realm | null;

    // ------------------------------------------------------------------

    created_at: string;

    updated_at: string;
}

References

• Realm
• Role

RolePermission

Type

import { PermissionRelation, Realm, Role } from '@authup/core-kit';

interface RolePermission extends PermissionRelation {
    id: string;

    // ------------------------------------------------------------------

    created_at: Date;

    updated_at: Date;

    // ------------------------------------------------------------------

    role_id: string;

    role: Role;

    role_realm_id: Realm['id'] | null;

    role_realm: Realm | null;
}

References

• PermissionRelation
• Realm
• Role

User

Type

import { Client, Realm } from '@authup/core-kit';

interface User {
    id: string;

    name: string;

    name_locked: boolean;

    first_name: string | null;

    last_name: string | null;

    display_name: string | null;

    email: string;

    password: string | null;

    // ------------------------------------------------------------------

    avatar: string | null;

    cover: string | null;

    // ------------------------------------------------------------------

    reset_hash: string | null;

    reset_at: string | null;

    reset_expires: string | null;

    // ------------------------------------------------------------------

    status: string | null;

    status_message: string | null;

    // ------------------------------------------------------------------

    active: boolean;

    activate_hash: string | null;

    // ------------------------------------------------------------------

    created_at: Date;

    updated_at: Date;

    // ------------------------------------------------------------------

    client_id: Client['id'] | null;

    client: Client | null;

    // ------------------------------------------------------------------

    realm_id: Realm['id'];

    realm: Realm;

    // ------------------------------------------------------------------

    [key: string]: any
}

References

• Client
• Realm

UserAttribute

Type

import { Realm, User } from '@authup/core-kit';

interface UserAttribute {
    id: string;

    name: string;

    value: string | null;

    // ------------------------------------------------------------------

    user_id: User['id'];

    user: User;

    realm_id: Realm['id'];

    realm: Realm;

    // ------------------------------------------------------------------

    created_at: string;

    updated_at: string;
}

References

• Realm
• User

UserPermission

Type

import { PermissionRelation, Realm, User } from '@authup/core-kit';

interface UserPermission extends PermissionRelation {
    id: string;

    // ------------------------------------------------------------------

    created_at: Date;

    updated_at: Date;

    // ------------------------------------------------------------------

    user_id: User['id'];

    user: User;

    user_realm_id: Realm['id'] | null;

    user_realm: Realm | null;
}

References

• PermissionRelation
• Realm
• User

UserRole

Type

import { Realm, Role, User } from '@authup/core-kit';

interface UserRole {
    id: string;

    // ------------------------------------------------------------------

    role_id: Role['id'];

    role: Role;

    role_realm_id: Realm['id'] | null;

    role_realm: Realm | null;

    user_id: User['id'];

    user: User;

    user_realm_id: Realm['id'] | null;

    user_realm: Realm | null;

    // ------------------------------------------------------------------

    created_at: string;

    updated_at: string;
}

References

• Realm
• Role
• User