Passa al contenuto principale
API docs by Redocly

Accountcentral API (1.5.0)

Download OpenAPI specification:Download

service

The endpoints of the "service" category are designed to support other APIs

Get user basic information for API use

Search and retrive basic user information

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string",
  • "username": "string",
  • "email": "string",
  • "picture": "string",
  • "lang": "string",
  • "timezone": "string",
  • "creationGroupPk": 0,
  • "creationGroupName": "string",
  • "external": true,
  • "roles": {
    }
}

Get the list of the customers for the user

Return the list of the customers of the user identified by the authentication token

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Verify that a user is associated with a customer

Verify that the user identified by the authentication token is associated with a customer

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Responses

Response samples

Content type
application/json
{
  • "groupPk": 0,
  • "groupName": "string",
  • "status": "ACTIVE",
  • "chatEnabled": true
}

Get user basic information

Search and retrive basic information for an user. Use the query parameter 'expand=platform' to get info about groups, workspaces and nodes

Authorizations:
clabPlatformOauth2
query Parameters
expand
string

section to be expanded: set 'expand=platform' to get platform section data

Responses

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string",
  • "username": "string",
  • "email": "string",
  • "picture": "string",
  • "lang": "string",
  • "timezone": "string",
  • "creationGroupPk": 0,
  • "creationGroupName": "string",
  • "external": true,
  • "roles": {
    },
  • "platform": {
    }
}

user

Get user personal info

Search and retrive personal info for an user

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string",
  • "username": "string",
  • "email": "string",
  • "groupName": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "dateOfBirth": "string",
  • "sex": "string",
  • "cellPhoneVerified": true,
  • "status": "ACTIVE",
  • "userType": "INTERACTIVE"
}

Update user personal info

Update personal info for an user

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
userPk
integer
name
string
surname
string
username
string

cannot be changed

email
string
groupName
string
phone
string
cellPhone
string
dateOfBirth
string
sex
string

M for Male, F for Female

cellPhoneVerified
boolean
status
string
Enum: "ACTIVE" "SUSPENDED" "DISABLED"
  • ACTIVE: user can login
  • SUSPENDED: user cannot login because has been blocked on the base of a suspicious activity with his/her account
  • DISABLED: the accunt has been disabled by an explicit action of an administrator
userType
string
Enum: "INTERACTIVE" "APPLICATION"
  • INTERACTIVE: a user that can login
  • APPLICATION: credentials for an application

Responses

Request samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string",
  • "username": "string",
  • "email": "string",
  • "groupName": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "dateOfBirth": "string",
  • "sex": "string",
  • "cellPhoneVerified": true,
  • "status": "ACTIVE",
  • "userType": "INTERACTIVE"
}

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string",
  • "username": "string",
  • "email": "string",
  • "groupName": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "dateOfBirth": "string",
  • "sex": "string",
  • "cellPhoneVerified": true,
  • "status": "ACTIVE",
  • "userType": "INTERACTIVE"
}

Get user preferences

Search and retrive preferences for an user

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "timezone": "string",
  • "language": "string",
  • "weekBegin": "string",
  • "numberFormat": {
    },
  • "dateFormat": {
    },
  • "hourFormat": {
    }
}

Update user preferences

Update preferences for an user

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
timezone
string
language
string
weekBegin
string
object
object
object

Responses

Request samples

Content type
application/json
{
  • "timezone": "string",
  • "language": "string",
  • "weekBegin": "string",
  • "numberFormat": {
    },
  • "dateFormat": {
    },
  • "hourFormat": {
    }
}

Response samples

Content type
application/json
{
  • "timezone": "string",
  • "language": "string",
  • "weekBegin": "string",
  • "numberFormat": {
    },
  • "dateFormat": {
    },
  • "hourFormat": {
    }
}

Get user security events

Search and retrive security events for an user, order by date descending

Authorizations:
clabPlatformOauth2
query Parameters
size
integer

maximum elements to be retrieved

page
integer

page

type
string

filter events by type

exclude-app
Array of strings

exclude apps from the events

from
integer

date from

to
integer

date to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get first and last access for all apps used

Get first and last access for all apps used

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get informations about password history

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "updateDate": "2019-08-24",
  • "expireDate": "2019-08-24",
  • "now": "2019-08-24"
}

change password

change the old password with a new valid one

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
oldPassword
required
string

the old password

newPassword
required
string

the new password

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "string",
  • "newPassword": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get info about the activation of PIN

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "active": true
}

request a verification code

request a verification code for user mobile number that will be sent by sms

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

verify verification code

verify that the verification code is correct and code lifetime is less than 10 min

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
code
required
integer

verification code

Responses

Request samples

Content type
application/json
{
  • "code": 0
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

get two factor status

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "active": true
}

activate/deactivate two factor for pin

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
active
boolean

two factor status

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Allowed options for user preferences

Get all allowed options for user preferences fields

Responses

Response samples

Content type
application/json
{
  • "timezones": [
    ],
  • "weekBegin": [
    ],
  • "languages": [
    ],
  • "numberFormat": {
    },
  • "dateFormat": {
    },
  • "hourFormat": {
    }
}

User role for account AccountCentral

Returns the user role in AccountCentral for the given customer. The role is assigned to specific customer using the user capabilities.

Authorizations:
clabPlatformOauth2
query Parameters
groupPk
integer

Responses

Response samples

Content type
application/json
{
  • "role": "CUSTOMER_CARE"
}

security

Get user security events

Search and retrive security events for an user, order by date descending

Authorizations:
clabPlatformOauth2
query Parameters
size
integer

maximum elements to be retrieved

page
integer

page

type
string

filter events by type

exclude-app
Array of strings

exclude apps from the events

from
integer

date from

to
integer

date to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get first and last access for all apps used

Get first and last access for all apps used

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get informations about password history

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "updateDate": "2019-08-24",
  • "expireDate": "2019-08-24",
  • "now": "2019-08-24"
}

change password

change the old password with a new valid one

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
oldPassword
required
string

the old password

newPassword
required
string

the new password

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "string",
  • "newPassword": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

Get info about the activation of PIN

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "active": true
}

request a verification code

request a verification code for user mobile number that will be sent by sms

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

verify verification code

verify that the verification code is correct and code lifetime is less than 10 min

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
code
required
integer

verification code

Responses

Request samples

Content type
application/json
{
  • "code": 0
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

get two factor status

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "active": true
}

activate/deactivate two factor for pin

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
active
boolean

two factor status

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Reset user Pin

Reset user Pin

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Reset user password

Reset user password

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string",
  • "newPassword": "string"
}

Security events for a single user

Get security events for the specified user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
query Parameters
size
integer

maximum elements to be retrieved

page
integer

page

type
string

filter events by type

from
integer

date from

to
integer

date to

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get users associated with owned customers that have failed logins

Return list of users of a customer/sub-customers that have failed logins and serveral consecutive failed logins

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum user in the page

page
integer

page to return

sort
string
days
integer

specify the range to check the logins can be from 1 to 30 days

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

request a verification code for specific user

request a verification code for user mobile number that will be sent by sms

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

verify verification code for a user

verify that the verification code is correct and code lifetime is less than 10 min

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
code
required
integer

verification code

Responses

Request samples

Content type
application/json
{
  • "code": 0
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

get two factor status for specific user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "active": true
}

activate/deactivate two factor for pin for a specific user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
active
boolean

two factor status

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

users

Get info user

Get info about an user of the team

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string",
  • "username": "string",
  • "email": "string",
  • "groupName": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "dateOfBirth": "string",
  • "sex": "string",
  • "cellPhoneVerified": true,
  • "status": "ACTIVE",
  • "userType": "INTERACTIVE",
  • "suspensionInfo": {
    }
}

Modify info of user

Modify info about an user of the team

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
userPk
integer
name
string
surname
string
username
string

cannot be changed

email
string
groupName
string
phone
string
cellPhone
string
dateOfBirth
string
sex
string

M for Male, F for Female

cellPhoneVerified
boolean
status
string
Enum: "ACTIVE" "SUSPENDED" "DISABLED"
  • ACTIVE: user can login
  • SUSPENDED: user cannot login because has been blocked on the base of a suspicious activity with his/her account
  • DISABLED: the accunt has been disabled by an explicit action of an administrator
userType
string
Enum: "INTERACTIVE" "APPLICATION"
  • INTERACTIVE: a user that can login
  • APPLICATION: credentials for an application

Responses

Request samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string",
  • "username": "string",
  • "email": "string",
  • "groupName": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "dateOfBirth": "string",
  • "sex": "string",
  • "cellPhoneVerified": true,
  • "status": "ACTIVE",
  • "userType": "INTERACTIVE"
}

Response samples

Content type
application/json
{
  • "userPk": 0,
  • "name": "string",
  • "surname": "string",
  • "username": "string",
  • "email": "string",
  • "groupName": "string",
  • "phone": "string",
  • "cellPhone": "string",
  • "dateOfBirth": "string",
  • "sex": "string",
  • "cellPhoneVerified": true,
  • "status": "ACTIVE",
  • "userType": "INTERACTIVE"
}

suspend or reactivate a user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
suspended
boolean

true to suspend, false to reactivate

Responses

Request samples

Content type
application/json
{
  • "suspended": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

retrieve info about lockout for user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "lockedOut": true,
  • "lockExpirationDate": "string"
}

unlock user resetting lockout attempts

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Get associated customers

Get the list of associated customers for a user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
query Parameters
size
integer

maximum elements to be retrieved

page
integer

page

groupName
string

value of the filter over groupName field

groupNameMode
string

mode of the filter. | startsWith - search string stating with filter value default is containing

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Associate customers

Associate a list of customers to an user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
Array
integer

id to be associated

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Remove customers association

Remove association of customers to an user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Get user preferences

Search and retrive preferences for an user of the team

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timezone": "string",
  • "language": "string",
  • "weekBegin": "string",
  • "numberFormat": {
    },
  • "dateFormat": {
    },
  • "hourFormat": {
    }
}

Update user preferences

Update preferences for an user of the team

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
timezone
string
language
string
weekBegin
string
object
object
object

Responses

Request samples

Content type
application/json
{
  • "timezone": "string",
  • "language": "string",
  • "weekBegin": "string",
  • "numberFormat": {
    },
  • "dateFormat": {
    },
  • "hourFormat": {
    }
}

Response samples

Content type
application/json
{
  • "timezone": "string",
  • "language": "string",
  • "weekBegin": "string",
  • "numberFormat": {
    },
  • "dateFormat": {
    },
  • "hourFormat": {
    }
}

Reset user Pin

Reset user Pin

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Reset user password

Reset user password

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string",
  • "newPassword": "string"
}

Security events for a single user

Get security events for the specified user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
query Parameters
size
integer

maximum elements to be retrieved

page
integer

page

type
string

filter events by type

from
integer

date from

to
integer

date to

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get roles of applications for userPk

Get the map of roles the user has in all applications

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Assign roles

Assign roles for hub, plan and flow applications. Apply pattern for send roles.

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
accountcentral
string

the role to assign for the accountcentral application.

hub
string

the role to assign for the ContactHub application

mc
string

the role to assign for the marketing cloud application

cplan
string

the role to assign for the ContactPlan application

send
string

the role to assign for the ContactSend application

content
string

the role to assign for the content provider application

flow
string

the role to assign for the ContactFlow application

eddie
string

the role to assign for the EmailDesigner application

demo_client
string

the role to assign for the jquery demo client

Responses

Request samples

Content type
application/json
{
  • "accountcentral": "string",
  • "hub": "string",
  • "mc": "string",
  • "cplan": "string",
  • "send": "string",
  • "content": "string",
  • "flow": "string",
  • "eddie": "string",
  • "demo_client": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "logref": "string",
  • "data": { },
  • "errors": [
    ]
}

request a verification code for specific user

request a verification code for user mobile number that will be sent by sms

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

verify verification code for a user

verify that the verification code is correct and code lifetime is less than 10 min

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
code
required
integer

verification code

Responses

Request samples

Content type
application/json
{
  • "code": 0
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

get two factor status for specific user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "active": true
}

activate/deactivate two factor for pin for a specific user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
active
boolean

two factor status

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Grant capability

Grant the given capability to the user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
application
string

client id of the application

version
integer

version of the capabilities schema for the application

resource
Array of strings

path of the resource for the given capabilities schema

role
string

role granted to the resource

Responses

Request samples

Content type
application/json
{
  • "application": "string",
  • "version": 0,
  • "resource": [
    ],
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Revoke capability

Revoke the given capability to the user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

User capability log

Return the history of all capabilities granted and revoked to the user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

customers

Get associated customers

Get the list of associated customers for a user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
query Parameters
size
integer

maximum elements to be retrieved

page
integer

page

groupName
string

value of the filter over groupName field

groupNameMode
string

mode of the filter. | startsWith - search string stating with filter value default is containing

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Associate customers

Associate a list of customers to an user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
Array
integer

id to be associated

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Remove customers association

Remove association of customers to an user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Get customers

Return list of customers associated with logged user

Authorizations:
clabPlatformOauth2
query Parameters
size
integer

maximum customers in the page

page
integer

page to return

name
string

filter for group name

excludeUserPk
integer

exclude all groups associated to the userPk

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get customers

Return list of parents of the selected customer

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum customers in the page

page
integer

page to return

name
string

filter for group name

excludeUserPk
integer

exclude all groups associated to the userPk

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get customer

Return full info for customer

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "country": "string",
  • "phone": "string",
  • "platformResponsible": "string",
  • "technicalResponsible": "string",
  • "privacyResponsible": "string",
  • "status": "ACTIVE",
  • "premium": true,
  • "gid": "string"
}

Update customer

Update info of customer

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

customer to update

Request Body schema: application/json
required
name
string

name of customer

address
string

address of the customer

country
string

country of the customer

phone
string

phone number of the customer

platformResponsible
string

email of the platform responsible

technicalResponsible
string

email of the technical responsible

privacyResponsible
string

email of the privacy responsible

status
string
Enum: "ACTIVE" "SUSPENDED" "INACTIVE"
premium
boolean
gid
string

group id of customer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "country": "string",
  • "phone": "string",
  • "platformResponsible": "string",
  • "technicalResponsible": "string",
  • "privacyResponsible": "string",
  • "status": "ACTIVE",
  • "premium": true,
  • "gid": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "country": "string",
  • "phone": "string",
  • "platformResponsible": "string",
  • "technicalResponsible": "string",
  • "privacyResponsible": "string",
  • "status": "ACTIVE",
  • "premium": true,
  • "gid": "string"
}

Partial update customer (only status)

Update status of customer

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

customer to update

Request Body schema: application/json
required
status
string
Enum: "ACTIVE" "SUSPENDED" "INACTIVE"

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "country": "string",
  • "phone": "string",
  • "platformResponsible": "string",
  • "technicalResponsible": "string",
  • "privacyResponsible": "string",
  • "status": "ACTIVE",
  • "premium": true,
  • "gid": "string"
}

Get users associated with owned customers

Return list of users of a customer/sub-customers

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum user in the page

page
integer

page to return

sort
string

sort by column, by default asc sorting

search
string

fulltext search in name, surname, username or email

userType
string
Enum: "INTERACTIVE" "APPLICATION"

when present, filter on user type:

  • INTERACTIVE: users that can login
  • APPLICATION: credentials for applications
status
string
Enum: "ACTIVE" "SUSPENDED" "DISABLED"

when present, filter on on user status:

  • ACTIVE
  • SUSPENDED
  • DISABLED

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Create user

Create user associated with customer

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Request Body schema: application/json
required

data for user creation

username
required
string
name
required
string
surname
required
string
email
required
string
language
required
string
sex
required
string
send
string

SEND role to assign to the new user, can be 'default' 'noSend', 'onlyStat'. | if null the user will have blank permission

hub
string

role for HUB

cplan
string

role for PLAN

flow
string

role for FLOW

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "name": "string",
  • "surname": "string",
  • "email": "string",
  • "language": "string",
  • "sex": "string",
  • "send": "string",
  • "hub": "string",
  • "cplan": "string",
  • "flow": "string"
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Get application users associated with owned customers with secret creation informations

Return list of application users of a customer with secret creation information

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum user in the page

page
integer

page to return

sort
string

sort by column, by default asc sorting

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

List of users that have used any application for a customer

Return list of users that have used any application for a customer and the first and last access time

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum user in the page

page
integer

page to return

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

List of users that have used an application for a customer

Return list of users that have used an application for a customer and the first and last access time

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

application
required
string

application used for the customer (cdata, cplan, flow, hub, send, srr)

query Parameters
size
integer

maximum user in the page

page
integer

page to return

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get users associated with owned customers that have issues

Return list of users of a customer/sub-customers that have issues

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum user in the page

page
integer

page to return

sort
string

sort by column, by default asc sorting

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get users associated with owned customers that have failed logins

Return list of users of a customer/sub-customers that have failed logins and serveral consecutive failed logins

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum user in the page

page
integer

page to return

sort
string
days
integer

specify the range to check the logins can be from 1 to 30 days

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get customer configuration

Return customer configuration

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Responses

Response samples

Content type
application/json
{
  • "gid": "string",
  • "apiKey": {
    },
  • "smartRelayEnable": true,
  • "genericUsers": [
    ],
  • "dataExchanges": [
    ]
}

Get customer configuration for sftp

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get customer applications configurations

Return customer applications configurations

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Responses

Response samples

Content type
application/json
{
  • "hub": {
    },
  • "plan": {
    },
  • "send": {
    }
}

Get customer specific application configurations

Return customer application configurations

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

application
required
string

target application

Responses

Get the counters for an hub workspace

Get the counters for nodes and sources in an hub workspace

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

workspaceId
required
integer

target workspaceId

query Parameters
nodes
Array of integers

nodes to be considered

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get customers dkims

Return customer dkims.

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum items in the page

page
integer

page to return

domain
string

Filter the dkims by the specified domain

default
boolean

Filter the dkims by the specified value

active
boolean

Filter the dkims by active value

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Register a new dkim

Register a new dkim

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Request Body schema: application/json
required
domain
required
string
selector
required
string
publicKey
required
string
privateKey
required
string
active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Update dkim

Update dkim.

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

dkimId
required
integer

dkim id

Request Body schema: application/json
required
domain
required
string
selector
required
string
publicKey
required
string
privateKey
required
string
active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Delete a dkim

Delete a dkim.

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

dkimId
required
integer

dkim id

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Allowed options for customer preferences

Get all allowed options for customer preferences fields

Responses

Response samples

Content type
application/json
{
  • "countries": [
    ]
}

applications

Get customer applications configurations

Return customer applications configurations

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Responses

Response samples

Content type
application/json
{
  • "hub": {
    },
  • "plan": {
    },
  • "send": {
    }
}

Get customer specific application configurations

Return customer application configurations

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

application
required
string

target application

Responses

Get the counters for an hub workspace

Get the counters for nodes and sources in an hub workspace

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

workspaceId
required
integer

target workspaceId

query Parameters
nodes
Array of integers

nodes to be considered

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Applications of contactlab platform

Get all applications available in contactlab, based on environment

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get status of the application

Authorizations:
clabPlatformOauth2
path Parameters
application
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "UP"
}

Sets status of the application

Authorizations:
clabPlatformOauth2
path Parameters
application
required
string
Request Body schema: application/json
required
status
string
Enum: "UP" "DOWN"

Enum, can be "UP" or "DOWN"

Responses

Request samples

Content type
application/json
{
  • "status": "UP"
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "resultCode": "string",
  • "timestamp": 0
}

Subscribes to an application status changes SSE notification

The client application opens an EventSource connection to the path to receive notifications from AccountCentral

Authorizations:
clabPlatformOauth2
path Parameters
application
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

dkim

Get customers dkims

Return customer dkims.

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
size
integer

maximum items in the page

page
integer

page to return

domain
string

Filter the dkims by the specified domain

default
boolean

Filter the dkims by the specified value

active
boolean

Filter the dkims by active value

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Register a new dkim

Register a new dkim

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Request Body schema: application/json
required
domain
required
string
selector
required
string
publicKey
required
string
privateKey
required
string
active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Get customer dkim by id

Return customer dkim.

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

dkimId
required
integer

dkim id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string",
  • "alignment": "EXACT",
  • "default": true
}

Update dkim

Update dkim.

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

dkimId
required
integer

dkim id

Request Body schema: application/json
required
domain
required
string
selector
required
string
publicKey
required
string
privateKey
required
string
active
required
boolean

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Delete a dkim

Delete a dkim.

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

dkimId
required
integer

dkim id

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Set customer default dkim

Set customer default dkim

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

Request Body schema: application/json
id
required
integer

id of the default dkim

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Get signing dkim by domain

Returns signing Dkim by domain. Default Dkim is returned if domain is not specified. Platform Dkim is returned if the customer does not have any custom Dkims.

Authorizations:
clabPlatformOauth2
path Parameters
groupPk
required
integer

target groupPk

query Parameters
domain
string

sender domain to get the dkim from

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string",
  • "alignment": "EXACT",
  • "default": true
}

Apply the DKIM signature(s) to an email message

Apply the neccessary DKIM signature(s) to an email message. The correct signing key is selected as follows

  • If the customer has multiple signing keys the one exactly matching the sender domain is used
  • If the cusotmer has only a signing key or if no one of the customer keys matches exacly the sender domain then the customer's default key is used
  • If the customer has no key the default for the contactlab platform is used For recipient domain tha need an FBL the relevant signature is applied as well.
path Parameters
groupPk
required
integer

target groupPk

Request Body schema: application/json
message
required
string

the email message to be signed (headers and all)

required
object (MessageSigningData)
applyDkim
boolean

specify if dkim signing has to be applied (default true)

applyFbl
boolean

specify if the fbl signing has to be applied (defualt true)

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "applyDkim": true,
  • "applyFbl": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "dkim": {
    },
  • "fbl": {
    }
}

Retrieve all customer DKIMs

Retrieve a paged collection of all customer DKIMs. The collection is sorted by acending cusotmer ID and domain name

Authorizations:
clabPlatformOauth2
query Parameters
page
integer

the page to retrieve

size
integer

the page size

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Get platform dkim

Return platform dkim.

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string"
}

Update platform dkim

Update platform dkim

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
domain
required
string
selector
required
string
publicKey
required
string
privateKey
required
string

The private key is returned only to DKIM role and is encrypted by AES symmetric algorithm. The field is null for CUSTOMER_CARE role

Responses

Request samples

Content type
application/json
{
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string"
}

Response samples

Content type
application/json
{
  • "domain": "string",
  • "selector": "string",
  • "publicKey": "string",
  • "privateKey": "string"
}

Get fbls

Return fbls.

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Create Fbl

Create Fbl

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
esp
string
recipientDomain
string
signableHeaders
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "esp": "string",
  • "recipientDomain": "string",
  • "signableHeaders": [
    ],
  • "dkim": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "esp": "string",
  • "recipientDomain": "string",
  • "signableHeaders": [
    ],
  • "dkim": {
    }
}

Update Fbl

Update Fbl

Authorizations:
clabPlatformOauth2
path Parameters
uuid
required
string

target uuid

Request Body schema: application/json
esp
string
recipientDomain
string
signableHeaders
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "esp": "string",
  • "recipientDomain": "string",
  • "signableHeaders": [
    ],
  • "dkim": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "esp": "string",
  • "recipientDomain": "string",
  • "signableHeaders": [
    ],
  • "dkim": {
    }
}

Delete fbls

delete fbls.

Authorizations:
clabPlatformOauth2
path Parameters
uuid
required
string

target uuid

Responses

customer

Apply the DKIM signature(s) to an email message

Apply the neccessary DKIM signature(s) to an email message. The correct signing key is selected as follows

  • If the customer has multiple signing keys the one exactly matching the sender domain is used
  • If the cusotmer has only a signing key or if no one of the customer keys matches exacly the sender domain then the customer's default key is used
  • If the customer has no key the default for the contactlab platform is used For recipient domain tha need an FBL the relevant signature is applied as well.
path Parameters
groupPk
required
integer

target groupPk

Request Body schema: application/json
message
required
string

the email message to be signed (headers and all)

required
object (MessageSigningData)
applyDkim
boolean

specify if dkim signing has to be applied (default true)

applyFbl
boolean

specify if the fbl signing has to be applied (defualt true)

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    },
  • "applyDkim": true,
  • "applyFbl": true
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "dkim": {
    },
  • "fbl": {
    }
}

options

Allowed options for user preferences

Get all allowed options for user preferences fields

Responses

Response samples

Content type
application/json
{
  • "timezones": [
    ],
  • "weekBegin": [
    ],
  • "languages": [
    ],
  • "numberFormat": {
    },
  • "dateFormat": {
    },
  • "hourFormat": {
    }
}

Allowed options for customer preferences

Get all allowed options for customer preferences fields

Responses

Response samples

Content type
application/json
{
  • "countries": [
    ]
}

Sites related to contactlab

Get all Sites related to contactlab (applications, network and social)

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "networkSites": [
    ],
  • "socialSites": [
    ]
}

Applications of contactlab platform

Get all applications available in contactlab, based on environment

Responses

Response samples

Content type
application/json
[
  • {
    }
]

network sites of contactlab

Get all network sites related to contactlab

Responses

Response samples

Content type
application/json
[
  • {
    }
]

social sites of contactlab

Get all social sites of contactlab

Responses

Response samples

Content type
application/json
[
  • {
    }
]

app roles

app roles used during creation of user

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

notifications

Get notifications

Return list of notifications related with logged user, order by date desc

Authorizations:
clabPlatformOauth2
query Parameters
page
integer
size
integer

total notifications to return

notRead
boolean

flag, if true return only the notifications not already read

priority
string
application
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Enqueue a new notification

Enqueue a new notification that will be consumed later asynchronously

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
object
object

Responses

Request samples

Content type
application/json
{
  • "destination": {
    },
  • "notification": {
    }
}

Response samples

Content type
application/json
{
  • "destination": {
    },
  • "notification": {
    }
}

Mark notifications as read

Mark the notifications linked to the provided ids as read

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
required
Array
integer

id to be marked

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Subcribe to get push notifications

Subscribe through sse to get platform notifications

Authorizations:
clabPlatformOauth2

Responses

Response samples

Content type
application/json
{ }

news

Get news

Return list of news, order by publish date descending

Authorizations:
clabPlatformOauth2
query Parameters
page
integer
size
integer

total notifications to return

category
Array of integers

filter news which have categories with one of the id provided

lang
string
Enum: "it" "en"

override user lang, if invalid fallback to en language, supported ['it', 'en']

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

Trigger update from explora

Trigger update from explora

Authorizations:
clabPlatformOauth2

Responses

status

Get status of the application

Authorizations:
clabPlatformOauth2
path Parameters
application
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "UP"
}

Sets status of the application

Authorizations:
clabPlatformOauth2
path Parameters
application
required
string
Request Body schema: application/json
required
status
string
Enum: "UP" "DOWN"

Enum, can be "UP" or "DOWN"

Responses

Request samples

Content type
application/json
{
  • "status": "UP"
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "resultCode": "string",
  • "timestamp": 0
}

Subscribes to an application status changes SSE notification

The client application opens an EventSource connection to the path to receive notifications from AccountCentral

Authorizations:
clabPlatformOauth2
path Parameters
application
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

capabilities

Grant capability

Grant the given capability to the user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
Request Body schema: application/json
required
application
string

client id of the application

version
integer

version of the capabilities schema for the application

resource
Array of strings

path of the resource for the given capabilities schema

role
string

role granted to the resource

Responses

Request samples

Content type
application/json
{
  • "application": "string",
  • "version": 0,
  • "resource": [
    ],
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

Revoke capability

Revoke the given capability to the user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "result": "string",
  • "resultCode": "string"
}

User capability log

Return the history of all capabilities granted and revoked to the user

Authorizations:
clabPlatformOauth2
path Parameters
userPk
required
integer

Responses

Response samples

Content type
application/json
{
  • "page": {
    },
  • "elements": [
    ]
}

User capabilities to support oauth2 authentication server

Return the user capabilities that will be used from the authorization server. This endpoint is dedicated to the authorization server.

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

internal

User capabilities to support oauth2 authentication server

Return the user capabilities that will be used from the authorization server. This endpoint is dedicated to the authorization server.

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

provisioning

get the list of customer provisioning jobs

Authorizations:
clabPlatformOauth2
query Parameters
groupPk
integer

filter jobs by customer id

page
integer

the page number in the collection, starting from 0

size
integer

the collection's page size

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "page": {
    }
}

create a new job

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
groupPk
integer

the customer id

operation
string
Enum: "PREPARE_DEACTIVATION" "DEACTIVATE"

Responses

Request samples

Content type
application/json
{
  • "groupPk": 0,
  • "operation": "PREPARE_DEACTIVATION"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "groupPk": 0,
  • "operation": "PREPARE_DEACTIVATION",
  • "status": "NEW",
  • "actions": [
    ]
}

get the job's details

Authorizations:
clabPlatformOauth2
path Parameters
jobId
required
string

the job unique id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "groupPk": 0,
  • "operation": "PREPARE_DEACTIVATION",
  • "status": "NEW",
  • "actions": [
    ]
}

platform

get the list of customer provisioning jobs

Authorizations:
clabPlatformOauth2
query Parameters
groupPk
integer

filter jobs by customer id

page
integer

the page number in the collection, starting from 0

size
integer

the collection's page size

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "page": {
    }
}

create a new job

Authorizations:
clabPlatformOauth2
Request Body schema: application/json
groupPk
integer

the customer id

operation
string
Enum: "PREPARE_DEACTIVATION" "DEACTIVATE"

Responses

Request samples

Content type
application/json
{
  • "groupPk": 0,
  • "operation": "PREPARE_DEACTIVATION"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "groupPk": 0,
  • "operation": "PREPARE_DEACTIVATION",
  • "status": "NEW",
  • "actions": [
    ]
}

get the job's details

Authorizations:
clabPlatformOauth2
path Parameters
jobId
required
string

the job unique id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "groupPk": 0,
  • "operation": "PREPARE_DEACTIVATION",
  • "status": "NEW",
  • "actions": [
    ]
}