Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added notes on missing SecurityService and is-debug-enabled method. #5009

Merged
merged 2 commits into from
Nov 22, 2023
Merged

docs: Added notes on missing SecurityService and is-debug-enabled method. #5009

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12eb934
Added notes on missing SecurityService and is-debug-enabled method.
salvatore-coppola Nov 21, 2023
aa0f002
minor rewording
nicolatimeus Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/references/rest-apis/rest-security-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

This API can also be accessed via the RequestHandler with app-id: `SEC-V1`.

This REST API requires a [SecurityService](https://download.eclipse.org/kura/docs/api/5.4.0/apidocs/org/eclipse/kura/security/SecurityService.html) implementation to be registered on the framework, which is not provided by the standard Kura distribution.


The `SecurityRestService` APIs provides methods to manage the system security.
Identities with `rest.security` permissions can access these APIs.
Expand All @@ -18,7 +20,7 @@ Identities with `rest.security` permissions can access these APIs.
##### Responses

- 200 OK status
- 500 Internal Server Error
- 500 Internal Server Error (also returned when no `SecurityService` implementation is available)

#### Reload command line fingerprint

Expand All @@ -29,11 +31,14 @@ Identities with `rest.security` permissions can access these APIs.
##### Responses

- 200 OK status
- 500 Internal Server Error
- 500 Internal Server Error (also returned when no `SecurityService` implementation is available)

## GET methods

#### Debug enabled
#### Debug enabled
!!! note

Access to this resource doesn't require the `rest.security` permission.

- Description: This method allows you to check whether debug mode is enabled in the system.
- Method: GET
Expand All @@ -47,4 +52,4 @@ Identities with `rest.security` permissions can access these APIs.
"enabled":true
}
```
- 500 Internal Server Error
- 500 Internal Server Error (also returned when no `SecurityService` implementation is available)
Loading