Class UserInfo

Index

Methods

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
UserInfo.As().Get() // Gets userinfo token for the impersonated users' token
```
- Defined in api/UserInfo.ts:50

GetToken

GetToken(
requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<IdentityToken>>
Get the identity token for an OrderCloud user. Used for Discover 2 integration.
Parameters
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
  - Optionalsignal?: AbortSignal
    
    AbortSignal that can be used to cancel the request.
Returns Promise<RequiredObjectDeep<IdentityToken>>
- Defined in api/UserInfo.ts:25