Files
medusa-store/docs/api/admin/components/schemas/OAuth.yaml
github-actions[bot] 658339767b chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-08-07 16:54:48 +03:00

41 lines
852 B
YAML

title: OAuth
description: >-
An Oauth app is typically created by a plugin to handle authentication to
third-party services.
type: object
required:
- application_name
- data
- display_name
- id
- install_url
- uninstall_url
properties:
id:
description: The app's ID
type: string
example: example_app
display_name:
description: The app's display name
type: string
example: Example app
application_name:
description: The app's name
type: string
example: example
install_url:
description: The URL to install the app
nullable: true
type: string
format: uri
uninstall_url:
description: The URL to uninstall the app
nullable: true
type: string
format: uri
data:
description: Any data necessary to the app.
nullable: true
type: object
example: {}