Class ImpersonationConfigs

Hierarchy

ImpersonationConfigs

Index

Properties

impersonating

Methods

As Create Delete Get List Patch Save

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): ImpersonationConfigs
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
ImpersonationConfigs.As().List() // lists ImpersonationConfigs using the impersonated users' token
```
Returns ImpersonationConfigs
- Defined in api/ImpersonationConfigs.ts:168

Create

Create<TImpersonationConfig>(impersonationConfig: ImpersonationConfig, requestOptions?: RequestOptions): Promise<RequiredDeep<TImpersonationConfig>>
Create a new impersonation config. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TImpersonationConfig extends ImpersonationConfig
Parameters
- impersonationConfig: ImpersonationConfig
  
  Required fields: SecurityProfileID, ClientID
- requestOptions: RequestOptions = {}
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 = {}
Returns Promise<void>
- Defined in api/ImpersonationConfigs.ts:127

Get

Get<TImpersonationConfig>(impersonationConfigID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TImpersonationConfig>>
Get a single impersonation config. Check out the docs for more info
Type Parameters
- TImpersonationConfig extends ImpersonationConfig
Parameters
- impersonationConfigID: string
  
  ID of the impersonation config.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TImpersonationConfig>>
- Defined in api/ImpersonationConfigs.ts:84

List

List<TImpersonationConfig>(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" | "!ImpersonationBuyerID" | "!ImpersonationGroupID" | "!ImpersonationUserID" | "!BuyerID" | "!GroupID" | "!UserID" | "!SecurityProfileID" | "!ClientID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TImpersonationConfig>>>
Get a list of 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" | "!ImpersonationBuyerID" | "!ImpersonationGroupID" | "!ImpersonationUserID" | "!BuyerID" | "!GroupID" | "!UserID" | "!SecurityProfileID" | "!ClientID")[];
  } = {}
  - Optional filters?: 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.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "ImpersonationBuyerID" | "ImpersonationGroupID" | "ImpersonationUserID" | "BuyerID" | "GroupID" | "UserID" | "SecurityProfileID" | "ClientID")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "ImpersonationBuyerID" | "ImpersonationGroupID" | "ImpersonationUserID" | "BuyerID" | "GroupID" | "UserID" | "SecurityProfileID" | "ClientID" | "!ID" | "!ImpersonationBuyerID" | "!ImpersonationGroupID" | "!ImpersonationUserID" | "!BuyerID" | "!GroupID" | "!UserID" | "!SecurityProfileID" | "!ClientID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TImpersonationConfig>>>
- Defined in api/ImpersonationConfigs.ts:42

Patch

Patch<TImpersonationConfig>(impersonationConfigID: string, impersonationConfig: PartialObjectDeep<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: PartialObjectDeep<ImpersonationConfig>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TImpersonationConfig>>
- Defined in api/ImpersonationConfigs.ts:149

Save

Save<TImpersonationConfig>(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 = {}
Returns Promise<RequiredDeep<TImpersonationConfig>>
- Defined in api/ImpersonationConfigs.ts:106

Class ImpersonationConfigs

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns ImpersonationConfigs

Create

Type Parameters

TImpersonationConfig extends ImpersonationConfig

Parameters

impersonationConfig: ImpersonationConfig

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TImpersonationConfig>>

Delete

Parameters

impersonationConfigID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TImpersonationConfig extends ImpersonationConfig

Parameters

impersonationConfigID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TImpersonationConfig>>

List

Type Parameters

TImpersonationConfig extends ImpersonationConfig

Parameters

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

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

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TImpersonationConfig>>>

Patch

Type Parameters

TImpersonationConfig extends ImpersonationConfig

Parameters

impersonationConfigID: string

impersonationConfig: PartialObjectDeep<ImpersonationConfig>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TImpersonationConfig>>

Save

Type Parameters

TImpersonationConfig extends ImpersonationConfig

Parameters

impersonationConfigID: string

impersonationConfig: ImpersonationConfig

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TImpersonationConfig>>

Settings

Member Visibility

Theme

`Private` impersonating

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

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