Class SecurityProfiles

Index

Methods

As Create Delete DeleteAssignment Get List ListAssignments Patch Save SaveAssignment

Methods

As

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

Create

Create<TSecurityProfile extends SecurityProfile>(
securityProfile: SecurityProfile,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSecurityProfile>>
Create a security profile Check out the docs for more info
Type Parameters
- TSecurityProfile extends SecurityProfile
Parameters
- securityProfile: SecurityProfile
  Required fields: Name
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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 } = {}
  - OptionalbuyerID?: string
    
    ID of the buyer.
  - OptionalsupplierID?: string
    
    ID of the supplier.
  - OptionaluserGroupID?: string
    
    ID of the user group.
  - OptionaluserID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/SecurityProfiles.ts:180

Get

Get<TSecurityProfile extends SecurityProfile>(
securityProfileID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSecurityProfile>>
Retrieve a security profile Check out the docs for more info
Type Parameters
- TSecurityProfile extends SecurityProfile
Parameters
- securityProfileID: string
  ID of the security profile.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSecurityProfile>>
- Defined in api/SecurityProfiles.ts:90

List

List<TSecurityProfile extends SecurityProfile>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TSecurityProfile>>>
List 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")[];
  } = {}
  - 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" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    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).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TSecurityProfile>>>
- Defined in api/SecurityProfiles.ts:48

ListAssignments

ListAssignments<TSecurityProfileAssignment extends SecurityProfileAssignment>(
    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>>>
List 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;
  } = {}
  - OptionalbuyerID?: string
    
    ID of the buyer.
  - OptionalcommerceRole?: CommerceRole
    
    Commerce role of the security profile assignment. Possible values: Buyer, Seller, Supplier.
  - Optionallevel?: PartyType
    
    Level of the security profile assignment. Possible values: User, Group, Company, BuyerGroup.
  - 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.
  - OptionalsecurityProfileID?: string
    
    ID of the security profile.
  - OptionalsupplierID?: string
    
    ID of the supplier.
  - OptionaluserGroupID?: string
    
    ID of the user group.
  - OptionaluserID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TSecurityProfileAssignment>>>
- Defined in api/SecurityProfiles.ts:209

Patch

Patch<TSecurityProfile extends SecurityProfile>(
    securityProfileID: string,
    securityProfile: PartialDeep<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: PartialDeep<SecurityProfile>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TSecurityProfile>>
- Defined in api/SecurityProfiles.ts:155

Save

Save<TSecurityProfile extends SecurityProfile>(
    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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
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 = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/SecurityProfiles.ts:230

Class SecurityProfiles

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSecurityProfile>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

DeleteAssignment

Parameters

OptionalbuyerID?: string

OptionalsupplierID?: string

OptionaluserGroupID?: string

OptionaluserID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSecurityProfile>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: ("ID" | "Name")[]

OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TSecurityProfile>>>

ListAssignments

Type Parameters

Parameters

OptionalbuyerID?: string

OptionalcommerceRole?: CommerceRole

Optionallevel?: PartyType

Optionalpage?: number

OptionalpageSize?: number

OptionalsecurityProfileID?: string

OptionalsupplierID?: string

OptionaluserGroupID?: string

OptionaluserID?: string

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TSecurityProfileAssignment>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSecurityProfile>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`buyerID?: string

`Optional`supplierID?: string

`Optional`userGroupID?: string

`Optional`userID?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`filters?: Filters

`Optional`page?: number

`Optional`pageSize?: number

`Optional`search?: string

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

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

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: 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

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string