Interface PortalLoginService

Service to access security information of ArcGIS services like ArcGIS Enterprise portal.

interface PortalLoginService {
    getPortalCredential(): Credential | undefined;
    getPortalUserSelfInfo(): Promise<Record<string, any>>;
    isSignedIn(): boolean;
    signIn(): Promise<Credential | undefined>;
    signOut(): void;
}

Hierarchy (View Summary)

EventSource<PortalLoginServiceEvents>
- PortalLoginService

Index

Methods

getPortalCredential getPortalUserSelfInfo isSignedIn signIn signOut

Methods

getPortalCredential

getPortalCredential(): Credential | undefined
Gets the token for the portal or undefined if user is not signed in.

Returns Credential | undefined
The user's credentials.
- Defined in arcgisportal/portal-security/api.ts:47

getPortalUserSelfInfo

getPortalUserSelfInfo(): Promise<Record<string, any>>
Gets the response of the community/self endpoint of ArcGIS Online or undefined if user is not signed in.

Returns Promise<Record<string, any>>
- Defined in arcgisportal/portal-security/api.ts:52

isSignedIn

isSignedIn(): boolean
Checks if the user is signed in to ArcGIS Online

Returns boolean
- Defined in arcgisportal/portal-security/api.ts:28

signIn(): Promise<Credential | undefined>
Forces a sign-in to ArcGIS Online. The user is prompted to enter credentials.

Returns Promise<Credential | undefined>
The user's credentials, wrapped in a promise.
- Defined in arcgisportal/portal-security/api.ts:35

signOut

signOut(): void
Clears all ArcGIS Online Tokens.

Returns void
- Defined in arcgisportal/portal-security/api.ts:40