Search for MAC Registrations with the Specified Criteria

Registration Pool

Operations

MAC Registration

Operations

Search for MAC Registrations with the Specified Criteria

Request

Path

poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Query

pageinteger>= 0

Zero-based page index (0..N)

Default 0

sizeinteger>= 1

The size of the page to be returned

Default 20

sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Body

required

searchCriteriaListArray of objects(SearchCriteria)

dataOptionstring

Example: "ALL"

{
  "searchCriteriaList": [
    { … }
  ],
  "dataOption": "ALL"
}

Responses

Registrations

Body

totalPagesinteger(int32)

totalElementsinteger(int64)

sizeinteger(int32)

contentArray of objects(Registration)

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": { … },
    "pageSize": 0,
    "pageNumber": 0,
    "unpaged": true,
    "paged": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Import MAC Registrations with the Specified Registration Pool

Request

Path

poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Bodymultipart/form-data

filestring(binary)required

multipart/form-data

{
  "file": "string"
}

Responses

Registration pools created

Body

Array [

idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

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

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

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

The email to associate with this device.

Example: "dev@commscope.com"

locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)

]

Response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "expirationDate": "2019-08-24T14:15:22Z",
    "revoked": true,
    "macAddress": "string",
    "username": "string",
    "email": "dev@commscope.com",
    "location": "string",
    "deviceName": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "isReferenced": true,
    "_links": { … }
  }
]

MAC Registrations in the Specified Registration Pool

Request

Path

poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Query

pageinteger>= 0

Zero-based page index (0..N)

Default 0

sizeinteger>= 1

The size of the page to be returned

Default 20

sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

No request payload

Responses

Registrations

Body

totalPagesinteger(int32)

totalElementsinteger(int64)

sizeinteger(int32)

contentArray of objects(Registration)

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": { … },
    "pageSize": 0,
    "pageNumber": 0,
    "unpaged": true,
    "paged": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Create a MAC Registration in the Specified Registration Pool

Request

Path

poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Body

required

idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

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

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

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

The email to associate with this device.

Example: "dev@commscope.com"

locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Registration pool created

Body

idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

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

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

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

The email to associate with this device.

Example: "dev@commscope.com"

locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete the Specific MAC Registrations

Request

Path

poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Body

requiredArray [

string(uuid)

]

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

Responses

Registration deleted

Body

Response

null

Returns the Specific MAC Registration

Request

Path

idstring(uuid)required

MAC registration id

Example: 28529868-9db0-4361-ba20-4d35fb402bc2

poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

No request payload

Responses

MAC registration

Body

idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

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

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

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

The email to associate with this device.

Example: "dev@commscope.com"

locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete the Specific MAC Registration

Request

Path

idstring(uuid)required

MAC registration id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

No request payload

Responses

Registration deleted

Body

idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

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

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

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

The email to associate with this device.

Example: "dev@commscope.com"

locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Update Properties in the Specific MAC Registration

Request

Path

idstring(uuid)required

MAC registration id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27

Body

required

idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

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

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

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

The email to associate with this device.

Example: "dev@commscope.com"

locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

MAC registration updated

Body

idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

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

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

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

The email to associate with this device.

Example: "dev@commscope.com"

locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Assign Identity Group

Operations

Wifi Network

Operations

MAC Registration API (0.0.1)

Registration Pool

MAC Registration

Search for MAC Registrations with the Specified Criteria

RequestExpand all

Responses

Import MAC Registrations with the Specified Registration Pool

Request

Responses

MAC Registrations in the Specified Registration Pool

Request

Responses

Create a MAC Registration in the Specified Registration Pool

RequestExpand all

Responses

Delete the Specific MAC Registrations

Request

Responses

Returns the Specific MAC Registration

Request

Responses

Delete the Specific MAC Registration

Request

Responses

Update Properties in the Specific MAC Registration

RequestExpand all

Responses

Assign Identity Group

Wifi Network

Request

Request

Request