Skip to content

Identity Management (v0)

Download OpenAPI description
Download PDF
Languages
Servers
Generated server url

http://localhost:8080/

Identity Group

Operations

Update the Policy Set Association for Identity Group

Request

Path
idstring(uuid)required

Group id

policySetIdstringrequired

Policy set id

No request payload

Responses

Request accepted

Body
requestIdstring
idstring
Response
{
  "requestId": "string",
  "id": "string"
}

Remove the Policy Set Association for Identity Group

Request

Path
idstring(uuid)required

Group id

policySetIdstringrequired

Policy set id

No request payload

Responses

Request accepted

Body
requestIdstring
idstring
Response
{
  "requestId": "string",
  "id": "string"
}

Update the MAC Registration Association for Identity Group

Request

Path
idstring(uuid)required

Group id

poolIdstringrequired

MAC registration pool id

No request payload

Responses

Request accepted

Body
requestIdstring
idstring
Response
{
  "requestId": "string",
  "id": "string"
}

Update the DPSK Pool Association for Identity Group

Request

Path
idstring(uuid)required

Group id

dpskPoolIdstringrequired

DPSK pool id

No request payload

Responses

Request accepted

Body
requestIdstring
idstring
Response
{
  "requestId": "string",
  "id": "string"
}

Returns the Identity Groups

Request

Query
pageableobject(Pageable)required

Parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
No request payload

Responses

The Identity Groups

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

Query the Identity Groups

Request

Query
pageableobject(Pageable)required

Parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
Body
required
personalIdentityNetworkIdstring
macRegistrationPoolIdstring
dpskPoolIdstring
keywordstring
groupIdsArray of strings(uuid)
propertyIdstring
certificateTemplateIdstring
policySetIdstring
networkIdstring
{
  "personalIdentityNetworkId": "string",
  "macRegistrationPoolId": "string",
  "dpskPoolId": "string",
  "keyword": "string",
  "groupIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "propertyId": "string",
  "certificateTemplateId": "string",
  "policySetId": "string",
  "networkId": "string"
}

Responses

The Identity Groups

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

Export the Identity Groups Into a CSV File

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
personalIdentityNetworkIdstring
macRegistrationPoolIdstring
dpskPoolIdstring
keywordstring
groupIdsArray of strings(uuid)
propertyIdstring
certificateTemplateIdstring
policySetIdstring
networkIdstring
{
  "personalIdentityNetworkId": "string",
  "macRegistrationPoolId": "string",
  "dpskPoolId": "string",
  "keyword": "string",
  "groupIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "propertyId": "string",
  "certificateTemplateId": "string",
  "policySetId": "string",
  "networkId": "string"
}

Responses

The CSV returned

Bodytext/csv

Returns the Specific Identity Group

Request

Path
idstring(uuid)required

Group id

No request payload

Responses

Group found

Body
idstring(uuid)read-only

The identifier for the group.

namestring<= 255 charactersrequired

The name for the group.

descriptionstring<= 255 characters

The description for the group.

dpskPoolIdstring

The identifier of the DPSK pool associated with the group.

macRegistrationPoolIdstring

The identifier of the MAC registration pool associated with the group.

propertyIdstringread-only

Then identifier of the property associated with the group.

createdAtstring(date-time)read-only

The timestamp that the group get created.

updatedAtstring(date-time)read-only

The timestamp that the group get last update.

certificateTemplateIdstringread-only

Then identifier of the certificate template associated with the group.

policySetIdstring

The identifier of the policy set associated with the group.

networkCountinteger(int32)

The number of the networks associated with the group.

templateVersioninteger(int64)read-only
_linksobject(Links)
personalIdentityNetworkIdstringread-only

The identifier of the personal identity network associated with the group.

identityCountinteger(int64)read-only

The number of identities belongs to the group.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "dpskPoolId": "string",
  "macRegistrationPoolId": "string",
  "propertyId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "certificateTemplateId": "string",
  "policySetId": "string",
  "networkCount": 0,
  "templateVersion": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  },
  "personalIdentityNetworkId": "string",
  "identityCount": 0
}

Identity

Operations

External Identity

Operations