{"items":[{"type":"link","label":"Client Management","link":"/api/client-management-0.0.1","routeSlug":"/api/client-management-0.0.1","content":{"contentType":"overview","meta":{"name":"Client Management"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Download PDF","url":"https://docs.ruckus.cloud/static/api/client-management-0.0.1.pdf"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"RUCKUS Cloud Privacy Policy","url":"https://support.ruckuswireless.com/ruckus-one-privacy-policy"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Client Management (0.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/api/client-management-0.0.1"}],"sectionId":"/api/client-management-0.0.1"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Client Management REST APIs provide comprehensive functionality for managing identity clients, including client identification and alias management."},"children":[]}]}]}]}],"sectionId":"/api/client-management-0.0.1/section/overview"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/what-this-api-does"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What This API Does"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client Query"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Query and retrieve detailed information about connected clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client Aliases"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Create, update, delete, and query custom aliases for client devices"},"children":[]}]}]}]}]}],"sectionId":"/api/client-management-0.0.1/section/overview/what-this-api-does"}],"sectionId":"/api/client-management-0.0.1/section/overview/what-this-api-does"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API uses standard HTTP status codes with detailed error messages in the response body."},"children":[]}]}]}]}],"sectionId":"/api/client-management-0.0.1/section/overview/error-handling"}],"sectionId":"/api/client-management-0.0.1/section/overview/error-handling"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/common-error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Error Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints may return these common error responses:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Invalid input data or validation errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Missing or invalid authentication token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 Forbidden"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Insufficient permissions for the requested operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Requested client or resource doesn't exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 Conflict"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Resource conflict (e.g., duplicate alias)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422 Unprocessable Entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Business rule violations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unexpected server errors"},"children":[]}]}]}]}]}],"sectionId":"/api/client-management-0.0.1/section/overview/common-error-responses"}],"sectionId":"/api/client-management-0.0.1/section/overview/common-error-responses"}]}]}},{"type":"group","label":"Overview","link":"/api/client-management-0.0.1/section/overview","routeSlug":"/api/client-management-0.0.1/section/overview","items":[{"type":"link","label":"What This API Does","link":"/api/client-management-0.0.1/section/overview/what-this-api-does","routeSlug":"/api/client-management-0.0.1/section/overview/what-this-api-does","content":null},{"type":"link","label":"Error Handling","link":"/api/client-management-0.0.1/section/overview/error-handling","routeSlug":"/api/client-management-0.0.1/section/overview/error-handling","content":null},{"type":"link","label":"Common Error Responses","link":"/api/client-management-0.0.1/section/overview/common-error-responses","routeSlug":"/api/client-management-0.0.1/section/overview/common-error-responses","content":null}],"content":null},{"type":"group","label":"Client Alias","link":"/api/client-management-0.0.1/client-alias","routeSlug":"/api/client-management-0.0.1/client-alias","items":[{"label":"Get client alias","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/client-management-0.0.1/client-alias/getalias","routeSlug":"/api/client-management-0.0.1/client-alias/getalias","metadata":{"seo":{"title":"Get client alias","description":"Retrieve the alias information for the specified client MAC address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlias","name":"Get client alias","isWebhook":false,"pointer":"/paths/~1clients~1aliases~1{macAddress}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get client alias","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the alias information for the specified client MAC address."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"macAddress","in":"path","schemaId":"schema_343","description":"MAC address of the client","required":true}],"pointer":"/paths/~1clients~1aliases~1{macAddress}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/clients/aliases/{macAddress}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"macAddress","in":"path","required":true,"schemaId":"schema_343"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/clients/aliases/{macAddress}","href":"client-alias/getalias","openApiOperationId":"getAlias","summary":"Get client alias"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Alias found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAlias"}},"schemaId":"components/schemas/ClientAlias"},{"code":"400","description":"Invalid request data","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"404","description":"Alias not found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1clients~1aliases~1{macAddress}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClientAlias","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAlias"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}}},{"code":"404","schemaId":"components/schemas/ApiError","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]}]},"httpPath":"/clients/aliases/{macAddress}"},{"label":"Update or create client alias","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/client-management-0.0.1/client-alias/createupdateclientalias","routeSlug":"/api/client-management-0.0.1/client-alias/createupdateclientalias","metadata":{"seo":{"title":"Update or create client alias","description":"Update or create the alias for the specified client identified by MAC address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateUpdateClientAlias","name":"Update or create client alias","isWebhook":false,"pointer":"/paths/~1clients~1aliases~1{macAddress}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update or create client alias","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update or create the alias for the specified client identified by MAC address."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"macAddress","in":"path","schemaId":"schema_343","description":"MAC address of the client","required":true}],"pointer":"/paths/~1clients~1aliases~1{macAddress}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAlias"}},"schemaId":"components/schemas/ClientAlias","pointer":"/paths/~1clients~1aliases~1{macAddress}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/clients/aliases/{macAddress}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"macAddress","in":"path","required":true,"schemaId":"schema_343"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAlias"}},"responseCodes":["202","400"],"pointer":"/clients/aliases/{macAddress}","href":"client-alias/createupdateclientalias","openApiOperationId":"CreateUpdateClientAlias","summary":"Update or create client alias"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/ClientAlias","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAlias"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperationResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/OperationResponse"}},"schemaId":"components/schemas/OperationResponse"},{"code":"400","description":"Invalid request data","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1clients~1aliases~1{macAddress}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/OperationResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperationResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/OperationResponse"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]}]},"httpPath":"/clients/aliases/{macAddress}"},{"label":"Delete client alias","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/client-management-0.0.1/client-alias/deleteclientalias","routeSlug":"/api/client-management-0.0.1/client-alias/deleteclientalias","metadata":{"seo":{"title":"Delete client alias","description":"Remove the alias associated with the specified client MAC address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteClientAlias","name":"Delete client alias","isWebhook":false,"pointer":"/paths/~1clients~1aliases~1{macAddress}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete client alias","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove the alias associated with the specified client MAC address."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"macAddress","in":"path","schemaId":"schema_343","description":"MAC address of the client","required":true}],"pointer":"/paths/~1clients~1aliases~1{macAddress}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/clients/aliases/{macAddress}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"macAddress","in":"path","required":true,"schemaId":"schema_343"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400"],"pointer":"/clients/aliases/{macAddress}","href":"client-alias/deleteclientalias","openApiOperationId":"DeleteClientAlias","summary":"Delete client alias"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperationResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/OperationResponse"}},"schemaId":"components/schemas/OperationResponse"},{"code":"400","description":"Invalid request data","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1clients~1aliases~1{macAddress}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/OperationResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperationResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/OperationResponse"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]}]},"httpPath":"/clients/aliases/{macAddress}"},{"label":"Query client aliases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/client-management-0.0.1/client-alias/queryaliases","routeSlug":"/api/client-management-0.0.1/client-alias/queryaliases","metadata":{"seo":{"title":"Query client aliases","description":"Query client aliases based on filter criteria such as alias name or MAC address, with support for pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryAliases","name":"Query client aliases","isWebhook":false,"pointer":"/paths/~1clients~1aliases~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query client aliases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query client aliases based on filter criteria such as alias name or MAC address, with support for pagination."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageable","in":"query","schemaId":"schema_344","description":"Parameters for paging","required":true}],"pointer":"/paths/~1clients~1aliases~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientAliasQueryRequest"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAliasQueryRequest"}},"schemaId":"components/schemas/ClientAliasQueryRequest","pointer":"/paths/~1clients~1aliases~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/clients/aliases/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"pageable","in":"query","required":true,"schemaId":"components/schemas/Pageable"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ClientAliasQueryRequest"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAliasQueryRequest"}},"responseCodes":["200","400"],"pointer":"/clients/aliases/query","href":"client-alias/queryaliases","openApiOperationId":"queryAliases","summary":"Query client aliases"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/ClientAliasQueryRequest","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientAliasQueryRequest"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAliasQueryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Aliases found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageClientAlias"}},"schemaId":"components/schemas/PageClientAlias"},{"code":"400","description":"Invalid request data","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageClientAlias"}},"schemaId":"components/schemas/PageClientAlias"}],"pointer":"/paths/~1clients~1aliases~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageClientAlias","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageClientAlias"}}},{"code":"400","schemaId":"components/schemas/PageClientAlias","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageClientAlias"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageClientAlias"}}}],"examples":[]}]}]}]},"httpPath":"/clients/aliases/query"}],"content":{"contentType":"group","meta":{"name":"Client Alias"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Client Alias","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing client aliases."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/clients/aliases/{macAddress}","summary":"Get client alias","prefix":{"name":"get","color":"get"},"badges":[],"link":"/client-alias/getalias","deprecated":false},{"title":"/clients/aliases/{macAddress}","summary":"Update or create client alias","prefix":{"name":"put","color":"put"},"badges":[],"link":"/client-alias/createupdateclientalias","deprecated":false},{"title":"/clients/aliases/{macAddress}","summary":"Delete client alias","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/client-alias/deleteclientalias","deprecated":false},{"title":"/clients/aliases/query","summary":"Query client aliases","prefix":{"name":"post","color":"post"},"badges":[],"link":"/client-alias/queryaliases","deprecated":false}]}]}]}]}},{"type":"group","label":"Identity Client","link":"/api/client-management-0.0.1/identity-client","routeSlug":"/api/client-management-0.0.1/identity-client","items":[{"label":"Associate Client to Identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/client-management-0.0.1/identity-client/associateclienttoidentity","routeSlug":"/api/client-management-0.0.1/identity-client/associateclienttoidentity","metadata":{"seo":{"title":"Associate Client to Identity","description":"Associate one or more clients to a target identity. This operation moves the specified clients from their current identity to the target identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"associateClientToIdentity","name":"Associate Client to Identity","isWebhook":false,"pointer":"/paths/~1identities~1{identityId}~1clients~1associations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Associate Client to Identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Associate one or more clients to a target identity. This operation moves the specified clients from their current identity to the target identity."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identityId","in":"path","schemaId":"schema_343","required":true}],"pointer":"/paths/~1identities~1{identityId}~1clients~1associations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientAssociationRequest"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAssociationRequest"}},"schemaId":"components/schemas/ClientAssociationRequest","pointer":"/paths/~1identities~1{identityId}~1clients~1associations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/identities/{identityId}/clients/associations","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"identityId","in":"path","required":true,"schemaId":"schema_343"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ClientAssociationRequest"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAssociationRequest"}},"responseCodes":["202","400"],"pointer":"/identities/{identityId}/clients/associations","href":"identity-client/associateclienttoidentity","openApiOperationId":"associateClientToIdentity","summary":"Associate Client to Identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/ClientAssociationRequest","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientAssociationRequest"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientAssociationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request accepted. The client association operation has been queued for processing.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperationResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/OperationResponse"}},"schemaId":"components/schemas/OperationResponse"},{"code":"400","description":"Invalid request data. The request contains validation errors or invalid parameters.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1identities~1{identityId}~1clients~1associations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/OperationResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperationResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/OperationResponse"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]}]},"httpPath":"/identities/{identityId}/clients/associations"},{"label":"Query Identity Clients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/client-management-0.0.1/identity-client/queryidentityclient","routeSlug":"/api/client-management-0.0.1/identity-client/queryidentityclient","metadata":{"seo":{"title":"Query Identity Clients","description":"Query and retrieve a paginated list of clients associated with identities based on filter criteria such as identity IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryIdentityClient","name":"Query Identity Clients","isWebhook":false,"pointer":"/paths/~1identities~1clients~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Identity Clients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query and retrieve a paginated list of clients associated with identities based on filter criteria such as identity IDs."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageable","in":"query","schemaId":"schema_344","description":"Parameters for paging","required":true}],"pointer":"/paths/~1identities~1clients~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientQuery"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientQuery"}},"schemaId":"components/schemas/ClientQuery","pointer":"/paths/~1identities~1clients~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/identities/clients/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"pageable","in":"query","required":true,"schemaId":"components/schemas/Pageable"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ClientQuery"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientQuery"}},"responseCodes":["200"],"pointer":"/identities/clients/query","href":"identity-client/queryidentityclient","openApiOperationId":"queryIdentityClient","summary":"Query Identity Clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/ClientQuery","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientQuery"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ClientQuery"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Clients found","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageClient"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageClient"}},"schemaId":"components/schemas/PageClient"}],"pointer":"/paths/~1identities~1clients~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageClient","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageClient"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageClient"}}}],"examples":[]}]}]}]},"httpPath":"/identities/clients/query"}],"content":{"contentType":"group","meta":{"name":"Identity Client"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identity Client","showPageActions":true},{"nodeType":"markdoc","content":"APIs for querying identity client information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/identities/{identityId}/clients/associations","summary":"Associate Client to Identity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/identity-client/associateclienttoidentity","deprecated":false},{"title":"/identities/clients/query","summary":"Query Identity Clients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/identity-client/queryidentityclient","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ClientAlias":{"id":"components/schemas/ClientAlias","kind":"json-schema","title":"ClientAlias","data":{"type":"object","description":"Represents a client device alias that provides a friendly name for a network device identified by its MAC address.","properties":{"id":{"type":"string","description":"The identifier of the client alias."},"alias":{"type":"string","description":"The alias name of the client.","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]{0,254}$"},"deviceType":{"type":"string","description":"The type of the device.","enum":["WIFI","SWITCH","EDGE"]},"macAddress":{"type":"string","description":"The MAC address of the client."}},"required":["alias"]}},"components/schemas/OperationResponse":{"id":"components/schemas/OperationResponse","kind":"json-schema","title":"OperationResponse","data":{"type":"object","description":"The response for the operation.","properties":{"requestId":{"type":"string","description":"The unique identifier of the request."},"id":{"type":"string","description":"Only present for the create operation."}}}},"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"type":"object","description":"The error response for the API.","properties":{"status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the error."},"message":{"type":"string"},"debugMessage":{"type":"string","description":"The debug message of the error."},"subErrors":{"type":"array","description":"The list of errors.","items":{"$ref":"#/components/schemas/ApiSubError"}}}}},"components/schemas/ApiSubError":{"id":"components/schemas/ApiSubError","kind":"json-schema","title":"ApiSubError","data":{"description":"The sub error for the API."}},"components/schemas/ClientAssociationRequest":{"id":"components/schemas/ClientAssociationRequest","kind":"json-schema","title":"ClientAssociationRequest","data":{"type":"object","description":"Change clients association to other identity.","properties":{"identityId":{"type":"string","description":"The ID of the destination identity where the specified clients will be moved.","minLength":1},"clientIds":{"type":"array","description":"List of client IDs to be moved to the target identity.","items":{"type":"string"},"maxItems":100,"maximum":100,"minItems":1,"minimum":1}},"required":["clientIds","identityId"]}},"components/schemas/ClientQuery":{"id":"components/schemas/ClientQuery","kind":"json-schema","title":"ClientQuery","data":{"type":"object","description":"A query object that specifies the criteria for searching and filtering identity clients, including identity IDs, group ID, and client MAC addresses.","properties":{"identityIds":{"type":"array","description":"A list of identity identifiers used to filter and retrieve specific clients associated with those identities.","items":{"type":"string"}},"groupId":{"type":"string","description":"A group identifier used to filter clients by their identity group."},"clientMacs":{"type":"array","description":"A list of client MAC addresses used to filter specific clients.","items":{"type":"string"}},"aliasFilter":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter clients by alias presence. ALL returns all clients, ALIAS returns only clients with alias, NON_ALIAS returns only clients without alias."},"children":[]}]}]}],"enum":["ALL","ALIAS","NON_ALIAS"]}}}},"components/schemas/Pageable":{"id":"components/schemas/Pageable","kind":"json-schema","title":"Pageable","data":{"type":"object","properties":{"page":{"type":"integer","format":"int32","minimum":0},"size":{"type":"integer","format":"int32","minimum":1},"sort":{"type":"array","items":{"type":"string"}}}}},"components/schemas/Client":{"id":"components/schemas/Client","kind":"json-schema","title":"Client","data":{"type":"object","description":"Represents a device that has previously connected or is currently connected to the network, containing connection information.","properties":{"id":{"type":"string","description":"The identifier of the client."},"groupId":{"type":"string","description":"The identifier of identity group for the client."},"identityId":{"type":"string","description":"The identifier of identity for the client."},"clientMac":{"type":"string","description":"The MAC of the client."},"networkId":{"type":"string","description":"The identifier of network used by the client."},"apMac":{"type":"string","description":"The MAC of AP used by the client."},"ssid":{"type":"string","description":"The SSID used by the client."},"username":{"type":"string","description":"The name of the client."},"onboardType":{"type":"string","description":"The type of onboard used by the client."},"alias":{"type":"string","description":"The alias of the client."}}}},"components/schemas/PageClient":{"id":"components/schemas/PageClient","kind":"json-schema","title":"PageClient","data":{"type":"object","description":"A paginated response containing a list of client. Includes pagination metadata such as total elements, total pages, current page number, and the list of client items.","properties":{"totalPages":{"type":"integer","format":"int32","description":"The total number of pages in the result set."},"totalElements":{"type":"integer","format":"int64","description":"The total number of elements in the result set."},"size":{"type":"integer","format":"int32"},"content":{"type":"array","description":"The list of client items.","items":{"$ref":"#/components/schemas/Client"}},"number":{"type":"integer","format":"int32","description":"The current page number."},"sort":{"$ref":"#/components/schemas/SortObject"},"pageable":{"$ref":"#/components/schemas/PageableObject","description":"The pagination information associated with this page."},"numberOfElements":{"type":"integer","format":"int32","description":"The number of elements on the current page."},"first":{"type":"boolean","description":"Indicates whether the current page is the first page."},"last":{"type":"boolean","description":"Indicates whether the current page is the last page."},"empty":{"type":"boolean","description":"Indicates whether the result set is empty."}}}},"components/schemas/PageableObject":{"id":"components/schemas/PageableObject","kind":"json-schema","title":"PageableObject","data":{"type":"object","description":"Pagination information for a page request. Contains details about the requested page size, page number, sorting, and offset.","properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/SortObject"},"pageNumber":{"type":"integer","format":"int32","description":"The page number. Page 0 is the first page, page 1 is the second page, and so on."},"pageSize":{"type":"integer","format":"int32","description":"The number of elements per page. Determines how many items are returned in each page of results."},"paged":{"type":"boolean","description":"Indicates whether pagination is enabled. When true, the result set is paginated. When false, all results are returned without pagination."},"unpaged":{"type":"boolean","description":"Indicates whether pagination is disabled. When true, all results are returned without pagination. When false, pagination is applied."}}}},"components/schemas/SortObject":{"id":"components/schemas/SortObject","kind":"json-schema","title":"SortObject","data":{"type":"object","description":"Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).","properties":{"empty":{"type":"boolean","description":"Indicates whether the result set is empty."},"sorted":{"type":"boolean","description":"Indicates whether sorting is enabled. When true, the result set is sorted. When false, the result set is not sorted."},"unsorted":{"type":"boolean","description":"Indicates whether sorting is disabled. When true, the result set is not sorted. When false, the result set is sorted."}}}},"components/schemas/ClientAliasQueryRequest":{"id":"components/schemas/ClientAliasQueryRequest","kind":"json-schema","title":"ClientAliasQueryRequest","data":{"type":"object","description":"Query request for client aliases.","properties":{"macAddresses":{"type":"array","description":"A list of MAC addresses to filter the query. If omitted or empty, the query will not filter by MAC address.","items":{"type":"string"}},"alias":{"type":"string","description":"A partial match filter for the alias."}}}},"components/schemas/PageClientAlias":{"id":"components/schemas/PageClientAlias","kind":"json-schema","title":"PageClientAlias","data":{"type":"object","description":"A paginated response containing a list of client alias. Includes pagination metadata such as total elements, total pages, current page number, and the list of client alias items.","properties":{"totalPages":{"type":"integer","format":"int32","description":"The total number of pages in the result set."},"totalElements":{"type":"integer","format":"int64","description":"The total number of elements in the result set."},"size":{"type":"integer","format":"int32"},"content":{"type":"array","description":"The list of client alias items.","items":{"$ref":"#/components/schemas/ClientAlias"}},"number":{"type":"integer","format":"int32","description":"The current page number."},"sort":{"$ref":"#/components/schemas/SortObject"},"pageable":{"$ref":"#/components/schemas/PageableObject","description":"The pagination information associated with this page."},"numberOfElements":{"type":"integer","format":"int32","description":"The number of elements on the current page."},"first":{"type":"boolean","description":"Indicates whether the current page is the first page."},"last":{"type":"boolean","description":"Indicates whether the current page is the last page."},"empty":{"type":"boolean","description":"Indicates whether the result set is empty."}}}},"schema_343":{"kind":"json-schema","data":{"type":"string"},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Pageable"},"id":"schema_344"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}]},"options":{"hideReplay":true,"hideDownloadButtons":false,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"}]},"downloadUrls":[{"title":"Download PDF","url":"https://docs.ruckus.cloud/static/api/client-management-0.0.1.pdf"}],"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true,"position":"off"},"disableRouter":true,"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Client Management","description":"# Overview\n\nThe Client Management REST APIs provide comprehensive functionality for managing identity clients, including client identification and alias management.\n\n## What This API Does\n- **Client Query**: Query and retrieve detailed information about connected clients\n- **Client Aliases**: Create, update, delete, and query custom aliases for client devices\n\n## Error Handling\nThe API uses standard HTTP status codes with detailed error messages in the response body.\n\n## Common Error Responses\nAll endpoints may return these common error responses:\n- **400 Bad Request**: Invalid input data or validation errors\n- **401 Unauthorized**: Missing or invalid authentication token\n- **403 Forbidden**: Insufficient permissions for the requested operation\n- **404 Not Found**: Requested client or resource doesn't exist\n- **409 Conflict**: Resource conflict (e.g., duplicate alias)\n- **422 Unprocessable Entity**: Business rule violations\n- **500 Internal Server Error**: Unexpected server errors"}},"baseSlug":"/api/client-management-0.0.1","routesMapping":{}}