Skip to content

Commit 2820983

Browse files
committed
README.md updated
1 parent e7fc888 commit 2820983

2 files changed

Lines changed: 52 additions & 1 deletion

File tree

code/examples/create_and_populate_groups/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,55 @@ There is logic to prevent the creation of duplicate groups.
66
The Globus credentials for the service user must be provided via the environment variables GCS_CLI_CLIENT_ID and GCS_CLI_CLIENT_SECRET.
77

88
Provide a subscription UUID in subscription_id in the group config to verify the group within the subscription. The service must have Administrator access to permit this
9+
10+
## Group configuration file format
11+
12+
The path to a valid YAML or JSON group configuration file needs to be supplied as a command line argument.
13+
14+
### YAML
15+
16+
```yaml
17+
---
18+
<group name>:
19+
description: "<optional group description>"
20+
members:
21+
- id: "<globus user uuid>"
22+
role: "<admin | member>"
23+
user: "<informational field only - user email?>"
24+
...
25+
policies:
26+
authentication_assurance_timeout: 1800
27+
group_members_visibility: members
28+
group_visibility: authenticated
29+
is_high_assurance: false
30+
join_requests: false
31+
signup_fields: []
32+
subscription_id: "<optional subscription UUID>"
33+
```
34+
35+
### JSON
36+
37+
```json
38+
{
39+
"<group name>": {
40+
"description": "<optional group description>",
41+
"members": [
42+
{
43+
"user": "<informational field only - user email?>",
44+
"id": "<globus user uuid>",
45+
"role": "<admin | member>"
46+
},
47+
...
48+
],
49+
"policies": {
50+
"is_high_assurance": false,
51+
"authentication_assurance_timeout": 1800,
52+
"group_visibility": "authenticated",
53+
"group_members_visibility": "members",
54+
"join_requests": false,
55+
"signup_fields": []
56+
},
57+
"subscription_id": "<optional subscription UUID>"
58+
}
59+
}
60+
```

code/examples/create_and_populate_groups/managed_groups.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,3 @@ Auto-created test group:
1919
join_requests: false
2020
signup_fields: []
2121
subscription_id: "56107c7a-679f-11ea-960d-0afc9e7dd773"
22-

0 commit comments

Comments
 (0)