Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

spec: add user and subject information to grant request/response #504

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 70 additions & 3 deletions openapi/auth-server.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,27 @@ paths:
required:
- access_token
- continue
- properties:
subject:
type: object
description: Subject (user) information as requested
required:
- sub_ids
properties:
sub_ids:
type: array
items:
type: object
properties:
format:
type: string
id:
type: string
required:
- format
- id
required:
- subject
type: object
examples:
Interaction instructions:
Expand Down Expand Up @@ -72,6 +93,12 @@ paths:
access_token:
value: 33OMUKMKSKU80UPRY5NM
uri: 'https://auth.rafiki.money/continue/4CF492MLVMSW9MKMXKHQ'
Subject Information:
value:
subject:
sub_ids:
- format: uri
id: 'https://example-wallet.com/bob'
'400':
description: Bad Request
'401':
Expand All @@ -82,7 +109,6 @@ paths:
content:
application/json:
schema:
description: ''
type: object
properties:
access_token:
Expand All @@ -96,8 +122,35 @@ paths:
$ref: '#/components/schemas/client'
interact:
$ref: '#/components/schemas/interact-request'
user:
type: object
description: Identifying the user. Needs user interaction.
properties:
sub_ids:
type: array
items:
type: object
properties:
format:
type: string
enum:
- uri
id:
type: string
required:
- format
- id
subject:
type: object
description: Requesting subject (user) information. Needs user interaction.
properties:
sub_id_formats:
type: array
items:
type: string
required:
- sub_id_formats
required:
- access_token
- client
examples:
Grant request for creating and reading recurring fixed payment:
Expand Down Expand Up @@ -134,8 +187,22 @@ paths:
- read
identifier: 'http://ilp.rafiki.money/bob'
client: 'https://webmonize.com/.well-known/pay'
Indentifying the user:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: misspelling of "Identifying"

value:
client: 'https://example-wallet.com/alice'
interact:
start:
- redirect
finish:
method: redirect
uri: 'http://example-website.com/login/1dbe7d4c-9a8b-4351-874b-016b6d62eff9'
nonce: a92c1ba7-7688-4270-be05-43241bf87bcd
user:
sub_ids:
- format: uri
id: 'https://example-wallet.com/bob'
description: ''
description: Make a new grant request
description: 'Make a new grant request, subject request, or identify the user'
security: []
tags:
- grant
Expand Down
Loading