search

1Password / scim-examples

1Password SCIM Bridge deployment examples
https://support.1password.com/scim/
MIT License
139 stars 135 forks source link

Revise testing instructions #306

Closed ag-adampike closed 1 month ago

ag-adampike commented 1 month ago

This PR revises testing instructions across all deployment examples. Documentation for testing often invokes some other endpoint (e.g. /Users), but /health is designed for determining health state, and is supported when connecting all identity providers, including Google Workspace.

Some bonus formatting fixes in adjacent text are also included, as well as simplified steps that can potentially be excluded from this merge; the core changes are included in https://github.com/1Password/scim-examples/commit/cc19849649ee1cc41c745f88dbfdc50a1813703d.

Resolves #257.

ag-adampike commented 1 month ago

I do feel that with this change, we are highlighting curl as the primary way to test a SCIM bridge for all deployments, I kind of think that the primary testing method would be through accessing the SCIM bridge URL in a browser, and the curl command is secondary way to do it for those inclined to go that route. I know that some deployments are mode code driven, but that does not always mean that the person doing the deployment is command savvy.

A fair point! When a README for a deployment example is mainly CLI driven and it's not necessary to configure anything in the SCIM Bridge web interface, I'd personally want to default to ordering a command first (and also improving that with temp variables and such where possible). It does the job of authing to 1Password and should immediately return the same useful information in a terminal as you see would when signing in via /app. It's also fewer steps and interfaces to manage.