Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Principal

Contains information about the connected user.

Hierarchy

  • Principal

Index

Properties

Properties

Optional expiry

expiry: string

Indicates the expiration time of the principal.

identities

identities: Identity[]

Collection of identities that represents the current user.

isAuthenticated

isAuthenticated: boolean

Flag that indicates if the user was authenticated or not.

label

label: string

Indicates the label (friendly name) of this principal.

policy

policy: object

Indicates any semantics relevant to sign in / sign out behavior.

Type declaration

  • Optional authenticate?: boolean

    Indicates that the policy is suggesting to the client that authentication may be desirable or even required.

  • Optional hints?: string

    Indicates to the client what is acceptable for sign in / sign out.

  • Optional issuers?: Issuer[]

    The list of available issuers.

tokens

tokens: object

Indicates the tokens that may be consumed.

Type declaration

  • Optional arcgis?: object

    Indicates the ArcGIS tokens (realm => token).

    • [realm: string]: string
  • Optional geocortex?: object

    Indicates the Geocortex tokens (realm => token).

    • [realm: string]: string
  • Optional site?: string

    Indicates the site token.

urls

urls: object

Indicates any important URLs.

Type declaration

  • Optional expirationNotice?: string

    Indicates the expiration notice content URL.

  • Optional referrer?: string

    Indicates the referrer URL.

  • Optional refresh?: string

    Indicates the refresh URL.

  • Optional signIn?: string

    Indicates the sign in URL.

  • Optional signOut?: string

    Indicates the sign out URL.