Skip to content
Overview/
/Workflow Actions/
Changed
Last updated

Workflow Actions

POST /enrollmentActions/files
Request:
  • Changed content type : multipart/form-data

  • Changed property fileDetails (object)

    Request payload for uploading enrollment action files.

    • Changed property type (object)

      File type.

      Added enum value:

      • USER_SPLIT_OPTION_FILE
  • Changed content type : multipart/vnd.ruckus.v1+form-data

  • Changed property fileDetails (object)

    Request payload for uploading enrollment action files.

    • Changed property type (object)

      File type.

      Added enum value:

      • USER_SPLIT_OPTION_FILE
Return Type:
  • Changed response : 200 OK

Uploaded

  • Changed content type : */*

    • Changed property type (object)

      File type.

      Added enum value:

      • USER_SPLIT_OPTION_FILE

    • Changed property url (object)

      URL for accessing the uploaded file.

  • Changed response : 201 Created

Created

  • Changed content type : */*

    • Changed property type (object)

      File type.

      Added enum value:

      • USER_SPLIT_OPTION_FILE

    • Changed property url (object)

      URL for accessing the uploaded file.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

GET /enrollmentActions/files/{fileId}
Return Type:
  • Changed response : 200 OK

Ok

  • Changed content type : */*

    • Changed property url (object)

      Signed URL for downloading the enrollment action file.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 404 Not Found

Not found

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

DELETE /enrollmentActions/files/{fileId}
Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 404 Not Found

Not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

POST /enrollmentActions

Create Enrollment Action

Request:

Enrollment action configuration. The actionType field determines which specific action type to use. Valid actionType values: AUP, DATA_PROMPT, USER_SELECTION_SPLIT, DISPLAY_MESSAGE, DPSK, MAC_REG, USER_SELECTION_SPLIT_OPTION, PASSPHRASE.

  • Changed content type : application/json

New required properties:

  • actionType
  • name

  • Added property actionType (object)

    Type of enrollment action to be created or configured.

    Enum values:

    • AUP
    • DATA_PROMPT
    • DPSK
    • USER_SELECTION_SPLIT
    • USER_SELECTION_SPLIT_OPTION
    • FUNCTIONAL_SPLIT
    • FUNCTIONAL_SPLIT_OPTION
    • DISPLAY_MESSAGE
    • MAC_REG
    • CERT_TEMPLATE
    • IDP_AUTH_PROVIDER
    • LDAP_AUTH_PROVIDER
    • PASSPHRASE
    • CAPTIVE_PORTAL

  • Added property description (object)

    Action description.

  • Added property id (object)

    Action ID.

  • Added property name (object)

    Action name.

  • Added property parentActionId (object)

    ID of the parent action if this is a child action.

  • Added property version (object)

    Version.

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

New required properties:

  • actionType
  • name

  • Added property actionType (object)

    Type of enrollment action to be created or configured.

  • Added property description (object)

    Action description.

  • Added property id (object)

    Action ID.

  • Added property name (object)

    Action name.

  • Added property parentActionId (object)

    ID of the parent action if this is a child action.

  • Added property version (object)

    Version.

Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : */*

    • Changed property id (object)

      ID of the created or updated enrollment action.

    • Changed property requestId (object)

      Request ID for tracking the accepted request.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

GET /enrollmentActions

Get All Enrollment Actions

Parameters:
  • Changed: sort in query

The field names to sort with. Comma separated from the sort order (asc or desc). Allowed values are name, description, actionType and version.

Return Type:
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 200 OK

Ok

  • Changed content type : application/json

    • Changed property content (object)

      List of items for the current page.

    • Changed property empty (object)

      Indicates if the page contains no items.

    • Changed property first (object)

      Indicates if this is the first page.

    • Changed property last (object)

      Indicates if this is the last page.

    • Changed property number (object)

      Current page number starting from zero.

    • Changed property numberOfElements (object)

      Number of items in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Page request information for retrieving results in pages.

      • Changed property pageNumber (object)

        Current page number starting from zero.

      • Changed property pageSize (object)

        Number of items per page.

      • Changed property paged (object)

        Indicates if results are divided into pages.

      • Changed property unpaged (object)

        Indicates if results are not divided into pages.

    • Changed property sort (object)

      Sorting information for ordering the results.

      • Changed property empty (object)

        Indicates if no sorting is applied.

      • Changed property sorted (object)

        Indicates if results are sorted.

      • Changed property unsorted (object)

        Indicates if results are not sorted.

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

    • Changed property content (object)

      List of items for the current page.

    • Changed property empty (object)

      Indicates if the page contains no items.

    • Changed property first (object)

      Indicates if this is the first page.

    • Changed property last (object)

      Indicates if this is the last page.

    • Changed property number (object)

      Current page number starting from zero.

    • Changed property numberOfElements (object)

      Number of items in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Page request information for retrieving results in pages.

      • Changed property pageNumber (object)

        Current page number starting from zero.

      • Changed property pageSize (object)

        Number of items per page.

      • Changed property paged (object)

        Indicates if results are divided into pages.

      • Changed property unpaged (object)

        Indicates if results are not divided into pages.

    • Changed property sort (object)

      Sorting information for ordering the results.

      • Changed property empty (object)

        Indicates if no sorting is applied.

      • Changed property sorted (object)

        Indicates if results are sorted.

      • Changed property unsorted (object)

        Indicates if results are not sorted.

GET /enrollmentActions/actionTypes/{actionType}

Get Enrollment Actions by Type

Parameters:
  • Changed: sort in query

The field names to sort with. Comma separated from the sort order (asc or desc).

  • Changed: actionType in path

Action Type

Return Type:
  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 200 OK

Ok

  • Changed content type : application/json

    • Changed property content (object)

      List of items for the current page.

    • Changed property empty (object)

      Indicates if the page contains no items.

    • Changed property first (object)

      Indicates if this is the first page.

    • Changed property last (object)

      Indicates if this is the last page.

    • Changed property number (object)

      Current page number starting from zero.

    • Changed property numberOfElements (object)

      Number of items in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Page request information for retrieving results in pages.

      • Changed property pageNumber (object)

        Current page number starting from zero.

      • Changed property pageSize (object)

        Number of items per page.

      • Changed property paged (object)

        Indicates if results are divided into pages.

      • Changed property unpaged (object)

        Indicates if results are not divided into pages.

    • Changed property sort (object)

      Sorting information for ordering the results.

      • Changed property empty (object)

        Indicates if no sorting is applied.

      • Changed property sorted (object)

        Indicates if results are sorted.

      • Changed property unsorted (object)

        Indicates if results are not sorted.

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

    • Changed property content (object)

      List of items for the current page.

    • Changed property empty (object)

      Indicates if the page contains no items.

    • Changed property first (object)

      Indicates if this is the first page.

    • Changed property last (object)

      Indicates if this is the last page.

    • Changed property number (object)

      Current page number starting from zero.

    • Changed property numberOfElements (object)

      Number of items in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Page request information for retrieving results in pages.

      • Changed property pageNumber (object)

        Current page number starting from zero.

      • Changed property pageSize (object)

        Number of items per page.

      • Changed property paged (object)

        Indicates if results are divided into pages.

      • Changed property unpaged (object)

        Indicates if results are not divided into pages.

    • Changed property sort (object)

      Sorting information for ordering the results.

      • Changed property empty (object)

        Indicates if no sorting is applied.

      • Changed property sorted (object)

        Indicates if results are sorted.

      • Changed property unsorted (object)

        Indicates if results are not sorted.

POST /enrollmentActions/query

Query Enrollment Actions

Request:
  • Changed content type : application/json

  • Changed property actionType (object)

    Type of enrollment action to filter by.

    Added enum values:

    • FUNCTIONAL_SPLIT

    • FUNCTIONAL_SPLIT_OPTION Removed enum value:

    • AUTO_SELECTION_SPLIT

  • Changed property parentActionId (object)

    ID of the parent action for filtering.

  • Changed property sortDirection (object)

    Direction to sort results in ascending or descending order.

  • Changed property sortFields (object)

    List of field names to sort results by.

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

  • Changed property actionType (object)

    Type of enrollment action to filter by.

    Added enum values:

    • FUNCTIONAL_SPLIT

    • FUNCTIONAL_SPLIT_OPTION Removed enum value:

    • AUTO_SELECTION_SPLIT

  • Changed property parentActionId (object)

    ID of the parent action for filtering.

  • Changed property sortDirection (object)

    Direction to sort results in ascending or descending order.

  • Changed property sortFields (object)

    List of field names to sort results by.

Return Type:
  • Changed response : 400 Bad Request

Invalid query data supplied.

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 200 OK

ok

  • Changed content type : application/json

    • Changed property content (object)

      List of items for the current page.

    • Changed property empty (object)

      Indicates if the page contains no items.

    • Changed property first (object)

      Indicates if this is the first page.

    • Changed property last (object)

      Indicates if this is the last page.

    • Changed property number (object)

      Current page number starting from zero.

    • Changed property numberOfElements (object)

      Number of items in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Page request information for retrieving results in pages.

      • Changed property pageNumber (object)

        Current page number starting from zero.

      • Changed property pageSize (object)

        Number of items per page.

      • Changed property paged (object)

        Indicates if results are divided into pages.

      • Changed property unpaged (object)

        Indicates if results are not divided into pages.

    • Changed property sort (object)

      Sorting information for ordering the results.

      • Changed property empty (object)

        Indicates if no sorting is applied.

      • Changed property sorted (object)

        Indicates if results are sorted.

      • Changed property unsorted (object)

        Indicates if results are not sorted.

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

    • Changed property content (object)

      List of items for the current page.

    • Changed property empty (object)

      Indicates if the page contains no items.

    • Changed property first (object)

      Indicates if this is the first page.

    • Changed property last (object)

      Indicates if this is the last page.

    • Changed property number (object)

      Current page number starting from zero.

    • Changed property numberOfElements (object)

      Number of items in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Page request information for retrieving results in pages.

      • Changed property pageNumber (object)

        Current page number starting from zero.

      • Changed property pageSize (object)

        Number of items per page.

      • Changed property paged (object)

        Indicates if results are divided into pages.

      • Changed property unpaged (object)

        Indicates if results are not divided into pages.

    • Changed property sort (object)

      Sorting information for ordering the results.

      • Changed property empty (object)

        Indicates if no sorting is applied.

      • Changed property sorted (object)

        Indicates if results are sorted.

      • Changed property unsorted (object)

        Indicates if results are not sorted.

DELETE /enrollmentActions/{actionId}
Return Type:
  • Changed response : 202 Accepted

Accepted

  • Changed content type : application/json

    • Changed property id (object)

      ID of the created or updated enrollment action.

    • Changed property requestId (object)

      Request ID for tracking the accepted request.

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

    • Changed property id (object)

      ID of the created or updated enrollment action.

    • Changed property requestId (object)

      Request ID for tracking the accepted request.

  • Changed response : 204 No Content

No Content

  • Changed content type : application/json

    • Changed property id (object)

      ID of the created or updated enrollment action.

    • Changed property requestId (object)

      Request ID for tracking the accepted request.

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

    • Changed property id (object)

      ID of the created or updated enrollment action.

    • Changed property requestId (object)

      Request ID for tracking the accepted request.

  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

GET /enrollmentActions/{actionId}

Get Enrollment Action by Identifier

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : application/json

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

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

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 200 OK

Ok

  • Changed content type : application/json

    New optional properties:

    • actionType
    • name

    • Added property content (object)

      The actual item data.

    • Deleted property actionType (object)

      Action type.

    • Deleted property description (object)

      Action description.

    • Deleted property id (object)

      Action identifier.

    • Deleted property name (object)

      Action name.

    • Deleted property parentActionId (object)

      Parent action identifier.

    • Deleted property valid (object)

      Validity flag.

    • Deleted property version (object)

      Version.

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

    New optional properties:

    • actionType
    • name

    • Added property content (object)

      The actual item data.

    • Deleted property actionType (object)

      Action type.

    • Deleted property description (object)

      Action description.

    • Deleted property id (object)

      Action identifier.

    • Deleted property name (object)

      Action name.

    • Deleted property parentActionId (object)

      Parent action identifier.

    • Deleted property valid (object)

      Validity flag.

    • Deleted property version (object)

      Version.

PATCH /enrollmentActions/{actionId}
Request:

Map of field names to new values for selective update. Only include fields that need to be updated.

  • Changed content type : application/json

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

Return Type:
  • Changed response : 400 Bad Request

Bad request

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 500 Internal Server Error

Internal server error

  • Changed content type : */*

    • Changed property errors (object)

      List of errors describing what went wrong with the request.

    • Changed property requestId (object)

      Request ID for the request that generated this error.

  • Changed response : 202 Accepted

Accepted

  • Changed content type : */*

    • Added property content (object)

      The actual item data.

    • Deleted property id (object)

    • Deleted property requestId (object)

  • Changed response : 204 No Content

No Content

  • Changed content type : */*

    • Changed property id (object)

      ID of the created or updated enrollment action.

    • Changed property requestId (object)

      Request ID for tracking the accepted request.

Previous page
Next page