sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-16 07:26:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update API pages with v0.30.2

Browse Source
This commit is contained in:
netbirddev
2024-10-16 16:00:30 +00:00
parent 0a0fb2e096
commit b0189f1953
2 changed files with 50 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/pages/ipa/resources/accounts.mdx
View File

@@ -166,6 +166,8 @@ echo $response;
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -187,6 +189,8 @@ echo $response;
"settings": {
"peer_login_expiration_enabled": "boolean",
"peer_login_expiration": "integer",
"peer_inactivity_expiration_enabled": "boolean",
"peer_inactivity_expiration": "integer",
"regular_users_view_blocked": "boolean",
"groups_propagation_enabled": "boolean",
"jwt_groups_enabled": "boolean",
@@ -405,6 +409,16 @@ echo $response;
Period of time after which peer login expires (seconds).
</Property>
<Property name="peer_inactivity_expiration_enabled" type="boolean" required={true}>
Enables or disables peer inactivity expiration globally. After peer's session has expired the user has to log in (authenticate). Applies only to peers that were added by a user (interactive SSO login).
</Property>
<Property name="peer_inactivity_expiration" type="integer" required={true}>
Period of time of inactivity after which peer session expires (seconds).
</Property>
<Property name="regular_users_view_blocked" type="boolean" required={true}>
@@ -470,6 +484,8 @@ curl -X PUT https://api.netbird.io/api/accounts/{accountId} \
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -490,6 +506,8 @@ let data = JSON.stringify({
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -532,6 +550,8 @@ payload = json.dumps({
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -574,6 +594,8 @@ func main() {
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -634,6 +656,8 @@ request.body = JSON.dump({
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -658,6 +682,8 @@ RequestBody body = RequestBody.create(mediaType, '{
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -698,6 +724,8 @@ curl_setopt_array($curl, array(
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -733,6 +761,8 @@ echo $response;
"settings": {
"peer_login_expiration_enabled": true,
"peer_login_expiration": 43200,
"peer_inactivity_expiration_enabled": true,
"peer_inactivity_expiration": 43200,
"regular_users_view_blocked": true,
"groups_propagation_enabled": true,
"jwt_groups_enabled": true,
@@ -752,6 +782,8 @@ echo $response;
"settings": {
"peer_login_expiration_enabled": "boolean",
"peer_login_expiration": "integer",
"peer_inactivity_expiration_enabled": "boolean",
"peer_inactivity_expiration": "integer",
"regular_users_view_blocked": "boolean",
"groups_propagation_enabled": "boolean",
"jwt_groups_enabled": "boolean",

18
src/pages/ipa/resources/peers.mdx
View File

@@ -188,6 +188,7 @@ echo $response;
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z",
"inactivity_expiration_enabled": false,
"approval_required": true,
"country_code": "DE",
"city_name": "Berlin",
@@ -225,6 +226,7 @@ echo $response;
"login_expiration_enabled": "boolean",
"login_expired": "boolean",
"last_login": "string",
"inactivity_expiration_enabled": "boolean",
"approval_required": "boolean",
"country_code": "string",
"city_name": "string",
@@ -435,6 +437,7 @@ echo $response;
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z",
"inactivity_expiration_enabled": false,
"approval_required": true,
"country_code": "DE",
"city_name": "Berlin",
@@ -469,6 +472,7 @@ echo $response;
"login_expiration_enabled": "boolean",
"login_expired": "boolean",
"last_login": "string",
"inactivity_expiration_enabled": "boolean",
"approval_required": "boolean",
"country_code": "string",
"city_name": "string",
@@ -514,6 +518,11 @@ echo $response;
</Property>
<Property name="inactivity_expiration_enabled" type="boolean" required={true}>
</Property>
<Property name="approval_required" type="boolean" required={false}>
@@ -536,6 +545,7 @@ curl -X PUT https://api.netbird.io/api/peers/{peerId} \
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true
}'
```
@@ -546,6 +556,7 @@ let data = JSON.stringify({
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true
});
let config = {
@@ -578,6 +589,7 @@ payload = json.dumps({
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true
})
headers = {
@@ -610,6 +622,7 @@ func main() {
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true
}`)
client := &http.Client {
@@ -660,6 +673,7 @@ request.body = JSON.dump({
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true
})
response = https.request(request)
@@ -674,6 +688,7 @@ RequestBody body = RequestBody.create(mediaType, '{
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true
}');
Request request = new Request.Builder()
@@ -704,6 +719,7 @@ curl_setopt_array($curl, array(
"name": "stage-host-1",
"ssh_enabled": true,
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true
}',
CURLOPT_HTTPHEADER => array(
@@ -751,6 +767,7 @@ echo $response;
"login_expiration_enabled": false,
"login_expired": false,
"last_login": "2023-05-05T09:00:35.477782Z",
"inactivity_expiration_enabled": false,
"approval_required": true,
"country_code": "DE",
"city_name": "Berlin",
@@ -785,6 +802,7 @@ echo $response;
"login_expiration_enabled": "boolean",
"login_expired": "boolean",
"last_login": "string",
"inactivity_expiration_enabled": "boolean",
"approval_required": "boolean",
"country_code": "string",
"city_name": "string",