Blackboard Authentication API

<back to all web services

OAuth2TokenRequest40

The following routes are available for this service:
POST,OPTIONS/api/auth/oauth2/tokenCreates an API access token
Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesOAuth2 authorization credentials

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/OAuth2TokenRequest40 HTTP/1.1 
Host: prodeastbbauthservice.transactcampus.com 
Content-Type: application/xml
Content-Length: length

<OAuth2TokenRequest40 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BbAuth.Services.SecurityApi.V4.SecurityApiRoutes.Models" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OAuth2TokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BbAuth.Services.SecurityApi.V4.SecurityApiRoutes.Models">
  <access_token>String</access_token>
  <error>String</error>
  <error_description>String</error_description>
  <expires_in>0</expires_in>
  <refresh_token>String</refresh_token>
  <token_type>String</token_type>
  <warning>String</warning>
</OAuth2TokenResponse>