APIs and Assertions

The OAuth Toolkit uses the APIs provided by the different components. The APIs can be used by any other third-party client.
otk43
The OAuth Toolkit uses the APIs provided by the different components. The APIs can be used by any other third-party client.
The following APIs are provided and are required. 
 
 
All APIs support HTTP GET and HTTP POST (content-type: 
application/x-www-form-urlencoded
). The requirement for SSL can be configured by customizing the policy.
Values within brackets followed by a "?" are optional parameters; for example: (&parameter=value)?
Swagger Documentation for OAuth Server APIs
API definitions are available in Swagger for the OAuth Server APIs.
The swagger documentation presented on the docops.ca.com site is served from static JSON files rather than a running Gateway. To interact with the API through Swagger, access the /apidocs/auth/oauth/v2/swagger endpoint on your Gateway and view the documentation using a Swagger viewer such as Swagger UI.    
Access API Documentation with the Swagger UI Chrome Extension
To use the Swagger UI Chrome Extension:
  1. Install the Swagger UI chrome-extension.
    swagger.png  
  2. In the browser URL field, enter the URL to point to the apidocs endpoint on your Gateway:
    https://<myGateway>:8443/apidocs/auth/oauth/v2/swagger
    The JSON file appears. This step is required to accept the certificate from the gateway. 
  3. Either enter the URL in Swagger UI field as shown below, or click the Swagger UI Console icon.
    swagger2.png