SEI Developer Portal | oAuthToken v2

oAuthToken v2

POST

/oauthtoken

Prod:

http://seipdapgnode6/oauthtoken

Header Parameters

Name	Description	Data Type	Required
Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.	string
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.	string

HTTP Responses

Code

Description
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

oAuthToken v2

POST

/oauthtoken

Prod:

http://seipdapgnode6/oauthtoken

Header Parameters

Name	Description	Data Type	Required
Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.	string
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.	string

HTTP Responses

Code

Description
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v2/oauthtoken

TLS*: https://mtls.api.seic.com/v2/oauthtoken

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 1

oAuthToken

POST

Based on the grant_type selection made the URL that the application needs to invoke with relevant parameters to obtain an oAuth Token will vary

grant_type

STEP 1

client_credentials

password

refresh_token

The application needs to pass required parameters to the /oauthtoken endpoint to obtain an oAuth Token

invalidate_token

The application needs to pass a valid access_token to the /oauthtoken endpoint to kill the oAuth Token

oAuthToken v2

POST

/oauthtoken

Prod:

http://seipdapgnode6/oauthtoken

Header Parameters

Name	Description	Data Type	Required
Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.	string
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.	string

HTTP Responses

Code

Description
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

#Client Credentials grant with username and password: 
curl -X POST \   https://api.seic.com/v2/oauthtoken \   
-H 'appkey: ADsgdnnkjnfdIKJN' \   
-H 'authorization: Basic aVhxZG9vTUmpXamJHSw==' \   
-H 'content-type: application/x-www-form-urlencoded' \   
-d 'grant_type=client_credentials&username=jdoe&password=samplepassword'

REQUEST HEADER

#Depending upon the grant_type two or more of below request headers need to be passed while making the request. 

Authorization: Basic b65939a0b6f0a21b6y9257f45l6e416f5aec5k15939a0b==

AppKey: 5l6e416f5aec5k15939a0b 

content-type: application/x-www-form-urlencoded

REQUEST PAYLOAD MODEL

Operations

Name	Description	Data Type (L)
grant_type	OAuth 2.0 grant types available depending on the characteristics of the authorization required.	string
username	The SiteMinder service account userid that is used to mint the OAuth Token.	string
password	The SiteMinder service account password that is used to mint the OAuth Token.	string

RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9

SAMPLE RESPONSE

#Client Credentials grant:
{
    "refresh_token_expires_in": "0",
    "api_product_list": "[Investors]",
    "api_product_list_json": [
        "Investors"
    ],
    "organization_name": "sei",
    "developer.email": "jdoe@seic.com",
    "token_type": "BearerToken",
    "issued_at": "1529525648451",
    "client_id": "ADsgdnnkjnfdIKJN",
    "access_token": "QxHKdx0nk2i",
    "application_name": "21c2fcd4-03ed-48815cf168",
    "scope": "",
    "expires_in": "3599",
    "refresh_count": "0",
    "status": "approved"
}

MODEL

Operations

Name	Description	Data Type (L)
api_product_list	This is the list of API products for which the OAuth token can be used.	string
organization_name	This is an internal identifier of the organization within our API management software.	string
refresh_token_expires_in	This is the expiration in seconds of the refresh token.	string
token_type	Identifies the type of token issued.	string
developer.email	The email of the developer who has registered the application in the SEI Developer portal.	string
issued_at	The date the access token was issued. This time value is the string representation of the corresponding 32-bit timestamp quantity. For example, &#039 Wed, 21 Aug 2013 19:16:47 UTC&#039 corresponds to the timestamp value of 1377112607413.	string
client_id	The SEI system client id.	string
access_token	The OAuth access token.	string
application_name	The registered application identifier.	string
scope	The list of available OAuth scopes.	string
expires_in	The lifespan or time-to-live (TTL) of the access token seconds.	string
refresh_count	The number of times the token has been refreshed.	string
status	Defines the status for a specific pending transaction, such as 'Active' or 'Cancel'.	string(30)

oAuthToken v2

POST

/oauthtoken

Prod:

http://seipdapgnode6/oauthtoken

Header Parameters

Name	Description	Data Type	Required
Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.	string
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.	string

HTTP Responses

Code

Description
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

oAuthToken v2

POST

/oauthtoken

Prod:

http://seipdapgnode6/oauthtoken

Header Parameters

Name	Description	Data Type	Required
Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.	string
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.	string

HTTP Responses

Code

Description
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v2/oauthtoken

TLS*: https://mtls.api.seic.com/v2/oauthtoken

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 1

oAuthToken

POST

Based on the grant_type selection made the URL that the application needs to invoke with relevant parameters to obtain an oAuth Token will vary

grant_type

STEP 1

client_credentials

password

refresh_token

The application needs to pass required parameters to the /oauthtoken endpoint to obtain an oAuth Token

invalidate_token

The application needs to pass a valid access_token to the /oauthtoken endpoint to kill the oAuth Token

oAuthToken v2

POST

/oauthtoken

Prod:

http://seipdapgnode6/oauthtoken

Header Parameters

Name	Description	Data Type	Required
Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.	string
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.	string

HTTP Responses

Code

Description
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

#Client Credentials grant with username and password: 
curl -X POST \   https://api.seic.com/v2/oauthtoken \   
-H 'appkey: ADsgdnnkjnfdIKJN' \   
-H 'authorization: Basic aVhxZG9vTUmpXamJHSw==' \   
-H 'content-type: application/x-www-form-urlencoded' \   
-d 'grant_type=client_credentials&username=jdoe&password=samplepassword'

REQUEST HEADER

#Depending upon the grant_type two or more of below request headers need to be passed while making the request. 

Authorization: Basic b65939a0b6f0a21b6y9257f45l6e416f5aec5k15939a0b==

AppKey: 5l6e416f5aec5k15939a0b 

content-type: application/x-www-form-urlencoded

REQUEST PAYLOAD MODEL

Operations

Name	Description	Data Type (L)
grant_type	OAuth 2.0 grant types available depending on the characteristics of the authorization required.	string
username	The SiteMinder service account userid that is used to mint the OAuth Token.	string
password	The SiteMinder service account password that is used to mint the OAuth Token.	string

RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9

SAMPLE RESPONSE

#Client Credentials grant:
{
    "refresh_token_expires_in": "0",
    "api_product_list": "[Investors]",
    "api_product_list_json": [
        "Investors"
    ],
    "organization_name": "sei",
    "developer.email": "jdoe@seic.com",
    "token_type": "BearerToken",
    "issued_at": "1529525648451",
    "client_id": "ADsgdnnkjnfdIKJN",
    "access_token": "QxHKdx0nk2i",
    "application_name": "21c2fcd4-03ed-48815cf168",
    "scope": "",
    "expires_in": "3599",
    "refresh_count": "0",
    "status": "approved"
}

MODEL

Operations

Name	Description	Data Type (L)
api_product_list	This is the list of API products for which the OAuth token can be used.	string
organization_name	This is an internal identifier of the organization within our API management software.	string
refresh_token_expires_in	This is the expiration in seconds of the refresh token.	string
token_type	Identifies the type of token issued.	string
developer.email	The email of the developer who has registered the application in the SEI Developer portal.	string
issued_at	The date the access token was issued. This time value is the string representation of the corresponding 32-bit timestamp quantity. For example, &#039 Wed, 21 Aug 2013 19:16:47 UTC&#039 corresponds to the timestamp value of 1377112607413.	string
client_id	The SEI system client id.	string
access_token	The OAuth access token.	string
application_name	The registered application identifier.	string
scope	The list of available OAuth scopes.	string
expires_in	The lifespan or time-to-live (TTL) of the access token seconds.	string
refresh_count	The number of times the token has been refreshed.	string
status	Defines the status for a specific pending transaction, such as 'Active' or 'Cancel'.	string(30)

oAuthToken v2

POST

/oauthtoken

Prod:

http://seipdapgnode6/oauthtoken

Header Parameters

Name	Description	Data Type	Required
Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.	string
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.	string

HTTP Responses

Code

Description
400

Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
401

Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
403

Forbidden-The SEI Server understood the request but refuses to fulfill it.
404

Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
500

Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.

TEST ENDPOINT

Authorization	The Base64 Encoded form of the Appkey:secret provided during Application registration.
Content-Type	Request content type. The valid values are application/xxx-form-urlencoded.

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...