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

(feat): spec out interaction endpoints #141

Merged
merged 1 commit into from
Jul 13, 2022
Merged
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
51 changes: 51 additions & 0 deletions auth-server-open-api-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ tags:
description: grant operations
- name: token
description: token operations
- name: interaction
description: User interaction endpoints
paths:
/:
post:
Expand Down Expand Up @@ -428,6 +430,55 @@ paths:
resource_server: 7C7C4AZ9KHRS6X63AJAO
tags:
- token
'/interact/{id}':
get:
summary: Start user interaction
tags:
- interaction
- grant
responses:
'302':
description: Found
headers:
Location:
schema:
type: string
description: Identity server endpoint
Cookie:
schema:
type: string
description: Interaction id
operationId: get-interact
parameters: []
description: 'To start the user interaction for grant approval, this endpoint redirects to identity server for authentication of the user.'
parameters:
- schema:
type: string
name: id
in: path
required: true
description: Interaction id
post:
summary: Finish user interaction
operationId: post-interact-id
responses:
'302':
description: Found
headers:
Location:
schema:
type: string
description: Client finish endpoint
description: 'To finish the user interaction for grant approval, this endpoint redirects to the client''s finish url.'
tags:
- interaction
- grant
parameters:
- schema:
type: string
in: cookie
name: interactId
description: Interaction id
components:
schemas:
access:
Expand Down