OAuth 2.0

OAuth 2.0 1.0.0

0
No votes yet
expand_moreexpand_lessLicense
https://vp1npmqdp01-v1.genco.com:4433
forum Discuss this API in the forum
development
https://api-sandbox.supplychain.fedex.com/api/sandbox

Paths

/oauth2/authorize

get /oauth2/authorize

FedEx Supply Chain OAuth 2.0 Authorization endpoint, which brings the FedEx Fulfillment Login page to the user

description

clientID
client_id
(apiKey located in query)

The client ID you received when you first registered an app in FedEx Supply Chain API Developer Portal.

response_type
Required in query
string

The response_type has to be “code” to indicate to the Authorization Server to receive the authorization code.

{
    "enum": [
        "code",
        "token"
    ]
}
scope
Optional in query
string

One or more scope values to indicate which part of user’s account data you want to access. E.g: Fulfillment_Returns

redirect_uri
Optional in query
string

Indicates the URI to return the user to after authorization is complete.

state
Optional in query
string

A unique ID generated by your application that you can verify later. This will be returned by Authorization Server unmodified.

org_name
Required in query
string

Partner or organization name.

Accept
Optional in header
string
text/html
200

An HTML form for authentication or authorization of this request.

302

Redirect to the clients redirect_uri

Example Request
Example Response
GET https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
accept
response_type
scope
redirect_uri
state
org_name
post /oauth2/authorize

Submit approval to authorization code or access token

Submit resource owners approval (or rejection) for the OAuth2 Server to issue an authorization code or access token to the application.

client_id
Required in formData
string

The client ID you received when you first registered an app in FedEx Supply Chain API Developer Portal.

scope
Required in formData
string

One or more scope values to indicate which part of user’s account data you want to access. E.g: Fulfillment_Returns

resource-owner
Required in formData
string

Resource owners user name

redirect_uri
Required in formData
string

URI the application is requesting this code or token to be redirected to

original-url
Required in formData
string

URL of the original authorization request

Content-Type
Optional in header
string
application/x-www-form-urlencoded
Accept
Optional in header
string
text/html
200

Cool

Example Request
Example Response
POST https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
content-type
accept
client_id
scope
resource-owner
redirect_uri
original-url

/oauth2/token

post /oauth2/token

Request Access Tokens and Refresh Token

This endpoint allows requesting an access token following one of the flows below:- Authorization Code (exchange code for access token) - Refresh Token (exchange refresh token for a new access code)

grant_type
Required in formData
string

Indicates the grant type for the API call. Valid Values: • “authorization_code”: this is used to retrieve the initial access token. The code parameter must be passed with the authorization code retrieved from the authorize API call. • “refresh_token”: this is used to refresh the access token. The code parameter must be passed with the refresh_token value from the initial token API call.

{
    "enum": [
        "authorization_code",
        "password",
        "client_credentials",
        "refresh_token"
    ]
}
client_id
Required in formData
string

The client ID you received when you first registered an app in FedEx Supply Chain API Developer Portal.

client_secret
Required in formData
string

The client secret you received when you first registered an app in Fulfillment Platform Developer Portal.

code
Optional in formData
string

The code is either the value of the authorization code or the refresh token, depending on the grant_type.

redirect_uri
Optional in formData
string

Indicates the URI to return the user to after authorization is complete.

username
Optional in formData
string

Resource owner username

password
Optional in formData
string

Resource owner password

scope
Optional in formData
string

One or more scope values to indicate which part of user’s account data you want to access. If it is provided, the default is used based on the settings in your Developer Portal. NOTE: The scope is space delimited list of scope values. Default scope FulFillment_Returns

refresh_token
Optional in formData
string

The refresh token that the client wants to exchange for a new access token (refresh_token grant_type)

org_name
Required in header
string

Partner or organization name.

x-org-name
Required in header
string

Partner or organization name for password flow

Content-Type
Optional in header
string
application/x-www-form-urlencoded
Accept
Optional in header
string
application/json
text/json
200

json document containing token, etc.

access_token_response
400

json document that may contain additional details about the failure

Example Request
Example Response
POST https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
content-type
accept
org_name
x-org-name
grant_type
client_id
client_secret
code
redirect_uri
username
password
scope
refresh_token

/oauth/introspect

post /oauth/introspect
clientID
client_id
(apiKey located in query)

The client ID you received when you first registered an app in FedEx Supply Chain API Developer Portal.

token
Optional in formData
string

String value of the access_token to be introspected

token_type_hint
Optional in formData
string

This must contain 'access_token' to indicate the token type

Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth/introspect
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth/introspect
content-type
accept
token
token_type_hint

Definitions 

{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "token_type",
        "access_token",
        "expires_in"
    ],
    "properties": {
        "token_type": {
            "enum": [
                "bearer"
            ]
        },
        "access_token": {
            "type": "string"
        },
        "expires_in": {
            "type": "integer"
        },
        "scope": {
            "type": "string"
        },
        "refresh_token": {
            "type": "string"
        }
    }
}