How to Call an OAuth Token
Request Parameters
Parameter |
Description |
Required? |
Data Type |
---|---|---|---|
access_token |
"Authorization: Beader <access_token>" The access_token returned from /oauth/token API call. |
Yes |
String |
client_id |
Provided to users of the API. |
Yes |
String |
NOTE: Token must be passed as - Authorization: Bearer <access_token> header
Response Payload
{ "access_token": "<access_token>", "token_type": "BearerToken", "expires_in": 3591, "status": "approved", "scope": "ilservices", "refresh_token": "<refresh_token>", "refresh_token_expires_in": 2591991, "redirect_url": "http://www.redirect.com", "email": "IL_account_email", "app_name": "IL-oauth-test" }
Response Parameters
Parameter |
Description |
Required? |
Data Type |
Default |
---|---|---|---|---|
access_token |
OAuth Access Token |
Yes |
String |
|
token_type |
Type of the token. |
Yes |
String |
BearerToken |
expires_in |
Token expiration time in seconds. |
Yes |
Integer |
3600 seconds |
status |
Status of the token. |
Yes |
String |
Approved |
scope |
Used to further limit the access granted to OAuth token. Only scope=ilservices is currently supported. |
No |
String |
ilservices |
refresh_token |
OAuth refresh token. Only sent for Authorization Code flow. |
Yes |
String |
|
refresh_token_expires_in |
Refresh Token expiration time in seconds. |
Yes |
Integer |
2592000 seconds |
redirect_url |
Redirect URL registered for the client application. |
Yes |
String |
|
|
Logged in user's email address. |
Yes |
String |
|
app_name |
Name of the app given by SEI. |
Yes |
String |
|