Class ImpersonationConfigs

Index

Methods

As Create Delete Get List Patch Save

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
ImpersonationConfigs.As().List() // lists ImpersonationConfigs using the impersonated users' token
```
- Defined in api/ImpersonationConfigs.ts:168

Create

Create<TImpersonationConfig extends ImpersonationConfig>(
impersonationConfig: ImpersonationConfig,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TImpersonationConfig>>
Create an impersonation config Check out the docs for more info
Type Parameters
- TImpersonationConfig extends ImpersonationConfig
Parameters
- impersonationConfig: ImpersonationConfig
  Required fields: SecurityProfileID, ClientID
- 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<RequiredDeep<TImpersonationConfig>>
- Defined in api/ImpersonationConfigs.ts:63

Delete

Delete(
impersonationConfigID: string,
requestOptions?: RequestOptions,
): Promise<void>
Delete an impersonation config Check out the docs for more info
Parameters
- impersonationConfigID: string
  ID of the impersonation config.
- 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<void>
- Defined in api/ImpersonationConfigs.ts:127

Get

Get<TImpersonationConfig extends ImpersonationConfig>(
impersonationConfigID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TImpersonationConfig>>
Retrieve an impersonation config Check out the docs for more info
Type Parameters
- TImpersonationConfig extends ImpersonationConfig
Parameters
- impersonationConfigID: string
  ID of the impersonation config.
- 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<RequiredDeep<TImpersonationConfig>>
- Defined in api/ImpersonationConfigs.ts:84

List

List<TImpersonationConfig extends ImpersonationConfig>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: (
            | "ID"
            | "ImpersonationBuyerID"
            | "ImpersonationGroupID"
            | "ImpersonationUserID"
            | "BuyerID"
            | "GroupID"
            | "UserID"
            | "SecurityProfileID"
            | "ClientID"
        )[];
        sortBy?: (
            | "ID"
            | "ImpersonationBuyerID"
            | "ImpersonationGroupID"
            | "ImpersonationUserID"
            | "BuyerID"
            | "GroupID"
            | "UserID"
            | "SecurityProfileID"
            | "ClientID"
            | "!ID"
            | "!GroupID"
            | "!ImpersonationBuyerID"
            | "!ImpersonationGroupID"
            | "!ImpersonationUserID"
            | "!BuyerID"
            | "!UserID"
            | "!SecurityProfileID"
            | "!ClientID"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TImpersonationConfig>>>
List impersonation configs Check out the docs for more info
Type Parameters
- TImpersonationConfig extends ImpersonationConfig
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: (
          | "ID"
          | "ImpersonationBuyerID"
          | "ImpersonationGroupID"
          | "ImpersonationUserID"
          | "BuyerID"
          | "GroupID"
          | "UserID"
          | "SecurityProfileID"
          | "ClientID"
      )[];
      sortBy?: (
          | "ID"
          | "ImpersonationBuyerID"
          | "ImpersonationGroupID"
          | "ImpersonationUserID"
          | "BuyerID"
          | "GroupID"
          | "UserID"
          | "SecurityProfileID"
          | "ClientID"
          | "!ID"
          | "!GroupID"
          | "!ImpersonationBuyerID"
          | "!ImpersonationGroupID"
          | "!ImpersonationUserID"
          | "!BuyerID"
          | "!UserID"
          | "!SecurityProfileID"
          | "!ClientID"
      )[];
  } = {}
  - Optionalfilters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optionalpage?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: (
        | "ID"
        | "ImpersonationBuyerID"
        | "ImpersonationGroupID"
        | "ImpersonationUserID"
        | "BuyerID"
        | "GroupID"
        | "UserID"
        | "SecurityProfileID"
        | "ClientID"
    )[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "ImpersonationBuyerID"
        | "ImpersonationGroupID"
        | "ImpersonationUserID"
        | "BuyerID"
        | "GroupID"
        | "UserID"
        | "SecurityProfileID"
        | "ClientID"
        | "!ID"
        | "!GroupID"
        | "!ImpersonationBuyerID"
        | "!ImpersonationGroupID"
        | "!ImpersonationUserID"
        | "!BuyerID"
        | "!UserID"
        | "!SecurityProfileID"
        | "!ClientID"
    )[]
    
    Comma-delimited list of fields to sort by.
- 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<ListPage<TImpersonationConfig>>>
- Defined in api/ImpersonationConfigs.ts:42

Patch

Patch<TImpersonationConfig extends ImpersonationConfig>(
    impersonationConfigID: string,
    impersonationConfig: PartialDeep<ImpersonationConfig>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TImpersonationConfig>>
Partially update an impersonation config Check out the docs for more info
Type Parameters
- TImpersonationConfig extends ImpersonationConfig
Parameters
- impersonationConfigID: string
  ID of the impersonation config.
- impersonationConfig: PartialDeep<ImpersonationConfig>
- 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<RequiredDeep<TImpersonationConfig>>
- Defined in api/ImpersonationConfigs.ts:149

Save

Save<TImpersonationConfig extends ImpersonationConfig>(
    impersonationConfigID: string,
    impersonationConfig: ImpersonationConfig,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TImpersonationConfig>>
Create or update an impersonation config If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TImpersonationConfig extends ImpersonationConfig
Parameters
- impersonationConfigID: string
  ID of the impersonation config.
- impersonationConfig: ImpersonationConfig
  Required fields: SecurityProfileID, ClientID
- 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<RequiredDeep<TImpersonationConfig>>
- Defined in api/ImpersonationConfigs.ts:106

Class ImpersonationConfigs

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TImpersonationConfig>>

Delete

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TImpersonationConfig>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: ( | "ID" | "ImpersonationBuyerID" | "ImpersonationGroupID" | "ImpersonationUserID" | "BuyerID" | "GroupID" | "UserID" | "SecurityProfileID" | "ClientID")[]

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredObjectDeep<ListPage<TImpersonationConfig>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TImpersonationConfig>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TImpersonationConfig>>

Settings

On This Page

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`filters?: Filters

`Optional`page?: number

`Optional`pageSize?: number

`Optional`search?: string

`Optional`searchOn?: (
| "ID"
| "ImpersonationBuyerID"
| "ImpersonationGroupID"
| "ImpersonationUserID"
| "BuyerID"
| "GroupID"
| "UserID"
| "SecurityProfileID"
| "ClientID"
)[]

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal