Returns the Identity

Identity Group

Operations

Identity

Operations

Update Ethernet Ports for the Identity

Request

Path

groupIdstring(uuid)required

Group id

venueIdstringrequired

Venue id

idstring(uuid)required

Identity id

Body

requiredArray [

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

The MAC address for the ethernet port.

portIndexinteger(int32)required

The index of the port of the ethernet port.

namestring<= 255 charactersrequired

The name for the ethernet port.

]

[
  {
    "macAddress": "string",
    "portIndex": 0,
    "name": "string"
  }
]

Responses

Request accepted

Body

requestIdstring

idstring

Response

{
  "requestId": "string",
  "id": "string"
}

Returns the Identities in a Specific Group

Request

Path

groupIdstring(uuid)required

Group id

Query

pageableobject(Pageable)required

Parameters for paging

pageable.pageinteger(int32)>= 0

pageable.sizeinteger(int32)>= 1

pageable.sortArray of strings

No request payload

Responses

Identities returned

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": { … }
  }
]

Query Identities

Request

Query

pageableobject(Pageable)required

Parameters for paging

pageable.pageinteger(int32)>= 0

pageable.sizeinteger(int32)>= 1

pageable.sortArray of strings

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

Identities found

Body

totalPagesinteger(int32)

totalElementsinteger(int64)

sizeinteger(int32)

contentArray of objects(Identity)

numberinteger(int32)

sortobject(SortObject)

numberOfElementsinteger(int32)

pageableobject(PageableObject)

firstboolean

lastboolean

emptyboolean

Response

{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    { … }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "sort": { … },
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "unpaged": true
  },
  "first": true,
  "last": true,
  "empty": true
}