Skip to content
/
Create an Identity Group

Identity Management (UNKNOWN)

Overview

The Identity Management REST APIs and Model, allow the creation, deletion, and modification of identity groups, and identities.

What This API Does

  • Create, modify, and delete identities groups and identities
  • Manage devices under identities

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 409 Conflict: Resource conflict (e.g., duplicate names)
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud/
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud/
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud/

Identity Group

Operations

Create an Identity GroupDeprecated

Request

This method will be removed no sooner than 6/30/2026 and application/json is currently tied to application/vnd.ruckus.v1+json which will be moved to application/vnd.ruckus.v1.1+json on 6/30/2026.

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.

autoCleanupEnabledboolean

Whether auto cleanup is enabled for the group.

Default false
_linksobject(Links)
{
  "name": "string",
  "description": "string",
  "dpskPoolId": "string",
  "macRegistrationPoolId": "string",
  "policySetId": "string",
  "networkCount": 0,
  "autoCleanupEnabled": false,
  "_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.

autoCleanupEnabledboolean

Whether auto cleanup is enabled for the group.

Default false
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,
  "autoCleanupEnabled": false,
  "templateVersion": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  },
  "personalIdentityNetworkId": "string",
  "identityCount": 0
}

Delete the Identity GroupDeprecated

Request

This method will be removed no sooner than 6/30/2026 and application/json is currently tied to application/vnd.ruckus.v1+json which will be moved to application/vnd.ruckus.v1.1+json on 6/30/2026.

Path
idstring(uuid)required

Group id

No request payload

Responses

Group deleted

Body
object
Response
{}

Update the Identity GroupDeprecated

Request

This method will be removed no sooner than 6/30/2026 and application/json is currently tied to application/vnd.ruckus.v1+json which will be moved to application/vnd.ruckus.v1.1+json on 6/30/2026.

Path
idstring(uuid)required

Group id

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.

autoCleanupEnabledboolean

Whether auto cleanup is enabled for the group.

Default false
_linksobject(Links)
{
  "name": "string",
  "description": "string",
  "dpskPoolId": "string",
  "macRegistrationPoolId": "string",
  "policySetId": "string",
  "networkCount": 0,
  "autoCleanupEnabled": false,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Group updated

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.

autoCleanupEnabledboolean

Whether auto cleanup is enabled for the group.

Default false
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,
  "autoCleanupEnabled": false,
  "templateVersion": 0,
  "_links": {
    "property1": { … },
    "property2": { … }
  },
  "personalIdentityNetworkId": "string",
  "identityCount": 0
}

Identity

Operations