Medusa

Generate Token for App

POST

/admin/apps/authorizations

Apps Oauth

Use an app's Oauth provider to generate and store a new token for authentication.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST '{{BASE_URL}}/admin/apps/authorizations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "application_name": "string",
    "state": "string",
    "code": "string"
}'

Response Example

200 - Example 1

{
  "apps": {
    "id": "example_app",
    "display_name": "Example app",
    "application_name": "example",
    "install_url": "http://example.com",
    "uninstall_url": "http://example.com",
    "data": {}
  }
}

Request

Body Params application/json

application_name

string

required

Name of the application for to generate the token for.

state

string

required

State of the application.

code

string

required

The code for the generated token.

Examples

Responses

🟢200OK

application/json

Body

apps

object (OAuth)

required

An Oauth app is typically created by a plugin to handle authentication to third-party services.

string

required

The app's ID

Example:

example_app

display_name

string

required

The app's display name

Example:

Example app

application_name

string

required

The app's name

Example:

example

install_url

string <uri> | null

required

The URL to install the app

uninstall_url

string <uri> | null

required

The URL to uninstall the app

data

object | null

required

Any data necessary to the app.

Example:

{}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2023-10-10 11:56:36

User Login (JWT)

List Applications