Skip to content

Commit 329fdc5

Browse files
thquadrichard-cox
authored andcommitted
Update documentation (#4876)
Signed-off-by: Thomas Quandt <[email protected]>
1 parent 5a500e2 commit 329fdc5

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

deploy/kubernetes/console/values.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"userEndpointsEnabled": {
1818
"type": "string",
1919
"enum": ["disabled", "admin_only", "enabled"],
20-
"description": "Enable, disable or let only admins view user endpoints"
20+
"description": "Enable, disable or let only admins view and create user endpoints"
2121
},
2222
"autoRegisterCF": {
2323
"type": ["string", "null"]

website/docs/endpoints/cf/user-endpoints.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Configuring User Endpoints
55

66
Stratos provides a way for users to create endpoints without the need to be an administrator.
77

8-
> Note: Admin endpoint-ID's are generated through a SHA-1 encryption of the URL. Endpoints created by a user will differ in their ID, by using the URL + user-ID for encryption. This should pose no problem in the usual Stratos workflow, but if you depend on the ID to be based solely on the URL, then use this feature with caution.
8+
> Note: Admin endpoint-ID's are generated through a SHA-1 encryption of the URL. Personal endpoints will differ in their ID, by using the URL + user-ID for encryption. This should pose no problem in the usual Stratos workflow, but if you depend on the ID to be based solely on the URL, then use this feature with caution.
99
1010
## Set up
1111

@@ -15,16 +15,15 @@ In order to enable User Endpoints support in Stratos:
1515
2. The UAA client used by Stratos needs an additional scope `stratos.endpointadmin`
1616
3. Users need to have the `stratos.endpointadmin` group attached to them
1717

18-
Once all steps have been completed, user within the `stratos.endpointadmin` group are allowed to create endpoints. Endpoints created by users are only visible to their respective user and all admins.
18+
Once all steps have been completed, user within the `stratos.endpointadmin` group are allowed to create personal user endpoints. Endpoints created that way are only visible to their respective user and all admins. Admins will be able to create personal user endpoints after step 1 has been completed.
1919

2020
## Environment variable
2121

2222
`USER_ENDPOINTS_ENABLED` or helm chart value `console.userEndpointsEnabled` can be set to three different states:
2323

2424
1. `disabled` (default) will disable this feature. Neither admins nor users will see user endpoints.
25-
2. `admin_only` will hide user endpoints from users. Admins can still see all endpoints created by users.
26-
3. `enabled` will allow users within the `stratos.endpointadmin` group to create endpoints. The endpoints will only be visible to them or admins.
27-
25+
2. `admin_only` will hide user endpoints from users. Admins can create and see all user endpoints.
26+
3. `enabled` will allow users within the `stratos.endpointadmin` group and admins to create personal user endpoints. These endpoints will only be visible to them or admins.
2827

2928
## Adding scopes to the UAA client
3029

0 commit comments

Comments
 (0)