Interfolio API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports UserApi

Type aliases

CommitteeMemberCommittee

CommitteeMemberCommittee: { committee_member_id: number; id: number; manager: boolean; name: string; type: string; unit_id: number }

Committee membership returned for a user

Type declaration

  • committee_member_id: number

    Id of the committee membership

  • id: number

    Id of the committee

  • manager: boolean

    Flog indicating if user is the manager of the committee

  • name: string

    Name of the commitee

  • type: string

    Type of the committee (e.g. StandingCommittee)

  • unit_id: number

    Unit id of the committee

User

User: { acts_as_eeo_officer_unit_ids: number[]; administrator_unit_ids: number[]; administrator_units: Unit[]; api_user: boolean; beta_user: boolean; committee_member_committees: CommitteeMemberCommittee[]; created_at: string; eeo_officer_unit_ids: number[]; email: string; enterprise_dossier_enabled: boolean; evaluator_units: Unit[]; external_user: boolean; first_name: string; id: number; institution_affiliations: { id: number; name: string }[]; last_name: string; legacy_pid: number; pid: number; superuser: false; tenant_ids: number[]; tenant_requires_sso: boolean; tenant_uses_sso: boolean; titles: { id: number; name: string; unit_id: number; unit_name: string }[]; unit_to_ancestor_lookup: {}; updated_at: string }

User type as returned by getUser()

Type declaration

  • acts_as_eeo_officer_unit_ids: number[]

    Unit ids for which the user can act as an eeo officer

  • administrator_unit_ids: number[]

    Unit ids for which this user is an administrator

  • administrator_units: Unit[]

    Units for which this user is an administrator

  • api_user: boolean

    Flag indicating if this user is an API user

  • beta_user: boolean

    Flag indicating if this user is a beta user

  • committee_member_committees: CommitteeMemberCommittee[]

    Committees that the users is a member of

  • created_at: string

    Date the user was created

  • eeo_officer_unit_ids: number[]

    Unit Ids for which the users is an eeo officer

  • email: string

    Email address of the user

  • enterprise_dossier_enabled: boolean

    Flag indicating if the enterprise dossier is enabled for this user

  • evaluator_units: Unit[]
  • external_user: boolean

    Flag indicating if the user is external

  • first_name: string

    First name of the user

  • id: number

    ID of the user

  • institution_affiliations: { id: number; name: string }[]

    inistitutions the user is affiliated with

  • last_name: string

    Last name of the user

  • legacy_pid: number

    Legacy PID of the user

  • pid: number

    PID of the user

  • superuser: false

    Flag indicating if this user is a super user

  • tenant_ids: number[]

    ids for which this user has access

  • tenant_requires_sso: boolean

    flag indicating if the tenant requires sso login

  • tenant_uses_sso: boolean

    flag indicating if the tenant allows sso login

  • titles: { id: number; name: string; unit_id: number; unit_name: string }[]

    list of titles assigned to the user

  • unit_to_ancestor_lookup: {}

    Lookup mapping for the unit to it's ancestor

    • [key: number]: number
  • updated_at: string

    Date when the user was last updated

Variables

Const USER_CURRENT_URL

USER_CURRENT_URL: "/byc-tenure/{tenant_id}/users/current" = '/byc-tenure/{tenant_id}/users/current'

Const USER_SEARCH_URL

USER_SEARCH_URL: string = ...

Const USER_SSO_URL

USER_SSO_URL: string = ...

Const USER_URL

USER_URL: string = ...

Const USER_URL_BASE

USER_URL_BASE: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc