Otcdpconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 106 actions for the Otcdpconnector v1.

Actions (5)

POST Imports a package of Audiences. The specified import package will be validated and a background task will be scheduled to perform the actual data import. If a validation error occurs then the request will fail and the error will be reported. If the import task is successfully scheduled then only a success response code will be returned. There are two types of audience packages that can be specified: enclosed and url. The schema and examples for each of these are shown here. The enclosed package type directly includes the audience data to be imported. The url package type only includes a URL to a file accessible to the audience import service. When using the url package type, the contents of the specified package file must be the JSON for the audience data specified in the enclosed package file format.

/api/v2/actions/audience/import

Imports a package of Audiences. The specified import package will be validated and a
background task will be scheduled to perform the actual data import. If a validation
error occurs then the request will fail and the error will be reported. If the import
task is successfully scheduled then only a success response code will be returned.

There are two types of audience packages that can be specified: enclosed and url. The
schema and examples for each of these are shown here. The enclosed package type directly
includes the audience data to be imported. The url package type only includes a URL to
a file accessible to the audience import service. When using the url package type, the
contents of the specified package file must be the JSON for the audience data specified
in the enclosed package file format.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PATCH Patches the profile merge action configuration with a RFC 7368 JSON Merge Patch.

/api/v2/actions/profile/merge

Patches the profile merge action configuration with a RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Enabled`	Enables the profile merge action.

PATCH Patches the profile merge action configuration with a RFC 7368 JSON Merge Patch.

/api/v1/actions/profile/merge

Patches the profile merge action configuration with a RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Enabled`	Enables the profile merge action.

GET Returns the current profile merge action configuration.

/api/v2/actions/profile/merge

Returns the current profile merge action configuration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns the current profile merge action configuration.

/api/v1/actions/profile/merge

Returns the current profile merge action configuration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Audiences (11)

PATCH Patches an audience's tags with an RFC 7368 JSON Merge Patch or an RFC 6902 JSON Patch.

/api/v2/audiences/{audienceId}

Patches an audience's tags with an RFC 7368 JSON Merge Patch or an RFC 6902 JSON Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Audienceid`	The audience identifier. Must not be blank.
`Response Type`	N/A

PATCH Patches an audience's tags with an RFC 7368 JSON Merge Patch or an RFC 6902 JSON Patch.

/api/v1/audiences/{audienceId}

Patches an audience's tags with an RFC 7368 JSON Merge Patch or an RFC 6902 JSON Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Audienceid`	The audience identifier. Must not be blank.
`Response Type`	N/A

GET Returns a page of audience metadatas. Results can be paged and/or sorted. Results can also be filtered by various conditions. When filtering, filter conditions are not combined and all results matching any filter value will be returned.

/api/v2/audiences/metadata

Returns a page of audience metadatas. Results can be paged and/or sorted. Results can also be filtered by various conditions. When filtering, filter conditions are not combined and all results matching any filter value will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Sort`	a comma separated list of property names that will be used to respectively order the audiences. Each property name may optionally be followed by a colon and an order specifier of asc or desc. Specifying no value indicates that no sorting is desired.
`Systemtags`	a comma separated list of values that will be used to filter the audiences by system tag. Audiences with a system tag matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by system tag.
`Tags`	a comma separated list of values that will be used to filter the audiences by tag. Audiences with a tag matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by tag.
`Providers`	a comma separated list of values that will be used to filter the audiences by provider. Audiences with a provider matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by provider.
`Names`	a comma separated list of values that will be used to filter the audiences by name. Audiences with a name matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by name.
`Response Type`	N/A

/api/v1/audiences

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Sort`	a comma separated list of property names that will be used to respectively order the audiences. Each property name may optionally be followed by a colon and an order specifier of asc or desc. Specifying no value indicates that no sorting is desired.
`Systemtags`	a comma separated list of values that will be used to filter the audiences by system tag. Audiences with a system tag matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by system tag.
`Tags`	a comma separated list of values that will be used to filter the audiences by tag. Audiences with a tag matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by tag.
`Providers`	a comma separated list of values that will be used to filter the audiences by provider. Audiences with a provider matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by provider.
`Names`	a comma separated list of values that will be used to filter the audiences by name. Audiences with a name matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by name.
`Response Type`	N/A

GET Returns a page of audiences. Results can be paged and/or sorted. Results can also be filtered by various conditions. When filtering, filter conditions are not combined and all results matching any filter value will be returned.

/api/v2/audiences

Returns a page of audiences. Results can be paged and/or sorted. Results can also be filtered by various conditions. When filtering, filter conditions are not combined and all results matching any filter value will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Sort`	a comma separated list of property names that will be used to respectively order the audiences. Each property name may optionally be followed by a colon and an order specifier of asc or desc. Specifying no value indicates that no sorting is desired.
`Systemtags`	a comma separated list of values that will be used to filter the audiences by system tag. Audiences with a system tag matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by system tag.
`Tags`	a comma separated list of values that will be used to filter the audiences by tag. Audiences with a tag matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by tag.
`Providers`	a comma separated list of values that will be used to filter the audiences by provider. Audiences with a provider matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by provider.
`Names`	a comma separated list of values that will be used to filter the audiences by name. Audiences with a name matching one or more of the specified values will be included in the returned set. To negate filtering and exclude results matching a given value, prefix the value with '!' (e.g. "!value"). Specifying no value disables filtering by name.
`Response Type`	N/A

GET Returns the audience with the specified audience identifier.

/api/v2/audiences/{audienceId}

Returns the audience with the specified audience identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Audienceid`	The audience identifier. Must not be blank.
`Response Type`	N/A

GET Returns the audience with the specified audience identifier.

/api/v1/audiences/{audienceId}

Returns the audience with the specified audience identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Audienceid`	The audience identifier. Must not be blank.
`Response Type`	N/A

GET Returns the list of audiences of which the profile is a member as {@code AudienceMembership}s objects.

/api/v2/audiences/profiles/{profileId}

Returns the list of audiences of which the profile is a member as {@code AudienceMembership}s objects.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Response Type`	N/A

GET Returns the list of audiences of which the profile is a member as {@code AudienceMembership}s objects.

/api/v1/audiences/profiles/{profileId}

Returns the list of audiences of which the profile is a member as {@code AudienceMembership}s objects.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Response Type`	N/A

GET Returns true if the specified audience has a member with the specified profile id.

/api/v2/audiences/{audienceId}/profiles/{profileId}

Returns true if the specified audience has a member with the specified profile id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Audienceid`	The audience identifier. Must not be blank.
`Profileid`	The profile identifier. Must not be blank.
`Response Type`	N/A

GET Returns true if the specified audience has a member with the specified profile id.

/api/v1/audiences/{audienceId}/profiles/{profileId}

Returns true if the specified audience has a member with the specified profile id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Audienceid`	The audience identifier. Must not be blank.
`Profileid`	The profile identifier. Must not be blank.
`Response Type`	N/A

Experienceinsights (4)

GET /api/v1/cxi/configuration

/api/v1/cxi/configuration

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PATCH /api/v1/cxi/configuration

/api/v1/cxi/configuration

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Enabled`	Controls if the Core Experience Insights service is enabled.
`Credentialsjson`	The Core Experience Insights service account key json file contents as a string.
`Sslenabled`	Controls if the Core Experience Insights integration service uses SSL for messages channels.

GET /api/v2/cxi/configuration

/api/v2/cxi/configuration

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PATCH /api/v2/cxi/configuration

/api/v2/cxi/configuration

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Enabled`	Controls if the Core Experience Insights service is enabled.
`Credentialsjson`	The Core Experience Insights service account key json file contents as a string.
`Sslenabled`	Controls if the Core Experience Insights integration service uses SSL for messages channels.

Exstream (6)

GET /api/v1/exstream/configuration

/api/v1/exstream/configuration

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PATCH /api/v1/exstream/configuration

/api/v1/exstream/configuration

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (10)

Option Name	Description
`Baseresturl`	The Exstream Orchestration API root URL. If set, must be a valid URL.
`Tokenurl`	The OAuth2 token URL. If set, must be a valid URL.
`Granttype`	OAuth2 grant-type, typically "client_credentials" or "password"
`Clientid`	OAuth2 client id
`Clientsecret`	OAuth2 client secret
`Username`	OAuth2 username (if using grant_type=password)
`Password`	OAuth2 password (if using grant_type=password)
`Communicationmap`	A map of aliases to communicationIds
`Enabled`	Controls if the Exstream service is enabled.
`Scope`	OAuth2 scope to request.

GET /api/v2/exstream/configuration

/api/v2/exstream/configuration

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PATCH /api/v2/exstream/configuration

/api/v2/exstream/configuration

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (10)

Option Name	Description
`Baseresturl`	The Exstream Orchestration API root URL. If set, must be a valid URL.
`Tokenurl`	The OAuth2 token URL. If set, must be a valid URL.
`Granttype`	OAuth2 grant-type, typically "client_credentials" or "password"
`Clientid`	OAuth2 client id
`Clientsecret`	OAuth2 client secret
`Username`	OAuth2 username (if using grant_type=password)
`Password`	OAuth2 password (if using grant_type=password)
`Communicationmap`	A map of aliases to communicationIds
`Enabled`	Controls if the Exstream service is enabled.
`Scope`	OAuth2 scope to request.

POST Initiates an Exstream communication.

/api/v2/exstream/communication

Initiates an Exstream communication.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Communicationid`	The Exstream communication (application) identifier. Must not be blank.
`Profileid`	The receipient's profile identifier. Must not be blank.

POST Initiates an Exstream communication.

/api/v1/exstream/communication

Initiates an Exstream communication.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Communicationid`	The Exstream communication (application) identifier. Must not be blank.
`Profileid`	The receipient's profile identifier. Must not be blank.

Google-analytics (10)

PATCH Patches an analytics audience with a RFC 7368 JSON Merge Patch.

/api/v2/google/analytics/accounts/{accountId}/webproperties/{propertyId}/audiences/{audienceId}

Patches an analytics audience with a RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accountid`	The Google Analytics account id. Must not be blank.
`Propertyid`	The Google Analytics web property id for UA or property id for GA4. Must not be blank.
`Audienceid`	The analytics audience id. Must not be blank.
`Refreshdefinition`	Option to refresh of the audience definition. If the definition changes, memberships are also refreshed.
`Refreshmemberships`	Option to refresh of the audience memberships.
`Response Type`	N/A

Options (1)

Option Name	Description
`Active`	Flag indicating if this analytics audience is active. Active analytics audiences definitions and memberships are tracked in DX CDE. Inactive audiences are not tracked, but read directly from Google and presented as activation targets.

PATCH Patches an analytics audience with a RFC 7368 JSON Merge Patch.

/api/v1/google/analytics/accounts/{accountId}/webproperties/{propertyId}/audiences/{audienceId}

Patches an analytics audience with a RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accountid`	The Google Analytics account id. Must not be blank.
`Propertyid`	The Google Analytics web property id for UA or property id for GA4. Must not be blank.
`Audienceid`	The analytics audience id. Must not be blank.
`Refreshdefinition`	Option to refresh of the audience definition. If the definition changes, memberships are also refreshed.
`Refreshmemberships`	Option to refresh of the audience memberships.
`Response Type`	N/A

Options (1)

Option Name	Description
`Active`	Flag indicating if this analytics audience is active. Active analytics audiences definitions and memberships are tracked in DX CDE. Inactive audiences are not tracked, but read directly from Google and presented as activation targets.

PATCH Patches the analytics configuration with a RFC 7368 JSON Merge Patch.

/api/v2/google/analytics/configuration

Patches the analytics configuration with a RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Analyticsscopes`	The set of Google Analytics OAuth 2.0 scopes to request.
`Audiencedefinitionrefreshinterval`	The interval for refreshing audience definitions. Valid values must be >= PT1H and <= P30D.
`Audiencememberindexpersistencebulksize`	The size in items for persistence of audience members during membership refresh.
`Audiencemembershiprefreshinterval`	The interval for refreshing audience memberships. Valid values must be >= PT1H and <= P30D.
`Enabled`	Controls if the Google Analytics service is enabled.
`Googlecredentialsjson`	The Google service account key json file contents as a string.
`Profiledimensionname`	The name of the custom dimension that identifies the profile id. If blank, then with Google UA the Google system dimension with the id ``ga:clientId` will be used to obtain the profile id. With Google GA4 a custom dimension must be defined and the name can be specified here, but by default the custom dimension id `customUser:clientId` will be used to obtain the profile id if this field is left blank. Modifications to this value are not retroactive; dimension ids that have already been recorded in `profileDimensionIds` will not be affected. In order to force a re-evaluation of dimension ids with a new name, remove entries from `profileDimensionIds``.

PATCH Patches the analytics configuration with a RFC 7368 JSON Merge Patch.

/api/v1/google/analytics/configuration

Patches the analytics configuration with a RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Analyticsscopes`	The set of Google Analytics OAuth 2.0 scopes to request.
`Audiencedefinitionrefreshinterval`	The interval for refreshing audience definitions. Valid values must be >= PT1H and <= P30D.
`Audiencememberindexpersistencebulksize`	The size in items for persistence of audience members during membership refresh.
`Audiencemembershiprefreshinterval`	The interval for refreshing audience memberships. Valid values must be >= PT1H and <= P30D.
`Enabled`	Controls if the Google Analytics service is enabled.
`Googlecredentialsjson`	The Google service account key json file contents as a string.
`Profiledimensionname`	The name of the custom dimension that identifies the profile id. If blank, then with Google UA the Google system dimension with the id ``ga:clientId` will be used to obtain the profile id. With Google GA4 a custom dimension must be defined and the name can be specified here, but by default the custom dimension id `customUser:clientId` will be used to obtain the profile id if this field is left blank. Modifications to this value are not retroactive; dimension ids that have already been recorded in `profileDimensionIds` will not be affected. In order to force a re-evaluation of dimension ids with a new name, remove entries from `profileDimensionIds``.

GET Returns a page of analytics audiences for the specified account and property.

/api/v2/google/analytics/accounts/{accountId}/webproperties/{propertyId}/audiences

Returns a page of analytics audiences for the specified account and property.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accountid`	The Google Analytics account id. Must not be blank.
`Propertyid`	The Google Analytics web property id for UA or property id for GA4. Must not be blank.
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

GET Returns a page of analytics audiences for the specified account and property.

/api/v1/google/analytics/accounts/{accountId}/webproperties/{propertyId}/audiences

Returns a page of analytics audiences for the specified account and property.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accountid`	The Google Analytics account id. Must not be blank.
`Propertyid`	The Google Analytics web property id for UA or property id for GA4. Must not be blank.
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

GET Returns the analytics audience specified by the account, property and analytics audience id.

/api/v2/google/analytics/accounts/{accountId}/webproperties/{propertyId}/audiences/{audienceId}

Returns the analytics audience specified by the account, property and analytics audience id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accountid`	The Google Analytics account id. Must not be blank.
`Propertyid`	The Google Analytics web property id for UA or property id for GA4. Must not be blank.
`Audienceid`	The analytics audience id. Must not be blank.
`Response Type`	N/A

GET Returns the analytics audience specified by the account, property and analytics audience id.

/api/v1/google/analytics/accounts/{accountId}/webproperties/{propertyId}/audiences/{audienceId}

Returns the analytics audience specified by the account, property and analytics audience id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accountid`	The Google Analytics account id. Must not be blank.
`Propertyid`	The Google Analytics web property id for UA or property id for GA4. Must not be blank.
`Audienceid`	The analytics audience id. Must not be blank.
`Response Type`	N/A

GET Returns the current analytics configuration.

/api/v2/google/analytics/configuration

Returns the current analytics configuration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns the current analytics configuration.

/api/v1/google/analytics/configuration

Returns the current analytics configuration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Google-bigquery (24)

POST Creates a new audience query definition.

/api/v2/google/bigquery/query/audience

Creates a new audience query definition.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (12)

Option Name	Description
`Id`	The query definition identifier.
`Active`	Controls if the query definition is active.
`Name`	The query definition name.
`Description`	The query definition description.
`Projectid`	The Google BigQuery project id for the project containing the query table.
`Datasetname`	The Google BigQuery dataset name for the dataset containing the query table.
`Tablename`	The Google BigQuery table name for the table containing the audience data.
`Audienceid`	The identifier given to the audience created from the query results.
`Audiencename`	The name to give the audience created from the query results.
`Audiencedescription`	The description to give the audience created from the query results.
`Audiencetags`	The set of user managed tags to give the audience created from the query results.
`Lastmembershiprefresh`	The date of the last query results refresh.

POST Creates a new audience query definition.

/api/v1/google/bigquery/query/audience

Creates a new audience query definition.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (12)

Option Name	Description
`Id`	The query definition identifier.
`Active`	Controls if the query definition is active.
`Name`	The query definition name.
`Description`	The query definition description.
`Projectid`	The Google BigQuery project id for the project containing the query table.
`Datasetname`	The Google BigQuery dataset name for the dataset containing the query table.
`Tablename`	The Google BigQuery table name for the table containing the audience data.
`Audienceid`	The identifier given to the audience created from the query results.
`Audiencename`	The name to give the audience created from the query results.
`Audiencedescription`	The description to give the audience created from the query results.
`Audiencetags`	The set of user managed tags to give the audience created from the query results.
`Lastmembershiprefresh`	The date of the last query results refresh.

POST Creates a new profile query definition.

/api/v2/google/bigquery/query/profile

Creates a new profile query definition.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Id`	The query definition identifier.
`Active`	Controls if the query definition is active.
`Name`	The query definition name.
`Description`	The query definition description.
`Projectid`	The Google BigQuery project id for the project containing the query table.
`Datasetname`	The Google BigQuery dataset name for the dataset containing the query table.
`Tablename`	The Google BigQuery table name for the table containing the profile data.
`Profileidcolumn`	The name of the query table column that contains profile ids.
`Lastmembershiprefresh`	The date of the last query results refresh.

POST Creates a new profile query definition.

/api/v1/google/bigquery/query/profile

Creates a new profile query definition.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Id`	The query definition identifier.
`Active`	Controls if the query definition is active.
`Name`	The query definition name.
`Description`	The query definition description.
`Projectid`	The Google BigQuery project id for the project containing the query table.
`Datasetname`	The Google BigQuery dataset name for the dataset containing the query table.
`Tablename`	The Google BigQuery table name for the table containing the profile data.
`Profileidcolumn`	The name of the query table column that contains profile ids.
`Lastmembershiprefresh`	The date of the last query results refresh.

DELETE Deletes the audience query definition with the specified identifier.

/api/v2/google/bigquery/query/audience/{definitionId}

Deletes the audience query definition with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

DELETE Deletes the audience query definition with the specified identifier.

/api/v1/google/bigquery/query/audience/{definitionId}

Deletes the audience query definition with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

DELETE Deletes the profile query definition with the specified identifier.

/api/v2/google/bigquery/query/profile/{definitionId}

Deletes the profile query definition with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

DELETE Deletes the profile query definition with the specified identifier.

/api/v1/google/bigquery/query/profile/{definitionId}

Deletes the profile query definition with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

PATCH Patches a audience query definition with an RFC 7368 JSON Merge Patch.

/api/v2/google/bigquery/query/audience/{definitionId}

Patches a audience query definition with an RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

Options (6)

Option Name	Description
`Active`	Controls if the query definition is active.
`Name`	The query definition name.
`Description`	The query definition description.
`Audiencename`	The name to give the audience created from the query results.
`Audiencedescription`	The description to give the audience created from the query results.
`Audiencetags`	The set of user managed tags to give the audience created from the query results.

PATCH Patches a audience query definition with an RFC 7368 JSON Merge Patch.

/api/v1/google/bigquery/query/audience/{definitionId}

Patches a audience query definition with an RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

Options (6)

Option Name	Description
`Active`	Controls if the query definition is active.
`Name`	The query definition name.
`Description`	The query definition description.
`Audiencename`	The name to give the audience created from the query results.
`Audiencedescription`	The description to give the audience created from the query results.
`Audiencetags`	The set of user managed tags to give the audience created from the query results.

PATCH Patches a profile query definition with an RFC 7368 JSON Merge Patch.

/api/v2/google/bigquery/query/profile/{definitionId}

Patches a profile query definition with an RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

Options (4)

Option Name	Description
`Active`	Controls if the query definition is active.
`Name`	The query definition name.
`Description`	The query definition description.
`Profileidcolumn`	The name of the query table column that contains profile ids.

PATCH Patches a profile query definition with an RFC 7368 JSON Merge Patch.

/api/v1/google/bigquery/query/profile/{definitionId}

Patches a profile query definition with an RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

Options (4)

Option Name	Description
`Active`	Controls if the query definition is active.
`Name`	The query definition name.
`Description`	The query definition description.
`Profileidcolumn`	The name of the query table column that contains profile ids.

PATCH Patches the bigquery configuration with a RFC 7368 JSON Merge Patch.

/api/v2/google/bigquery/configuration

Patches the bigquery configuration with a RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Queryresultsmaximumpagesize`	The maximum number of BigQuery query results to read in a single request.
`Readtimeout`	Tthe timeout in milliseconds to read data from an established connection or 0 for an infinite timeout.
`Bigqueryscopes`	The set of Google BigQuery OAuth 2.0 scopes to request.
`Enabled`	Controls if the Google BigQuery service is enabled.
`Googlecredentialsjson`	The Google service account key json file contents as a string.
`Rooturl`	The Google BigQuery API root URL.

PATCH Patches the bigquery configuration with a RFC 7368 JSON Merge Patch.

/api/v1/google/bigquery/configuration

Patches the bigquery configuration with a RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Queryresultsmaximumpagesize`	The maximum number of BigQuery query results to read in a single request.
`Readtimeout`	Tthe timeout in milliseconds to read data from an established connection or 0 for an infinite timeout.
`Bigqueryscopes`	The set of Google BigQuery OAuth 2.0 scopes to request.
`Enabled`	Controls if the Google BigQuery service is enabled.
`Googlecredentialsjson`	The Google service account key json file contents as a string.
`Rooturl`	The Google BigQuery API root URL.

GET Returns a page of audience query definitions.

/api/v2/google/bigquery/query/audience

Returns a page of audience query definitions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

GET Returns a page of audience query definitions.

/api/v1/google/bigquery/query/audience

Returns a page of audience query definitions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

GET Returns a page of profile query definitions.

/api/v2/google/bigquery/query/profile

Returns a page of profile query definitions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

GET Returns a page of profile query definitions.

/api/v1/google/bigquery/query/profile

Returns a page of profile query definitions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

GET Returns the current bigquery configuration.

/api/v2/google/bigquery/configuration

Returns the current bigquery configuration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns the current bigquery configuration.

/api/v1/google/bigquery/configuration

Returns the current bigquery configuration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns the requested audience query definition.

/api/v2/google/bigquery/query/audience/{definitionId}

Returns the requested audience query definition.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

GET Returns the requested audience query definition.

/api/v1/google/bigquery/query/audience/{definitionId}

Returns the requested audience query definition.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

GET Returns the requested profile query definition.

/api/v2/google/bigquery/query/profile/{definitionId}

Returns the requested profile query definition.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

GET Returns the requested profile query definition.

/api/v1/google/bigquery/query/profile/{definitionId}

Returns the requested profile query definition.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Definitionid`	The Google BigQuery query definition id. Must not be blank.
`Response Type`	N/A

Metrics

GET Get a specified metric.

/api/v2/metrics

Get a specified metric.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Metricid`	The metric identifier.
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

Notifications (3)

DELETE Deletes the notification with the specified identifier.

/api/v2/notifications/{notificationId}

Deletes the notification with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Notificationid`	The notification id. Must not be blank.
`Response Type`	N/A

DELETE Deletes the notifications that match the specified filter.

/api/v2/notifications

Deletes the notifications that match the specified filter.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter`	A filter to select results by. Syntax \ ::= \ \ ::= \ \| \ \ \ \| "NOT" \ \| "(" \ ")" \ ::= \ \ \ \| \ \ "[" \ "]" \ ::= "AND" \| "OR" \ ::= ":" \| "!:" \| ">" \| ">:" \| " ::= ":" \| "!:" \ ::= \ \| \ "," \ \\ Any character string delimited by \ or \. Leading and/or trailing whitespace is not considered to be part of the property name. \\ Any character string up to, but not including, any one of a set of delimiters. The set of delimiters depends on whether or not the scalar value is enclosed in " characters. If the first (non-whitespace) character of the scalar value is ", then all characters up to the next (non-escaped) " character are considered the scalar value. The leading and ending " characters are not considered to be part of the scalar value and are discarded. To include a " in the scalar value, it must be escaped as \\\". Likewise, to include a \ character in the scalar value, it must be escaped as \\\\. If the first (non-whitespace) character of the scalar value is not " then all characters up to the next delimiter are considered the scalar value. The set of delimiters that terminate the scalar value includes: \, ",", ")" and "]". \\ The supported comparison operators for scalar values are: ":" = Equal "!:" = Not Equal ">" = Greater Than ">:" = Greater Than or Equal "\\ The supported comparison operators for set values are: ":" = In "!:" = Not In
`Response Type`	N/A

GET Returns a page of notifications. Results can be paged and/or sorted.

/api/v2/notifications

Returns a page of notifications. Results can be paged and/or sorted.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for all notifications. Note that when specifying -1, results are still limited to an enforced maximum of 1000 notifications and paging will still be required to retrieve all notifications.
`Filter`	A filter to select results by. Syntax \ ::= \ \ ::= \ \| \ \ \ \| "NOT" \ \| "(" \ ")" \ ::= \ \ \ \| \ \ "[" \ "]" \ ::= "AND" \| "OR" \ ::= ":" \| "!:" \| ">" \| ">:" \| " ::= ":" \| "!:" \ ::= \ \| \ "," \ \\ Any character string delimited by \ or \. Leading and/or trailing whitespace is not considered to be part of the property name. \\ Any character string up to, but not including, any one of a set of delimiters. The set of delimiters depends on whether or not the scalar value is enclosed in " characters. If the first (non-whitespace) character of the scalar value is ", then all characters up to the next (non-escaped) " character are considered the scalar value. The leading and ending " characters are not considered to be part of the scalar value and are discarded. To include a " in the scalar value, it must be escaped as \\\". Likewise, to include a \ character in the scalar value, it must be escaped as \\\\. If the first (non-whitespace) character of the scalar value is not " then all characters up to the next delimiter are considered the scalar value. The set of delimiters that terminate the scalar value includes: \, ",", ")" and "]". \\ The supported comparison operators for scalar values are: ":" = Equal "!:" = Not Equal ">" = Greater Than ">:" = Greater Than or Equal "\\ The supported comparison operators for set values are: ":" = In "!:" = Not In
`Sort`	a comma separated list of property names that will be used to respectively order the notifications. Each property name may optionally be followed by a colon and an order specifier of asc or desc. Specifying no value indicates that no sorting is desired.
`Response Type`	N/A

Privacy (4)

PATCH Anonymizes the profile with the specified id by deleting any properties tagged as a personal identifier.

/api/v2/privacy/profiles/{profileId}/anonymize

Anonymizes the profile with the specified id by deleting any properties tagged as a personal identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Scope`	The scope identifier.
`Response Type`	N/A

PATCH Anonymizes the profile with the specified id by deleting any properties tagged as a personal identifier.

/api/v1/privacy/profiles/{profileId}/anonymize

Anonymizes the profile with the specified id by deleting any properties tagged as a personal identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Scope`	The scope identifier.
`Response Type`	N/A

DELETE Deletes the property with the specified name from the profile with the specified id.

/api/v2/privacy/profiles/{profileId}/properties/{propertyName}

Deletes the property with the specified name from the profile with the specified id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Propertyname`	The property name. Must not be blank.
`Response Type`	N/A

DELETE Deletes the property with the specified name from the profile with the specified id.

/api/v1/privacy/profiles/{profileId}/properties/{propertyName}

Deletes the property with the specified name from the profile with the specified id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Propertyname`	The property name. Must not be blank.
`Response Type`	N/A

Profiles (8)

POST Creates a new profile.

/api/v2/profiles

Creates a new profile.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Validate`	Option to enable validation. If specified as ``true``, the profile will be validated by the schema and saved only if validation passes.
`Response Type`	N/A

Options (1)

Option Name	Description
`Itemid`	The profile identifier. Must not be blank.

POST Creates a new profile.

/api/v1/profiles

Creates a new profile.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Validate`	Option to enable validation. If specified as ``true``, the profile will be validated by the schema and saved only if validation passes.
`Response Type`	N/A

Options (1)

Option Name	Description
`Itemid`	The profile identifier. Must not be blank.

DELETE Deletes the profile with the specified identifier.

/api/v2/profiles/{profileId}

Deletes the profile with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Response Type`	N/A

DELETE Deletes the profile with the specified identifier.

/api/v1/profiles/{profileId}

Deletes the profile with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Response Type`	N/A

PATCH Patches a profile with an RFC 7368 JSON Merge Patch.

/api/v2/profiles/{profileId}

Patches a profile with an RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Validate`	Option to enable validation. If specified as ``true``, the profile will be validated by the schema and saved only if validation passes.
`Response Type`	N/A

PATCH Patches a profile with an RFC 7368 JSON Merge Patch.

/api/v1/profiles/{profileId}

Patches a profile with an RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Validate`	Option to enable validation. If specified as ``true``, the profile will be validated by the schema and saved only if validation passes.
`Response Type`	N/A

GET Returns the profile with the specified identifier.

/api/v2/profiles/{profileId}

Returns the profile with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Response Type`	N/A

GET Returns the profile with the specified identifier.

/api/v1/profiles/{profileId}

Returns the profile with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profileid`	The profile identifier. Must not be blank.
`Response Type`	N/A

Schemas (12)

POST Creates a new profile property.

/api/v2/schemas/profile/properties

Creates a new profile property.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profiledatapolicy`	Controls the behavior of the operation when related profile data exists. That is, when one or more profiles currently contain the property, should the operation on the property be allowed? allow - Allow the operation even if profile data currently exists. disallow - Disallow the operation if profile data currently exists.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST Creates a new profile property.

/api/v1/schemas/profile/properties

Creates a new profile property.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Profiledatapolicy`	Controls the behavior of the operation when related profile data exists. That is, when one or more profiles currently contain the property, should the operation on the property be allowed? allow - Allow the operation even if profile data currently exists. disallow - Disallow the operation if profile data currently exists.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

DELETE Deletes the profile property with the specified identifier.

/api/v2/schemas/profile/properties/{propertyId}

Deletes the profile property with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Propertyid`	The profile property identifier. Must be one or more alphanumeric characters.
`Profiledatapolicy`	Controls the behavior of the operation when related profile data exists. That is, when one or more profiles currently contain the property, should the operation on the property be allowed? allow - Allow the operation even if profile data currently exists. disallow - Disallow the operation if profile data currently exists.
`Response Type`	N/A

DELETE Deletes the profile property with the specified identifier.

/api/v1/schemas/profile/properties/{propertyId}

Deletes the profile property with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Propertyid`	The profile property identifier. Must be one or more alphanumeric characters.
`Profiledatapolicy`	Controls the behavior of the operation when related profile data exists. That is, when one or more profiles currently contain the property, should the operation on the property be allowed? allow - Allow the operation even if profile data currently exists. disallow - Disallow the operation if profile data currently exists.
`Response Type`	N/A

PATCH Patches a profile property with an RFC 7368 JSON Merge Patch.

/api/v2/schemas/profile/properties/{propertyId}

Patches a profile property with an RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Propertyid`	The profile property identifier. Must be one or more alphanumeric characters.
`Profiledatapolicy`	Controls the behavior of the operation when related profile data exists. That is, when one or more profiles currently contain the property, should the operation on the property be allowed? allow - Allow the operation even if profile data currently exists. disallow - Disallow the operation if profile data currently exists.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PATCH Patches a profile property with an RFC 7368 JSON Merge Patch.

/api/v1/schemas/profile/properties/{propertyId}

Patches a profile property with an RFC 7368 JSON Merge Patch.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Propertyid`	The profile property identifier. Must be one or more alphanumeric characters.
`Profiledatapolicy`	Controls the behavior of the operation when related profile data exists. That is, when one or more profiles currently contain the property, should the operation on the property be allowed? allow - Allow the operation even if profile data currently exists. disallow - Disallow the operation if profile data currently exists.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Returns a page of profile properties.

/api/v2/schemas/profile/properties

Returns a page of profile properties.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

GET Returns a page of profile properties.

/api/v1/schemas/profile/properties

Returns a page of profile properties.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	The index of the first element to retrieve. Must equal zero when the page size is equal to -1, and zero or a positive integer when the page size is not -1.
`Size`	The page size. Must be a positive integer or -1 for an unbounded page size.
`Response Type`	N/A

GET Returns the profile property with the specified identifier.

/api/v2/schemas/profile/properties/{propertyId}

Returns the profile property with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Propertyid`	The profile property identifier. Must be one or more alphanumeric characters.
`Response Type`	N/A

GET Returns the profile property with the specified identifier.

/api/v1/schemas/profile/properties/{propertyId}

Returns the profile property with the specified identifier.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Propertyid`	The profile property identifier. Must be one or more alphanumeric characters.
`Response Type`	N/A

GET Returns the profile schema in Json Schema Specification Draft 2019-09 format.

/api/v2/schemas/profile

Returns the profile schema in Json Schema Specification Draft 2019-09 format.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns the profile schema in Json Schema Specification Draft 2019-09 format.

/api/v1/schemas/profile

Returns the profile schema in Json Schema Specification Draft 2019-09 format.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

System-administration (6)

PATCH Adds JWKS endpoints

/api/v2/security/jwks/configuration

Adds JWKS endpoints

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Enabled`	Enables JWKS validation.

PATCH Adds JWKS endpoints

/api/v1/security/jwks/configuration

Adds JWKS endpoints

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Enabled`	Enables JWKS validation.

GET Gets the configured public key.

/api/v2/security/vault/publickey

Gets the configured public key.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Gets the configured public key.

/api/v1/security/vault/publickey

Gets the configured public key.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns all configured JWKS endpoints

/api/v2/security/jwks/configuration/list

Returns all configured JWKS endpoints

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns all configured JWKS endpoints

/api/v1/security/jwks/configuration/list

Returns all configured JWKS endpoints

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

System-information (4)

GET Checks the health of the vault and CDE services.

/api/v2/monitor/service

Checks the health of the vault and CDE services.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Checks the health of the vault and CDE services.

/api/v1/monitor/service

Checks the health of the vault and CDE services.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns the system version information.

/api/v2/version

Returns the system version information.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns the system version information.

/api/v1/version

Returns the system version information.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

User-administration (8)

POST Creates a user.

/api/v2/security/users

Creates a user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Username`	The username. Must not be blank.

POST Creates a user.

/api/v1/security/users

Creates a user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Username`	The username. Must not be blank.

DELETE Deletes the user with the specified username. Note, you can not delete yourself (logged in user).

/api/v2/security/users/{username}

Deletes the user with the specified username. Note, you can not delete yourself (logged in user).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Username`	The username. Must not be blank.
`Response Type`	N/A

DELETE Deletes the user with the specified username. Note, you can not delete yourself (logged in user).

/api/v1/security/users/{username}

Deletes the user with the specified username. Note, you can not delete yourself (logged in user).

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Username`	The username. Must not be blank.
`Response Type`	N/A

GET Returns the list of users.

/api/v2/security/users

Returns the list of users.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns the list of users.

/api/v1/security/users

Returns the list of users.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PATCH Updates the user with the specified username.

/api/v2/security/users/{username}

Updates the user with the specified username.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Username`	The username. Must not be blank.
`Response Type`	N/A

PATCH Updates the user with the specified username.

/api/v1/security/users/{username}

Updates the user with the specified username.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Username`	The username. Must not be blank.
`Response Type`	N/A