Skip to content

Commit 9549b67

Browse files
authored
feat: github team target implementation (#53)
* feat: github team target implementation * feat: improve docs and test existing
1 parent fc838bb commit 9549b67

24 files changed

+1144
-1026
lines changed

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
* text=auto
22

3-
/bin/run text eol=lf
3+
/bin/run.js text eol=lf
44
*.js text eol=lf
55
*.json text eol=lf
66
*.md text eol=lf

.vscode/launch.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"skipFiles": [
99
"<node_internals>/**"
1010
],
11-
"program": "${workspaceFolder}/bin/dev",
11+
"program": "${workspaceFolder}/bin/dev.js",
1212
"args": [
1313
"hello",
1414
"world",

README-dev.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The built container can be substituted for the released container.
3535
The tool will not output much output by default. The console output can be tuned by setting the `DEBUG` environment variable.
3636

3737
```
38-
DEBUG=* ./bin/dev member-sync
39-
DEBUG=oclif:* ./bin/dev member-sync
40-
DEBUG=*Controller\|*Service ./bin/dev member-sync
38+
DEBUG=* ./bin/dev.js member-sync
39+
DEBUG=oclif:* ./bin/dev.js member-sync
40+
DEBUG=*Controller\|*Service ./bin/dev.js member-sync
4141
```

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,30 @@ Auth Sync App does not setup the source systems or the target systems. You are r
66

77
Auth Sync App does not directly grant user access. Instead, clients of the target systems are configured independely of interpret the role themselves. An OIDC target, for example, will have roles added or removed and those roles granted to users by Auth Sync App. It is up to the application to interpret the roles a user is granted appropriately. The client (application) may have its own tool (like the [Vault Sync App](https://github.com/bcgov-nr/vault-sync-app)) for managing on the application side of interpreting the roles received from OIDC.
88

9-
### Supported Sources
9+
### Supported Sources
10+
11+
Sources return a group of users for each role in the configuration.
1012

1113
* [Broker](https://bcgov-nr.github.io/nr-broker/#/)
1214
* Static files
1315

14-
### Supported Targets
16+
### Supported Targets
17+
18+
A target is kept in sync with the configured roles.
19+
20+
#### BC Gov Common Hosted Single Sign-on (CSS)
21+
22+
The CSS target lets you sync the roles and role membership of an integration.
23+
24+
To use this target, you must have a CSS API Account with access to the integration you want to manage.
25+
26+
See: [CSS Documentation](https://developer.gov.bc.ca/docs/default/component/css-docs/)
27+
28+
#### GitHub
29+
30+
The GitHub target lets you sync teams and team membership to a GitHub organization.
1531

16-
* [BC Gov Common Hosted Single Sign-on (CSS)](https://developer.gov.bc.ca/docs/default/component/css-docs/)
17-
* GitHub Teams (in progress)
32+
To use this target, you must have a fine-grained PAT with read and write access to members in the organization.
1833

1934
<!-- toc -->
2035
* [Auth Sync App](#auth-sync-app)
@@ -43,7 +58,7 @@ The general pattern is to call the following commands:
4358

4459
* [generate](#authtool-generate) - Create a configuration file from a template (if necessary)
4560
* [role-sync](#authtool-role-sync) - Sync roles to target system
46-
* [member-sync](#authtool-member-sync) - Sync membership in OIDC roles to target system
61+
* [member-sync](#authtool-member-sync) - Sync membership in roles to target system
4762

4863
The monitor command can be used to automate running this workflow.
4964

0 commit comments

Comments
 (0)