On this page

CustomerProfileEntityAssignment Resource

CustomerProfileEntityAssignment Properties

Property nameTypePIIDescription

sidSID<BV>

Not PII

The unique string that we created to identify the Item Assignment resource.

Pattern: ^BV[0-9a-fA-F]{32}$Min length: 34Max length: 34

customer_profile_sidSID<BU>

Not PII

The unique string that we created to identify the CustomerProfile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>

Not PII

The SID of the Account that created the Item Assignment resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

object_sidSID

Not PII

The SID of an object bag that holds information of the different items.

Pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$Min length: 34Max length: 34

date_createdstring<date-time>

Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

urlstring<uri>

Not PII

The absolute URL of the Identity resource.

Create a new Assigned Item.

POST https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Property nameTypeRequiredPIIDescription

ObjectSidSIDrequired

Not PII

The SID of an object bag that holds information of the different items.

Pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$Min length: 34Max length: 34

Create a CustomerProfileEntityAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20
_20async function createCustomerProfileEntityAssignment() {
_20  const customerProfilesEntityAssignment = await client.trusthub.v1
_20    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_20    .customerProfilesEntityAssignments.create({
_20      objectSid: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_20    });
_20
_20  console.log(customerProfilesEntityAssignment.sid);
_20}
_20
_20createCustomerProfileEntityAssignment();

Output


_10{
_10  "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "object_sid": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "date_created": "2019-07-31T02:34:41Z",
_10  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10}

Fetch specific Assigned Item Instance.

GET https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<BV>required

Not PII

The unique string that we created to identify the Identity resource.

Pattern: ^BV[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a CustomerProfileEntityAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19
_19async function fetchCustomerProfileEntityAssignment() {
_19  const customerProfilesEntityAssignment = await client.trusthub.v1
_19    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .customerProfilesEntityAssignments("BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .fetch();
_19
_19  console.log(customerProfilesEntityAssignment.sid);
_19}
_19
_19fetchCustomerProfileEntityAssignment();

Output


_10{
_10  "sid": "BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "object_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "date_created": "2019-07-31T02:34:41Z",
_10  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments/BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10}

Retrieve a list of all Assigned Items for an account.

GET https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

ObjectTypestringOptional

Not PII

A string to filter the results by (EndUserType or SupportingDocumentType) machine-name. This is useful when you want to retrieve the entity-assignment of a specific end-user or supporting document.

PageSizeintegerOptional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

List multiple CustomerProfileEntityAssignments

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function listCustomerProfileEntityAssignment() {
_18  const customerProfilesEntityAssignments = await client.trusthub.v1
_18    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .customerProfilesEntityAssignments.list({ limit: 20 });
_18
_18  customerProfilesEntityAssignments.forEach((c) => console.log(c.sid));
_18}
_18
_18listCustomerProfileEntityAssignment();

Output


_12{
_12  "results": [],
_12  "meta": {
_12    "page": 0,
_12    "page_size": 50,
_12    "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0",
_12    "previous_page_url": null,
_12    "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments?PageSize=50&Page=0",
_12    "next_page_url": null,
_12    "key": "results"
_12  }
_12}

Remove an Assignment Item Instance.

DELETE https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

Pattern: ^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<BV>required

Not PII

The unique string that we created to identify the Identity resource.

Pattern: ^BV[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete a CustomerProfileEntityAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_17// Download the helper library from https://www.twilio.com/docs/node/install
_17const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17
_17// Find your Account SID and Auth Token at twilio.com/console
_17// and set the environment variables. See http://twil.io/secure
_17const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17const authToken = process.env.TWILIO_AUTH_TOKEN;
_17const client = twilio(accountSid, authToken);
_17
_17async function deleteCustomerProfileEntityAssignment() {
_17  await client.trusthub.v1
_17    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_17    .customerProfilesEntityAssignments("BVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_17    .remove();
_17}
_17
_17deleteCustomerProfileEntityAssignment();