Delete the Identity Group

Identity Group

Operations

Create an Identity GroupDeprecated

Request

Body

required

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.

policySetIdstring

The identifier of the policy set associated with the group.

networkCountinteger(int32)

The number of the networks associated with the group.

_linksobject(Links)

{
  "name": "string",
  "description": "string",
  "dpskPoolId": "string",
  "macRegistrationPoolId": "string",
  "policySetId": "string",
  "networkCount": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Group created

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
}