Delete the Specific Identities in a Group

Identity Group

Operations

Identity

Operations

Create an Identity Into a Specific GroupDeprecated

Request

Path

groupIdstring(uuid)required

Group id

Body

required

descriptionstring<= 255 characters

The description for the identity.

namestring<= 255 charactersrequired

The name for the identity.

emailstring^[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=?`{...

The email for the identity.

Example: "john.doe@example.com"

dpskPassphrasestring

The passphrase associated with the identity. If this field is set to null in an update request, the passphrase will be reset. Note: if a passphrase is provided but is shorter than the required minimum length, it will also be reset.

revokedboolean

The field to determine if identity is revoked.

vlaninteger(int32)[ 1 .. 4094 ]

The VLAN for the identity.

devicesArray of objects(Device)

The list of devices for the identity.

ethernetPortsArray of objects(EthernetPort)

The list of ethernet port for the identity.

meteringProfileIdstring(uuid)

The identifier of the metering profile.

expirationDatestring(date-time)

The expiration date for the metering profile of this identity.

phoneNumberstring

The phone number for the identity.

primaryboolean

_linksobject(Links)

{
  "description": "string",
  "name": "string",
  "email": "john.doe@example.com",
  "dpskPassphrase": "string",
  "revoked": true,
  "vlan": 1,
  "devices": [
    { … }
  ],
  "ethernetPorts": [
    { … }
  ],
  "meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
  "expirationDate": "2019-08-24T14:15:22Z",
  "phoneNumber": "string",
  "primary": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Identity created

Body

idstring(uuid)read-only

The identifier for the identity.

groupIdstring(uuid)read-only

The identifier of the group for the identity.

parentIdstring(uuid)read-only

The identifier of the parent identity.

descriptionstring<= 255 characters

The description for the identity.

namestring<= 255 charactersrequired

The name for the identity.

emailstring^[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=?`{...

The email for the identity.

Example: "john.doe@example.com"

dpskGuidstringread-only

The identifier of the DPSK for the identity.

dpskPassphrasestring

The passphrase associated with the identity. If this field is set to null in an update request, the passphrase will be reset. Note: if a passphrase is provided but is shorter than the required minimum length, it will also be reset.

identityIdstringread-only

The identifier of entity that associated with identity.

revokedboolean

The field to determine if identity is revoked.

vlaninteger(int32)[ 1 .. 4094 ]

The VLAN for the identity.

vniinteger(int32)[ 0 .. 8388608 ]read-only

The VNI for the identity.

createdAtstring(date-time)read-only

The timestamp that the identity get created.

updatedAtstring(date-time)read-only

The timestamp that the identity get last updated.

devicesArray of objects(Device)

The list of devices for the identity.

deviceCountinteger(int32)read-only

The count of devices belongs to the identity.

ethernetPortsArray of objects(EthernetPort)

The list of ethernet port for the identity.

switchesArray of objects(Switch)read-only

The list of switch for the identity.

meteringProfileIdstring(uuid)

The identifier of the metering profile.

expirationDatestring(date-time)

The expiration date for the metering profile of this identity.

phoneNumberstring

The phone number for the identity.

externalIdentityIdstring(uuid)read-only

The identifier of the external identity for the identity.

lastLoginAtstring(date-time)read-only

The latest timestamp that the identity login.

primaryboolean

_linksobject(Links)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  "description": "string",
  "name": "string",
  "email": "john.doe@example.com",
  "dpskGuid": "string",
  "dpskPassphrase": "string",
  "identityId": "string",
  "revoked": true,
  "vlan": 1,
  "vni": 8388608,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "devices": [
    { … }
  ],
  "deviceCount": 0,
  "ethernetPorts": [
    { … }
  ],
  "switches": [
    { … }
  ],
  "meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
  "expirationDate": "2019-08-24T14:15:22Z",
  "phoneNumber": "string",
  "externalIdentityId": "a01e4ba2-4fa9-437d-852d-542fdee5487f",
  "lastLoginAt": "2019-08-24T14:15:22Z",
  "primary": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete the Specific Identities in a GroupDeprecated

Request

Path

groupIdstring(uuid)required

Group id

Body

requiredArray [

string(uuid)

]

[
  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Responses

Identities deleted

Body

object

Response

{}

Create Devices Into the IdentityDeprecated

Request

Path

groupIdstring(uuid)required

Group id

idstring(uuid)required

Identity id

Body

requiredArray [

macAddressstring^([0-9A-F]{2}-){5}([0-9A-F]{2})$required

The MAC of the device.

statusArray of objects(DeviceStatusDto)

]

[
  {
    "macAddress": "string",
    "status": [ … ]
  }
]

Responses

Devices created

Body

Array [

macAddressstring^([0-9A-F]{2}-){5}([0-9A-F]{2})$required

The MAC of the device.

recentStatusstringread-only

The latest status for the device.

hasMacRegisteredbooleanread-only

Determine if the device has registered for MAC authentication.

lastSeenAtstring(date-time)read-only

The latest timestamp that the device was seen.

createdAtstring(date-time)read-only

The timestamp that the device get created.

updatedAtstring(date-time)read-only

The latest timestamp that the device get updated.

statusArray of objects(DeviceStatusDto)

identityIdstring(uuid)read-only

The identifier of the identity that the device belongs to.

]

Response

[
  {
    "macAddress": "string",
    "recentStatus": "string",
    "hasMacRegistered": true,
    "lastSeenAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "status": [ … ],
    "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256"
  }
]

Import Identities Into the Specified Identity GroupDeprecated

Request

Path

groupIdstring(uuid)required

Bodymultipart/form-data

filestring(binary)required

multipart/form-data

{
  "file": "string"
}

Responses

The Identities get created

Body

Array [

idstring(uuid)read-only

The identifier for the identity.

groupIdstring(uuid)read-only

The identifier of the group for the identity.

parentIdstring(uuid)read-only

The identifier of the parent identity.

descriptionstring<= 255 characters

The description for the identity.

namestring<= 255 charactersrequired

The name for the identity.

emailstring^[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=?`{...

The email for the identity.

Example: "john.doe@example.com"

dpskGuidstringread-only

The identifier of the DPSK for the identity.

dpskPassphrasestring

The passphrase associated with the identity. If this field is set to null in an update request, the passphrase will be reset. Note: if a passphrase is provided but is shorter than the required minimum length, it will also be reset.

identityIdstringread-only

The identifier of entity that associated with identity.

revokedboolean

The field to determine if identity is revoked.

vlaninteger(int32)[ 1 .. 4094 ]

The VLAN for the identity.

vniinteger(int32)[ 0 .. 8388608 ]read-only

The VNI for the identity.

createdAtstring(date-time)read-only

The timestamp that the identity get created.

updatedAtstring(date-time)read-only

The timestamp that the identity get last updated.

devicesArray of objects(Device)

The list of devices for the identity.

deviceCountinteger(int32)read-only

The count of devices belongs to the identity.

ethernetPortsArray of objects(EthernetPort)

The list of ethernet port for the identity.

switchesArray of objects(Switch)read-only

The list of switch for the identity.

meteringProfileIdstring(uuid)

The identifier of the metering profile.

expirationDatestring(date-time)

The expiration date for the metering profile of this identity.

phoneNumberstring

The phone number for the identity.

externalIdentityIdstring(uuid)read-only

The identifier of the external identity for the identity.

lastLoginAtstring(date-time)read-only

The latest timestamp that the identity login.

primaryboolean

_linksobject(Links)

]

Response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
    "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
    "description": "string",
    "name": "string",
    "email": "john.doe@example.com",
    "dpskGuid": "string",
    "dpskPassphrase": "string",
    "identityId": "string",
    "revoked": true,
    "vlan": 1,
    "vni": 8388608,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "devices": [ … ],
    "deviceCount": 0,
    "ethernetPorts": [ … ],
    "switches": [ … ],
    "meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
    "expirationDate": "2019-08-24T14:15:22Z",
    "phoneNumber": "string",
    "externalIdentityId": "a01e4ba2-4fa9-437d-852d-542fdee5487f",
    "lastLoginAt": "2019-08-24T14:15:22Z",
    "primary": true,
    "_links": { … }
  }
]

Export the Identities Into a CSV FileDeprecated

Request

Query

pageableobject(Pageable)required

Parameters for paging

pageable.pageinteger(int32)>= 0

pageable.sizeinteger(int32)>= 1

pageable.sortArray of strings

timezonestring

Default "UTC"

date-formatstring

Format will be applied for date values. Default value is "dd/MM/yyyy HH:mm"

Default "yyyyMMddHHmmss"

Body

required

groupIdstring(uuid)

dpskPoolIdstring

propertyIdstring

keywordstring

idsArray of strings(uuid)

ethernetPortobject(EthernetPort)

Ethernet port

filterobject

{
  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  "dpskPoolId": "string",
  "propertyId": "string",
  "keyword": "string",
  "ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "ethernetPort": {
    "macAddress": "string",
    "portIndex": 0,
    "name": "string"
  },
  "filter": {
    "property1": {},
    "property2": {}
  }
}

Responses

The identity csv

Bodytext/csv

Delete the IdentityDeprecated

Request

Path

groupIdstring(uuid)required

Group id

idstring(uuid)required

Identity id

No request payload

Responses

Identity get deleted

Body

object

Response

{}

Update the IdentityDeprecated

Request

Path

groupIdstring(uuid)required

Group id

idstring(uuid)required

Identity id

Body

required

descriptionstring<= 255 characters

The description for the identity.

namestring<= 255 charactersrequired

The name for the identity.

emailstring^[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=?`{...

The email for the identity.

Example: "john.doe@example.com"

dpskPassphrasestring

The passphrase associated with the identity. If this field is set to null in an update request, the passphrase will be reset. Note: if a passphrase is provided but is shorter than the required minimum length, it will also be reset.

revokedboolean

The field to determine if identity is revoked.

vlaninteger(int32)[ 1 .. 4094 ]

The VLAN for the identity.

devicesArray of objects(Device)

The list of devices for the identity.

ethernetPortsArray of objects(EthernetPort)

The list of ethernet port for the identity.

meteringProfileIdstring(uuid)

The identifier of the metering profile.

expirationDatestring(date-time)

The expiration date for the metering profile of this identity.

phoneNumberstring

The phone number for the identity.

primaryboolean

_linksobject(Links)

{
  "description": "string",
  "name": "string",
  "email": "john.doe@example.com",
  "dpskPassphrase": "string",
  "revoked": true,
  "vlan": 1,
  "devices": [
    { … }
  ],
  "ethernetPorts": [
    { … }
  ],
  "meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
  "expirationDate": "2019-08-24T14:15:22Z",
  "phoneNumber": "string",
  "primary": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Identity updated

Body

idstring(uuid)read-only

The identifier for the identity.

groupIdstring(uuid)read-only

The identifier of the group for the identity.

parentIdstring(uuid)read-only

The identifier of the parent identity.

descriptionstring<= 255 characters

The description for the identity.

namestring<= 255 charactersrequired

The name for the identity.

emailstring^[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=?`{...

The email for the identity.

Example: "john.doe@example.com"

dpskGuidstringread-only

The identifier of the DPSK for the identity.

dpskPassphrasestring

The passphrase associated with the identity. If this field is set to null in an update request, the passphrase will be reset. Note: if a passphrase is provided but is shorter than the required minimum length, it will also be reset.

identityIdstringread-only

The identifier of entity that associated with identity.

revokedboolean

The field to determine if identity is revoked.

vlaninteger(int32)[ 1 .. 4094 ]

The VLAN for the identity.

vniinteger(int32)[ 0 .. 8388608 ]read-only

The VNI for the identity.

createdAtstring(date-time)read-only

The timestamp that the identity get created.

updatedAtstring(date-time)read-only

The timestamp that the identity get last updated.

devicesArray of objects(Device)

The list of devices for the identity.

deviceCountinteger(int32)read-only

The count of devices belongs to the identity.

ethernetPortsArray of objects(EthernetPort)

The list of ethernet port for the identity.

switchesArray of objects(Switch)read-only

The list of switch for the identity.

meteringProfileIdstring(uuid)

The identifier of the metering profile.

expirationDatestring(date-time)

The expiration date for the metering profile of this identity.

phoneNumberstring

The phone number for the identity.

externalIdentityIdstring(uuid)read-only

The identifier of the external identity for the identity.

lastLoginAtstring(date-time)read-only

The latest timestamp that the identity login.

primaryboolean

_linksobject(Links)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  "description": "string",
  "name": "string",
  "email": "john.doe@example.com",
  "dpskGuid": "string",
  "dpskPassphrase": "string",
  "identityId": "string",
  "revoked": true,
  "vlan": 1,
  "vni": 8388608,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "devices": [
    { … }
  ],
  "deviceCount": 0,
  "ethernetPorts": [
    { … }
  ],
  "switches": [
    { … }
  ],
  "meteringProfileId": "21690ab6-38e0-48f8-adfb-86310194769f",
  "expirationDate": "2019-08-24T14:15:22Z",
  "phoneNumber": "string",
  "externalIdentityId": "a01e4ba2-4fa9-437d-852d-542fdee5487f",
  "lastLoginAt": "2019-08-24T14:15:22Z",
  "primary": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete the Ethernet Port from the IdentityDeprecated

Request

Path

groupIdstring(uuid)required

Group id

idstring(uuid)required

Identity id

macAddressstringrequired

Ethernet Port's MAC

portIndexinteger(int32)required

Ethernet Port's port index

No request payload

Responses

Ethernet Port deleted

Body

object

Response

{}

Delete the Device from the IdentityDeprecated

Request

Path

groupIdstring(uuid)required

Group id

idstring(uuid)required

Identity id

macAddressstringrequired

Device's MAC

No request payload

Responses

Device deleted

Body

object

Response

{}

Identity Management (v0)

Identity Group

Identity

Create an Identity Into a Specific GroupDeprecated

RequestExpand all

Responses

Delete the Specific Identities in a GroupDeprecated

Request

Responses

Create Devices Into the IdentityDeprecated

Request

Responses

Import Identities Into the Specified Identity GroupDeprecated

Request

Responses

Export the Identities Into a CSV FileDeprecated

RequestExpand all

Responses

Delete the IdentityDeprecated

Request

Responses

Update the IdentityDeprecated

RequestExpand all

Responses

Delete the Ethernet Port from the IdentityDeprecated

Request

Responses

Delete the Device from the IdentityDeprecated

Request

Responses

Request

Request

Request