Class SecurityProfiles

Hierarchy

SecurityProfiles

Index

Properties

impersonating

Methods

As Create Delete DeleteAssignment Get List ListAssignments Patch Save SaveAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TSecurityProfile>(securityProfile: SecurityProfile, requestOptions?: RequestOptions): Promise<RequiredDeep<TSecurityProfile>>
Create a new security profile. 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
- TSecurityProfile extends SecurityProfile
Parameters
- securityProfile: SecurityProfile
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSecurityProfile>>
- Defined in api/SecurityProfiles.ts:69

Delete

Delete(securityProfileID: string, requestOptions?: RequestOptions): Promise<void>
Delete a security profile. Check out the docs for more info
Parameters
- securityProfileID: string
  
  ID of the security profile.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/SecurityProfiles.ts:133

DeleteAssignment

DeleteAssignment(securityProfileID: string, listOptions?: {
    buyerID?: string;
    supplierID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete a security profile assignment. Check out the docs for more info
Parameters
- securityProfileID: string
  
  ID of the security profile.
- listOptions: {
      buyerID?: string;
      supplierID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional supplierID?: string
    
    ID of the supplier.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/SecurityProfiles.ts:180

Get

Get<TSecurityProfile>(securityProfileID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TSecurityProfile>>
Get a single security profile. Check out the docs for more info
Type Parameters
- TSecurityProfile extends SecurityProfile
Parameters
- securityProfileID: string
  
  ID of the security profile.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSecurityProfile>>
- Defined in api/SecurityProfiles.ts:90

List

List<TSecurityProfile>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name")[];
    sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TSecurityProfile>>>
Get a list of security profiles. Check out the docs for more info
Type Parameters
- TSecurityProfile extends SecurityProfile
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - 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" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TSecurityProfile>>>
- Defined in api/SecurityProfiles.ts:48

ListAssignments

ListAssignments<TSecurityProfileAssignment>(listOptions?: {
    buyerID?: string;
    commerceRole?: CommerceRole;
    level?: PartyType;
    page?: number;
    pageSize?: number;
    securityProfileID?: string;
    supplierID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TSecurityProfileAssignment>>>
Get a list of security profile assignments. Check out the docs for more info
Type Parameters
- TSecurityProfileAssignment extends SecurityProfileAssignment
Parameters
- listOptions: {
      buyerID?: string;
      commerceRole?: CommerceRole;
      level?: PartyType;
      page?: number;
      pageSize?: number;
      securityProfileID?: string;
      supplierID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional commerceRole?: CommerceRole
    
    Commerce role of the security profile assignment. Possible values: Buyer, Seller, Supplier.
  - Optional level?: PartyType
    
    Level of the security profile assignment. Possible values: User, Group, Company.
  - 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 securityProfileID?: string
    
    ID of the security profile.
  - Optional supplierID?: string
    
    ID of the supplier.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TSecurityProfileAssignment>>>
- Defined in api/SecurityProfiles.ts:209

Patch

Patch<TSecurityProfile>(securityProfileID: string, securityProfile: PartialObjectDeep<SecurityProfile>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSecurityProfile>>
Partially update a security profile. Check out the docs for more info
Type Parameters
- TSecurityProfile extends SecurityProfile
Parameters
- securityProfileID: string
  
  ID of the security profile.
- securityProfile: PartialObjectDeep<SecurityProfile>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSecurityProfile>>
- Defined in api/SecurityProfiles.ts:155

Save

Save<TSecurityProfile>(securityProfileID: string, securityProfile: SecurityProfile, requestOptions?: RequestOptions): Promise<RequiredDeep<TSecurityProfile>>
Create or update a security profile. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TSecurityProfile extends SecurityProfile
Parameters
- securityProfileID: string
  
  ID of the security profile.
- securityProfile: SecurityProfile
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSecurityProfile>>
- Defined in api/SecurityProfiles.ts:112

SaveAssignment

SaveAssignment(securityProfileAssignment: SecurityProfileAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a security profile assignment. Check out the docs for more info
Parameters
- securityProfileAssignment: SecurityProfileAssignment
  
  Required fields: SecurityProfileID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/SecurityProfiles.ts:230

Class SecurityProfiles

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns SecurityProfiles

Create

Type Parameters

TSecurityProfile extends SecurityProfile

Parameters

securityProfile: SecurityProfile

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSecurityProfile>>

Delete

Parameters

securityProfileID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

securityProfileID: string

listOptions: { buyerID?: string; supplierID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional supplierID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TSecurityProfile extends SecurityProfile

Parameters

securityProfileID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSecurityProfile>>

List

Type Parameters

TSecurityProfile extends SecurityProfile

Parameters

listOptions: { filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "Name")[]; sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name")[]

Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TSecurityProfile>>>

ListAssignments

Type Parameters

TSecurityProfileAssignment extends SecurityProfileAssignment

Parameters

listOptions: { buyerID?: string; commerceRole?: CommerceRole; level?: PartyType; page?: number; pageSize?: number; securityProfileID?: string; supplierID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional commerceRole?: CommerceRole

Optional level?: PartyType

Optional page?: number

Optional pageSize?: number

Optional securityProfileID?: string

Optional supplierID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TSecurityProfileAssignment>>>

Patch

Type Parameters

TSecurityProfile extends SecurityProfile

Parameters

securityProfileID: string

securityProfile: PartialObjectDeep<SecurityProfile>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSecurityProfile>>

Save

Type Parameters

`Private` impersonating

listOptions: {
buyerID?: string;
supplierID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` supplierID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Name")[];
sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name")[]

`Optional` sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

listOptions: {
buyerID?: string;
commerceRole?: CommerceRole;
level?: PartyType;
page?: number;
pageSize?: number;
securityProfileID?: string;
supplierID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` commerceRole?: CommerceRole

`Optional` level?: PartyType

`Optional` page?: number

`Optional` pageSize?: number

`Optional` securityProfileID?: string

`Optional` supplierID?: string

`Optional` userGroupID?: string

`Optional` userID?: string