APIs for DPSK Service Template Management

Operations

Get Specific DPSK Pool Template

Request

Path

poolTemplateIdstringrequired

DPSK pool template id

No request payload

Responses

DPSK pool template

Bodyapplication/vnd.ruckus.v1+json

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

application/vnd.ruckus.v1+json

{
  "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 Template

Request

Path

poolTemplateIdstringrequired

DPSK pool template id

Bodyapplication/vnd.ruckus.v1+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/vnd.ruckus.v1+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

The update request has been accepted and is in progress.

Bodyapplication/vnd.ruckus.v1+json

Response

application/vnd.ruckus.v1+json

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

Delete the DPSK Pool Template

Request

Path

poolTemplateIdstringrequired

DPSK pool template id

No request payload

Responses

The delete request has been accepted and is in progress.

Bodyapplication/vnd.ruckus.v1+json

Response

application/vnd.ruckus.v1+json

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

Update the DPSK Pool Template

Request

Path

poolTemplateIdstringrequired

DPSK pool template id

Bodyapplication/vnd.ruckus.v1+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/vnd.ruckus.v1+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

The update request has been accepted and is in progress.

Bodyapplication/vnd.ruckus.v1+json

Response

application/vnd.ruckus.v1+json

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

Create New DPSK Pool Template with Identity Group

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"
}

Create New DPSK Pool Template

Request

Bodyapplication/vnd.ruckus.v1+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/vnd.ruckus.v1+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 template created

Bodyapplication/vnd.ruckus.v1+json

Response

application/vnd.ruckus.v1+json

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

Clone the DPSK Pool Template

Request

Path

poolTemplateIdstringrequired

DPSK pool template id

Bodyapplication/vnd.ruckus.v1+jsonrequired

namestring[ 0 .. 255 ] charactersrequired

application/vnd.ruckus.v1+json

{
  "name": "string"
}

Responses

DPSK pool template cloned

Bodyapplication/vnd.ruckus.v1+json

Response

application/vnd.ruckus.v1+json

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

Search for DPSK Pool Templates Matching Search String in Paged Result

Request

Bodyapplication/vnd.ruckus.v1+jsonrequired

fieldsArray of strings

pageinteger(int32)

pageSizeinteger(int32)

sortFieldstring

sortOrderstring

Enum"ASC""DESC"

searchTargetFieldsArray of strings

searchStringstring

filtersobject(DpskPoolFilters)

application/vnd.ruckus.v1+json

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "passphraseFormat": [ … ],
    "isEnforced": true
  }
}

Responses

DPSK pool templates

Bodyapplication/vnd.ruckus.v1+json

fieldsArray of strings

totalCountinteger(int64)

totalPagesinteger(int32)

pageinteger(int32)

dataArray of objects(DpskPoolTemplateDto)

DPSK service templates in page.

Response

application/vnd.ruckus.v1+json

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

Get DPSK Pool Templates by Network Template

Request

Path

networkTemplateIdstringrequired

Wifi network template id

Query

pageableobject(Pageable)required

parameters for paging

pageable.pageinteger(int32)>= 0

pageable.sizeinteger(int32)>= 1

pageable.sortArray of strings

No request payload

Responses

DPSK pool template

Bodyapplication/vnd.ruckus.v1+json

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

application/vnd.ruckus.v1+json

{
  "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"
}

APIs for DPSK Service Management

Operations

APIs for DPSK Passphrase Management

Operations

APIs for DPSK Passphrase Device Management

Operations

DPSK Service (v0)