Skip to content
Overview/
/Admin Enrollments/
Changed
Last updated

Admin Enrollments

POST /enrollments/query
Request:
  • Changed content type : application/json

  • Changed property sortDirection (object)

    Sort direction for ordering query results in ascending or descending order.

  • Changed property sortFields (object)

    List of field names used to sort the enrollment query results.

  • Changed property status (object)

    Enrollment status.

    Added enum value:

    • CREATED Removed enum value:

    • IN_PROGRESS

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property sortDirection (object)

    Sort direction for ordering query results in ascending or descending order.

  • Changed property sortFields (object)

    List of field names used to sort the enrollment query results.

  • Changed property status (object)

    Enrollment status.

    Added enum value:

    • CREATED Removed enum value:

    • IN_PROGRESS

Return Type:
  • Changed response : 400 Bad Request

Invalid query data supplied.

  • Changed content type : application/json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed response : 200 OK

ok

  • Changed content type : application/json

    • Changed property content (object)

      List of enrollment items on the current page.

    • Changed property empty (object)

      Indicates whether the current page contains any elements.

    • Changed property first (object)

      Indicates whether this is the first page in the paginated result set.

    • Changed property last (object)

      Indicates whether this is the last page in the paginated result set.

    • Changed property number (object)

      Current page number (zero indexed).

    • Changed property numberOfElements (object)

      Number of elements on the current page.

    • Changed property totalElements (object)

      Total number of enrollment elements across all pages.

    • Changed property totalPages (object)

      Total number of pages available in the paginated result set.

    • Changed property pageable (object)

      Pagination information object containing page number, size, and sort details.

      • Changed property pageNumber (object)

        Current page number (zero indexed).

      • Changed property pageSize (object)

        Number of elements per page.

      • Changed property paged (object)

        Indicates whether pagination is enabled for this request.

      • Changed property unpaged (object)

        Indicates whether pagination is disabled for this request.

    • Changed property sort (object)

      Sorting information object containing sort order and field details.

      • Changed property empty (object)

        Indicates whether any sort criteria are specified.

      • Changed property sorted (object)

        Indicates whether the results are sorted.

      • Changed property unsorted (object)

        Indicates whether the results are not sorted.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property content (object)

      List of enrollment items on the current page.

    • Changed property empty (object)

      Indicates whether the current page contains any elements.

    • Changed property first (object)

      Indicates whether this is the first page in the paginated result set.

    • Changed property last (object)

      Indicates whether this is the last page in the paginated result set.

    • Changed property number (object)

      Current page number (zero indexed).

    • Changed property numberOfElements (object)

      Number of elements on the current page.

    • Changed property totalElements (object)

      Total number of enrollment elements across all pages.

    • Changed property totalPages (object)

      Total number of pages available in the paginated result set.

    • Changed property pageable (object)

      Pagination information object containing page number, size, and sort details.

      • Changed property pageNumber (object)

        Current page number (zero indexed).

      • Changed property pageSize (object)

        Number of elements per page.

      • Changed property paged (object)

        Indicates whether pagination is enabled for this request.

      • Changed property unpaged (object)

        Indicates whether pagination is disabled for this request.

    • Changed property sort (object)

      Sorting information object containing sort order and field details.

      • Changed property empty (object)

        Indicates whether any sort criteria are specified.

      • Changed property sorted (object)

        Indicates whether the results are sorted.

      • Changed property unsorted (object)

        Indicates whether the results are not sorted.

POST /enrollments/registrations/query
Request:
  • Changed content type : application/json

  • Changed property sortDirection (object)

    Sort direction for ordering query results in ascending or descending order.

  • Changed property sortFields (object)

    List of field names used to sort the enrollment query results.

  • Changed property status (object)

    Enrollment status.

    Added enum value:

    • CREATED Removed enum value:

    • IN_PROGRESS

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property sortDirection (object)

    Sort direction for ordering query results in ascending or descending order.

  • Changed property sortFields (object)

    List of field names used to sort the enrollment query results.

  • Changed property status (object)

    Enrollment status.

    Added enum value:

    • CREATED Removed enum value:

    • IN_PROGRESS

Return Type:
  • Changed response : 400 Bad Request

Invalid query data supplied.

  • Changed content type : application/json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed response : 200 OK

ok

  • Changed content type : application/json

    • Changed property content (object)

      List of enrollment registration items on the current page.

    • Changed property empty (object)

      Indicates whether the current page contains any elements.

    • Changed property first (object)

      Indicates whether this is the first page in the paginated result set.

    • Changed property last (object)

      Indicates whether this is the last page in the paginated result set.

    • Changed property number (object)

      Current page number (zero indexed).

    • Changed property numberOfElements (object)

      Number of elements on the current page.

    • Changed property totalElements (object)

      Total number of enrollment registration elements across all pages.

    • Changed property totalPages (object)

      Total number of pages available in the paginated result set.

    • Changed property pageable (object)

      Pagination information object containing page number, size, and sort details.

      • Changed property pageNumber (object)

        Current page number (zero indexed).

      • Changed property pageSize (object)

        Number of elements per page.

      • Changed property paged (object)

        Indicates whether pagination is enabled for this request.

      • Changed property unpaged (object)

        Indicates whether pagination is disabled for this request.

    • Changed property sort (object)

      Sorting information object containing sort order and field details.

      • Changed property empty (object)

        Indicates whether any sort criteria are specified.

      • Changed property sorted (object)

        Indicates whether the results are sorted.

      • Changed property unsorted (object)

        Indicates whether the results are not sorted.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property content (object)

      List of enrollment registration items on the current page.

    • Changed property empty (object)

      Indicates whether the current page contains any elements.

    • Changed property first (object)

      Indicates whether this is the first page in the paginated result set.

    • Changed property last (object)

      Indicates whether this is the last page in the paginated result set.

    • Changed property number (object)

      Current page number (zero indexed).

    • Changed property numberOfElements (object)

      Number of elements on the current page.

    • Changed property totalElements (object)

      Total number of enrollment registration elements across all pages.

    • Changed property totalPages (object)

      Total number of pages available in the paginated result set.

    • Changed property pageable (object)

      Pagination information object containing page number, size, and sort details.

      • Changed property pageNumber (object)

        Current page number (zero indexed).

      • Changed property pageSize (object)

        Number of elements per page.

      • Changed property paged (object)

        Indicates whether pagination is enabled for this request.

      • Changed property unpaged (object)

        Indicates whether pagination is disabled for this request.

    • Changed property sort (object)

      Sorting information object containing sort order and field details.

      • Changed property empty (object)

        Indicates whether any sort criteria are specified.

      • Changed property sorted (object)

        Indicates whether the results are sorted.

      • Changed property unsorted (object)

        Indicates whether the results are not sorted.

GET /enrollments/registrations/{enrollmentRegistrationId}

Get Registration Details

Parameters:
  • Changed: enrollmentRegistrationId in path

Enrollment Registration Id

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed response : 200 OK

Ok

  • Changed content type : application/json

    • Changed property macAddress (object)

      MAC address of the device associated with this enrollment registration.

    • Changed property status (object)

      Enrollment Status.

      Added enum value:

      • CREATED Removed enum value:

      • IN_PROGRESS

    • Changed property authentication (object)

      Authentication information for enrollment, including service type, identity, group, and network details.

      • Changed property authType (object)

        Type of authentication service used for enrollment, such as directory services or federation protocols.

        Removed enum values:

        • DPSK
        • MAC_REG

      • Changed property groupId (object)

        Identifier of the identity group to which the enrolled entity belongs.

      • Changed property identity (object)

        Identity identifier of the user or device being enrolled.

      • Changed property networkId (object)

        Network identifier where the enrollment is being performed.

    • Changed property revocation (object)

      Revocation information including the date and time when enrollment was revoked, the reason for revocation, and who performed the revocation.

      • Changed property revokedBy (object)

        Identifier of the user or system that revoked the enrollment.

      • Changed property revokedDate (object)

        Date and time when the enrollment was revoked.

      • Changed property revokedReason (object)

        Reason provided for revoking the enrollment.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property macAddress (object)

      MAC address of the device associated with this enrollment registration.

    • Changed property status (object)

      Enrollment Status.

      Added enum value:

      • CREATED Removed enum value:

      • IN_PROGRESS

    • Changed property authentication (object)

      Authentication information for enrollment, including service type, identity, group, and network details.

      • Changed property authType (object)

        Type of authentication service used for enrollment, such as directory services or federation protocols.

        Removed enum values:

        • DPSK
        • MAC_REG

      • Changed property groupId (object)

        Identifier of the identity group to which the enrolled entity belongs.

      • Changed property identity (object)

        Identity identifier of the user or device being enrolled.

      • Changed property networkId (object)

        Network identifier where the enrollment is being performed.

    • Changed property revocation (object)

      Revocation information including the date and time when enrollment was revoked, the reason for revocation, and who performed the revocation.

      • Changed property revokedBy (object)

        Identifier of the user or system that revoked the enrollment.

      • Changed property revokedDate (object)

        Date and time when the enrollment was revoked.

      • Changed property revokedReason (object)

        Reason provided for revoking the enrollment.

GET /enrollments/{enrollmentId}

Get Enrollment Details

Parameters:
  • Changed: enrollmentId in path

Enrollment Id

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property errors (object)

      List of nested error details providing specific error information.

    • Added property requestId (object)

      Request identifier for tracking and debugging purposes.

    • Deleted property validationErrors (object)

    • Changed property detailedMessage (object)

      Detailed error message providing additional context about the error.

  • Changed response : 200 OK

Ok

  • Changed content type : application/json

    • Changed property status (object)

      Enrollment status.

      Added enum value:

      • CREATED Removed enum value:

      • IN_PROGRESS

    • Changed property userAgentName (object)

      Name of the user agent that initiated the enrollment process.

    • Changed property variables (object)

      List of enrollment variables containing key and value pairs for enrollment configuration.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property status (object)

      Enrollment status.

      Added enum value:

      • CREATED Removed enum value:

      • IN_PROGRESS

    • Changed property userAgentName (object)

      Name of the user agent that initiated the enrollment process.

    • Changed property variables (object)

      List of enrollment variables containing key and value pairs for enrollment configuration.

Previous page
Next page