Skip to content
/
Search for DPSK Pools Mat...

DPSK Service (v0)

Download OpenAPI description
Download PDF
Languages
Servers
Generated server url

http://localhost:8080/

APIs for DPSK Service Template Management

Operations

APIs for DPSK Service Management

Operations

Get Specific DPSK Pool

Request

Path
poolIdstringrequired

DPSK pool id

No request payload

Responses

DPSK pool

Body
idstring[ 0 .. 255 ] charactersread-only

Unique identifier for pool.

namestring[ 0 .. 255 ] charactersrequired
passphraseFormatstringrequired

Passphrase format.

Enum"MOST_SECURED""KEYBOARD_FRIENDLY""NUMBERS_ONLY"
passphraseLengthinteger(int32)required

Generated passphrase length.

policyDefaultAccessboolean
deviceCountLimitinteger(int32)
expirationTypestring

Expiration date rule.

Enum"SPECIFIED_DATE""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""YEARS_AFTER_TIME"
expirationOffsetinteger(int32)

Date of expiration offset.

expirationDatestring(date-time)

Expiration date of pool.

createdDatestring(date-time)read-only
lastModifiedDatestring(date-time)read-only
isReferencedbooleanread-only

If this entity is referenced by an identity group and cannot be deleted.

networkCountinteger(int32)read-only

Number of networks associated with this pool.

isEnforcedbooleanread-only

Template enforcement setting.

identityGroupIdstring

Linked identity group ID. Only editable for template.

identityIdstringDeprecatedread-only

Deprecated. Use identity group ID instead.

Response
{
  "id": "string",
  "name": "string",
  "passphraseFormat": "MOST_SECURED",
  "passphraseLength": 0,
  "policyDefaultAccess": true,
  "deviceCountLimit": 0,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "networkCount": 0,
  "isEnforced": true,
  "identityId": "string",
  "identityGroupId": "string"
}

Update the DPSK Pool

Request

Path
poolIdstringrequired

DPSK pool id

Body
required
namestring[ 0 .. 255 ] charactersrequired
passphraseFormatstringrequired

Passphrase format.

Enum"MOST_SECURED""KEYBOARD_FRIENDLY""NUMBERS_ONLY"
passphraseLengthinteger(int32)required

Generated passphrase length.

policyDefaultAccessboolean
deviceCountLimitinteger(int32)
expirationTypestring

Expiration date rule.

Enum"SPECIFIED_DATE""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""YEARS_AFTER_TIME"
expirationOffsetinteger(int32)

Date of expiration offset.

expirationDatestring(date-time)

Expiration date of pool.

identityGroupIdstring

Linked identity group ID. Only editable for template.

{
  "name": "string",
  "passphraseFormat": "MOST_SECURED",
  "passphraseLength": 0,
  "policyDefaultAccess": true,
  "deviceCountLimit": 0,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "identityGroupId": "string"
}

Responses

The update request has been accepted and is in progress.

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Delete the DPSK Pool

Request

Path
poolIdstringrequired
No request payload

Responses

The delete request has been accepted and is in progress.

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Update the DPSK Pool

Request

Path
poolIdstringrequired

DPSK pool id

Body
required
namestring[ 0 .. 255 ] charactersrequired
passphraseFormatstringrequired

Passphrase format.

Enum"MOST_SECURED""KEYBOARD_FRIENDLY""NUMBERS_ONLY"
passphraseLengthinteger(int32)required

Generated passphrase length.

policyDefaultAccessboolean
deviceCountLimitinteger(int32)
expirationTypestring

Expiration date rule.

Enum"SPECIFIED_DATE""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""YEARS_AFTER_TIME"
expirationOffsetinteger(int32)

Date of expiration offset.

expirationDatestring(date-time)

Expiration date of pool.

identityGroupIdstring

Linked identity group ID. Only editable for template.

{
  "name": "string",
  "passphraseFormat": "MOST_SECURED",
  "passphraseLength": 0,
  "policyDefaultAccess": true,
  "deviceCountLimit": 0,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "identityGroupId": "string"
}

Responses

The update request has been accepted and is in progress.

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Update Policy Set for a DPSK Pool

Request

Path
poolIdstringrequired

DPSK passphrase id

policySetIdstringrequired

Policy set id

No request payload

Responses

The update request has been accepted and is in progress

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Remove Policy Set from a DPSK Pool

Request

Path
poolIdstringrequired

DPSK passphrase id

policySetIdstringrequired

Policy set id

No request payload

Responses

The update request has been accepted and is in progress

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Create New DPSK Pool

Request

Path
identityGroupIdstringrequired

Identity group id

Bodyapplication/jsonrequired
namestring[ 0 .. 255 ] charactersrequired
passphraseFormatstringrequired

Passphrase format.

Enum"MOST_SECURED""KEYBOARD_FRIENDLY""NUMBERS_ONLY"
passphraseLengthinteger(int32)required

Generated passphrase length.

policyDefaultAccessboolean
deviceCountLimitinteger(int32)
expirationTypestring

Expiration date rule.

Enum"SPECIFIED_DATE""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""YEARS_AFTER_TIME"
expirationOffsetinteger(int32)

Date of expiration offset.

expirationDatestring(date-time)

Expiration date of pool.

identityGroupIdstring

Linked identity group ID. Only editable for template.

application/json
{
  "name": "string",
  "passphraseFormat": "MOST_SECURED",
  "passphraseLength": 0,
  "policyDefaultAccess": true,
  "deviceCountLimit": 0,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "identityGroupId": "string"
}

Responses

DPSK pool created

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for DPSK Pools Matching Search String in Paged Result

Request

Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
searchTargetFieldsArray of strings
searchStringstring
filtersobject(DpskPoolFilters)
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "passphraseFormat": [ … ],
    "isEnforced": true
  }
}

Responses

DPSK pools

Body
fieldsArray of strings
totalCountinteger(int64)
totalPagesinteger(int32)
pageinteger(int32)
dataArray of objects(DpskPoolDto)

DPSK services in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

APIs for DPSK Passphrase Management

Operations

APIs for DPSK Passphrase Device Management

Operations