Include authorization information in service info response #68
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #67 , this PR aims to incorporate the GA4GH FASP API Feedback into the service info spec, namely by allowing services to broadcast information about how to authorize to them (either alone or as part of a registry through service registry).
The motivation is to allow clients discovering new GA4GH services to automatically authorize to them without having pre-existing knowledge of auth server location and mechanisms.
@mbarkley provided a great document on how this could be accomplished. The document outlines the following 3 technical recommendations:
The PR introduces an
authInfo
property and schema into theService
schema, which contains the above recommendations.This is addressed by
AuthInfo
'sauthServer
property, which contains 3 Authorization Server URLs: 1 for an optionalservice-info
endpoint, one for the OAuth authorization endpoint, and one for the OAuth token endpointThis is partially addressed by
AuthInfo
'sscopeDefinitions
property, which maps controlled endpoints on the GA4GH resource server to the scope(s) one would need to pass to the authorization server to gain access to them.Currently, custom parameters are not yet addressed in this PR, though they should be.
Not currently incorporated into this PR, though it should be.
@ianfore this should help in the FASP scripts making use of registry, allowing access to the DRS servers without handling tokens manually on the client machine
@mcupak