Skip to content

MAC Registration API (0.0.1)

Download OpenAPI description
Download PDF
Languages
Servers
Generated server url
http://localhost:8080/

Registration Pool

Operations

Update Policy Set for a Registration Pool

Request

Path
idstring(uuid)required

Registration pool id

policySetIdstringrequired

Policy set id

No request payload

Responses

The update request has been accepted and is in progress

Body
requestIdstringrequired
idstring

Only present for the create operation.

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

Delete Policy Set from a Registration Pool

Request

Path
idstring(uuid)required

Registration pool id

policySetIdstringrequired

Policy set id

No request payload

Responses

The remove request has been accepted and is in progress

Body
requestIdstringrequired
idstring

Only present for the create operation.

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

Search for Registration Pools with the Specified Criteria

Request

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(Pool)
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
}

Registration Pools That Contain MAC Registrations

Request

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

Registration pools

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
sizeinteger(int32)
contentArray of objects(Pool)
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 Registration Pool

Request

Body
required
idstring(uuid)

The unique identifier for this pool.

namestring[ 0 .. 255 ] charactersrequired

The unique reference name of the pool.

descriptionstring[ 0 .. 255 ] characters

A description of the pool.

autoCleanupboolean

A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.

Default true
expirationTypestring

Defines the rule for expiration date calculation.

Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
expirationOffsetinteger(int32)

If the expiration type is not specified_date then this field is the offset amount.

expirationDatestring(date-time)

If the expiration type is specified_date then this field is the related date.

ssidRegexstring[ 0 .. 255 ] characters

A regex to determine which SSIDs this registration pool will allows access to.

expirationEnabledboolean

If the expiration setting is enabled for new MAC registration.

Default false
registrationCountinteger(int32)

Number of registrations in the pool.

defaultAccessstring

The type of default access.

Default "ACCEPT"
Enum"ACCEPT""REJECT"
createdDatestring(date-time)

The created date of this pool.

policySetIdstring

The policy set of this pool.

isReferencedboolean

This pool is referenced by an identity group and cannot be deleted.

networkCountinteger(int32)

Number of networks associated with this pool.

identityGroupIdstring

The identity group of this pool.

identityIdstring

The single identity policy of this pool.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "autoCleanup": true,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "ssidRegex": "string",
  "expirationEnabled": false,
  "registrationCount": 0,
  "defaultAccess": "ACCEPT",
  "createdDate": "2019-08-24T14:15:22Z",
  "policySetId": "string",
  "isReferenced": true,
  "networkCount": 0,
  "identityGroupId": "string",
  "identityId": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Registration pool created

Body
idstring(uuid)

The unique identifier for this pool.

namestring[ 0 .. 255 ] charactersrequired

The unique reference name of the pool.

descriptionstring[ 0 .. 255 ] characters

A description of the pool.

autoCleanupboolean

A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.

Default true
expirationTypestring

Defines the rule for expiration date calculation.

Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
expirationOffsetinteger(int32)

If the expiration type is not specified_date then this field is the offset amount.

expirationDatestring(date-time)

If the expiration type is specified_date then this field is the related date.

ssidRegexstring[ 0 .. 255 ] characters

A regex to determine which SSIDs this registration pool will allows access to.

expirationEnabledboolean

If the expiration setting is enabled for new MAC registration.

Default false
registrationCountinteger(int32)

Number of registrations in the pool.

defaultAccessstring

The type of default access.

Default "ACCEPT"
Enum"ACCEPT""REJECT"
createdDatestring(date-time)

The created date of this pool.

policySetIdstring

The policy set of this pool.

isReferencedboolean

This pool is referenced by an identity group and cannot be deleted.

networkCountinteger(int32)

Number of networks associated with this pool.

identityGroupIdstring

The identity group of this pool.

identityIdstring

The single identity policy of this pool.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "autoCleanup": true,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "ssidRegex": "string",
  "expirationEnabled": false,
  "registrationCount": 0,
  "defaultAccess": "ACCEPT",
  "createdDate": "2019-08-24T14:15:22Z",
  "policySetId": "string",
  "isReferenced": true,
  "networkCount": 0,
  "identityGroupId": "string",
  "identityId": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Returns the Specific Registration Pool Containing MAC Registrations

Request

Path
idstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
No request payload

Responses

Registration pool

Body
idstring(uuid)

The unique identifier for this pool.

namestring[ 0 .. 255 ] charactersrequired

The unique reference name of the pool.

descriptionstring[ 0 .. 255 ] characters

A description of the pool.

autoCleanupboolean

A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.

Default true
expirationTypestring

Defines the rule for expiration date calculation.

Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
expirationOffsetinteger(int32)

If the expiration type is not specified_date then this field is the offset amount.

expirationDatestring(date-time)

If the expiration type is specified_date then this field is the related date.

ssidRegexstring[ 0 .. 255 ] characters

A regex to determine which SSIDs this registration pool will allows access to.

expirationEnabledboolean

If the expiration setting is enabled for new MAC registration.

Default false
registrationCountinteger(int32)

Number of registrations in the pool.

defaultAccessstring

The type of default access.

Default "ACCEPT"
Enum"ACCEPT""REJECT"
createdDatestring(date-time)

The created date of this pool.

policySetIdstring

The policy set of this pool.

isReferencedboolean

This pool is referenced by an identity group and cannot be deleted.

networkCountinteger(int32)

Number of networks associated with this pool.

identityGroupIdstring

The identity group of this pool.

identityIdstring

The single identity policy of this pool.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "autoCleanup": true,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "ssidRegex": "string",
  "expirationEnabled": false,
  "registrationCount": 0,
  "defaultAccess": "ACCEPT",
  "createdDate": "2019-08-24T14:15:22Z",
  "policySetId": "string",
  "isReferenced": true,
  "networkCount": 0,
  "identityGroupId": "string",
  "identityId": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete the Specific Registration Pool

Request

Path
idstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
No request payload

Responses

Registration pool deleted

Body
Response
null

Update Properties in the Specific Registration Pool

Request

Path
idstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
Body
required
idstring(uuid)

The unique identifier for this pool.

namestring[ 0 .. 255 ] charactersrequired

The unique reference name of the pool.

descriptionstring[ 0 .. 255 ] characters

A description of the pool.

autoCleanupboolean

A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.

Default true
expirationTypestring

Defines the rule for expiration date calculation.

Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
expirationOffsetinteger(int32)

If the expiration type is not specified_date then this field is the offset amount.

expirationDatestring(date-time)

If the expiration type is specified_date then this field is the related date.

ssidRegexstring[ 0 .. 255 ] characters

A regex to determine which SSIDs this registration pool will allows access to.

expirationEnabledboolean

If the expiration setting is enabled for new MAC registration.

Default false
registrationCountinteger(int32)

Number of registrations in the pool.

defaultAccessstring

The type of default access.

Default "ACCEPT"
Enum"ACCEPT""REJECT"
createdDatestring(date-time)

The created date of this pool.

policySetIdstring

The policy set of this pool.

isReferencedboolean

This pool is referenced by an identity group and cannot be deleted.

networkCountinteger(int32)

Number of networks associated with this pool.

identityGroupIdstring

The identity group of this pool.

identityIdstring

The single identity policy of this pool.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "autoCleanup": true,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "ssidRegex": "string",
  "expirationEnabled": false,
  "registrationCount": 0,
  "defaultAccess": "ACCEPT",
  "createdDate": "2019-08-24T14:15:22Z",
  "policySetId": "string",
  "isReferenced": true,
  "networkCount": 0,
  "identityGroupId": "string",
  "identityId": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Registration pool updated

Body
idstring(uuid)

The unique identifier for this pool.

namestring[ 0 .. 255 ] charactersrequired

The unique reference name of the pool.

descriptionstring[ 0 .. 255 ] characters

A description of the pool.

autoCleanupboolean

A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.

Default true
expirationTypestring

Defines the rule for expiration date calculation.

Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
expirationOffsetinteger(int32)

If the expiration type is not specified_date then this field is the offset amount.

expirationDatestring(date-time)

If the expiration type is specified_date then this field is the related date.

ssidRegexstring[ 0 .. 255 ] characters

A regex to determine which SSIDs this registration pool will allows access to.

expirationEnabledboolean

If the expiration setting is enabled for new MAC registration.

Default false
registrationCountinteger(int32)

Number of registrations in the pool.

defaultAccessstring

The type of default access.

Default "ACCEPT"
Enum"ACCEPT""REJECT"
createdDatestring(date-time)

The created date of this pool.

policySetIdstring

The policy set of this pool.

isReferencedboolean

This pool is referenced by an identity group and cannot be deleted.

networkCountinteger(int32)

Number of networks associated with this pool.

identityGroupIdstring

The identity group of this pool.

identityIdstring

The single identity policy of this pool.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "autoCleanup": true,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "ssidRegex": "string",
  "expirationEnabled": false,
  "registrationCount": 0,
  "defaultAccess": "ACCEPT",
  "createdDate": "2019-08-24T14:15:22Z",
  "policySetId": "string",
  "isReferenced": true,
  "networkCount": 0,
  "identityGroupId": "string",
  "identityId": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

MAC Registration

Operations

Assign Identity Group

Operations

Wifi Network

Operations