Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IdentityManager

Hierarchy

Index

Properties

dialog

dialog: Widget

Dialog box widget used to challenge the user for their credentials when the application attempts to access a secure resource.

Read more...

tokenValidity

tokenValidity: number

The suggested lifetime of the token in minutes.

Read more...

Methods

checkAppAccess

  • checkAppAccess(resUrl: string, appId: string): Promise<any>
  • Returns a credential if the user has already signed in to access the given resource and is allowed to do so when using the given application id.

    Read more...

    Parameters

    • resUrl: string
    • appId: string

    Returns Promise<any>

checkSignInStatus

  • checkSignInStatus(resUrl: string): Promise<Credential>
  • Returns the Credential if the user has already signed in to access the given resource.

    Read more...

    Parameters

    • resUrl: string

    Returns Promise<Credential>

destroyCredentials

  • destroyCredentials(): void
  • Destroys all credentials.

    Read more...

    Returns void

disablePostMessageAuth

  • disablePostMessageAuth(): void
  • Disables the use of window.postMessage to serve authentication requests that were enabled by enablePostMessageAuth.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

enablePostMessageAuth

  • enablePostMessageAuth(resUrl?: string): void
  • Enables the IdentityManager to serve authentication requests for the given resource from apps running in child iframes.

    Read more...

    Parameters

    • Optional resUrl: string

    Returns void

findCredential

  • findCredential(url: string, userId?: string): Credential
  • Returns the Credential for the resource identified by the specified url.

    Read more...

    Parameters

    • url: string
    • Optional userId: string

    Returns Credential

findOAuthInfo

  • Returns the OAuthInfo configuration for the passed in Portal server URL.

    Read more...

    Parameters

    • url: string

    Returns OAuthInfo

findServerInfo

  • Returns information about the server that is hosting the specified URL.

    Read more...

    Parameters

    • url: string

    Returns ServerInfo

generateToken

  • Returns an object containing a token and its expiration time.

    Read more...

    Parameters

    Returns Promise<any>

getCredential

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

initialize

  • initialize(json: any): void
  • Call this method during application initialization with the JSON previously obtained from the toJSON() method used to re-hydrate the state of IdentityManager.

    Read more...

    Parameters

    • json: any

    Returns void

isBusy

  • isBusy(): boolean
  • Indicates if the IdentityManager is busy accepting user input.

    Read more...

    Returns boolean

on

registerOAuthInfos

  • registerOAuthInfos(oAuthInfos: OAuthInfo[]): void
  • Registers OAuth 2.0 configurations.

    Read more...

    Parameters

    Returns void

registerServers

  • registerServers(serverInfos: ServerInfo[]): void
  • Register secure servers and the token endpoints.

    Read more...

    Parameters

    Returns void

registerToken

  • Registers the given OAuth 2.0 access token or ArcGIS Server token with the IdentityManager.

    Read more...

    Parameters

    Returns void

setOAuthRedirectionHandler

  • Once a user successfully logs in, they are redirected back to the application.

    Read more...

    Parameters

    Returns void

setOAuthResponseHash

  • setOAuthResponseHash(hash: string): void
  • Use this method in the popup callback page to pass the token and other values back to the IdentityManager.

    Read more...

    Parameters

    • hash: string

    Returns void

setProtocolErrorHandler

  • When accessing secured resources, the IdentityManager may prompt for username and password and send them to the server using a secure connection.

    Read more...

    Parameters

    Returns void

toJSON

  • toJSON(): any
  • Return properties of this object in JSON format.

    Read more...

    Returns any

Generated using TypeDoc