MediaConnect AS
Powered by Redocly

Permission/Shield

Permissions/shields exists on three levels: global, enterprise and orderType. This API can be used to get the current permissions and shields for the customer. It may also be used to update the data.

NB! Not possible to update on global level.

Field Type Description
global Level Wrapper for global level permission/shield.
enterprise Level Wrapper for enterprise level permission/shield.
orderType Level Wrapper for order type level permission/shield.
channel Channel Wrapper for channel.
type String State for the channel. Valid values: permission, shield and none.
Global level does not support permission.
value String Channel code as defined in Connect.

List global permissions

The user needs to be logged in to use this endpoint, click here to read more.

This API can be used to get the current permissions and shields for the customer. It may also be used to update the data.

SecurityAuthorization_Code
Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/pbm
Request samples 
Response samples 
application/json
{
  • "channels": [
    ]
}
List enterprise permissions
The user needs to be logged in to use this endpoint, click here to read more.


SecurityAuthorization_Code 
Request 
path Parameters
enterpriseCode
required
string  <= 12 characters 
 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/customer/pbm/{enterpriseCode}
Request samples 
Response samples 
application/json
{
  • "channels": [
    ]
}
Change enterprise permissions
The user needs to be logged in to use this endpoint, click here to read more.


SecurityAuthorization_Code 
Request 
path Parameters
enterpriseCode
required
string  <= 12 characters 
 
Request Body schema: application/json
Array of objects
 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/customer/pbm/{enterpriseCode}
Request samples 
application/json
{
  • "channels": [
    ]
}
Response samples 
application/json
{
  • "channels": [
    ]
}
List ordertype permissions
The user needs to be logged in to use this endpoint, click here to read more.


SecurityAuthorization_Code 
Request 
path Parameters
enterpriseCode
required
string  <= 12 characters 
 
orderType
required
string  <= 12 characters 
 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/customer/pbm/{enterpriseCode}/{orderType}
Request samples 
Response samples 
application/json
{
  • "channels": [
    ]
}
Change ordertype permissions
The user needs to be logged in to use this endpoint, click here to read more.


SecurityAuthorization_Code 
Request 
path Parameters
enterpriseCode
required
string  <= 12 characters 
 
orderType
required
string  <= 12 characters 
 
Request Body schema: application/json
Array of objects
 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/customer/pbm/{enterpriseCode}/{orderType}
Request samples 
application/json
{
  • "channels": [
    ]
}
Response samples 
application/json
{
  • "channels": [
    ]
}
Check shield ordertype - client mode
Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.


Use this API to shield customer(s) on order type level by a given credential. The credential is used to find customers. All customers found will be shielded against activity on specified channel.


SecurityClient_Credentials 
Request 
Request Body schema: application/json
enterpriseCode
required
string  <= 12 characters 
Enterprise company code


 
orderTypeCode
required
string  <= 12 characters 
Ordertype code


 
channel
required
string  <= 20 characters 
Distribution channel code


 
credential
required
string  <= 60 characters 
Credential - e.g mobile phonenumber or email address. I.e credential used in ConnectID


 
Responses 
200
OK


Response Schema: application/json
count
integer
Number of customers found and shielded.


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/client/shield/ordertype
Request samples 
application/json
{
  • "enterpriseCode": "468979834",
  • "orderTypeCode": "56235",
  • "channel": "DM",
  • "credential": "+4712345678"
}
Response samples 
application/json
{
  • "count": 0
}
Check shield enterprise - client mode
Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.


SecurityClient_Credentials 
Request 
Request Body schema: application/json
enterpriseCode
required
string  <= 12 characters 
Enterprise company code


 
channel
required
string  <= 20 characters 
Distribution channel code


 
credential
required
string  <= 60 characters 
Credential - e.g mobile phonenumber or email address. I.e credential used in ConnectID


 
Responses 
200
OK


Response Schema: application/json
count
integer
Number of customers found and shielded.


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/client/shield/enterprise
Request samples 
application/json
{
  • "enterpriseCode": "468979834",
  • "channel": "TM",
  • "credential": "+4712345678"
}
Response samples 
application/json
{
  • "count": 0
}
➔ Next to Privacy