PUT /api/apis/versions/{APIVersionID}/oauthdetails

Adds or modifies the OAuth details for the specified API version. Supports multiple OAuth Providers.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/apis/versions/{APIVersionID}/oauthdetails

Sample Request

The example below adds the OAuth details with multiple OAuth providers.

Sample request URL

https://{hostname}/api/apis/versions/versions/a7ece9ef-e4cd-4bac-9868-31fde66c516e.acmepaymentscorp/oauthdetails

Sample request headers

PUT /api/apis/versions/a7ece9ef-e4cd-4bac-9868-31fde66c516e/oauthdetails HTTP/1.1
Accept: application/json
Content-Type: application/vnd.soa.v2019+json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "APIVersionID":"a7ece9ef-e4cd-4bac-9868-31fde66c516e.acmepaymentscorp",
  "APIVersionOAuthResourceMapping": {
     "Resource": [
        "scope"
     ]
  },
  "ProxyAPIList": {
     "ProductionEndpoint": [
        {
           "ClientAuthPolicyOption": [],
           "OAuth10aSupported": false,
           "OAuth20Supported": true,
           "OAuthProvider": "Oauth1",
           "PlatformAppIdentitiesInUse": false,
           "Resource": [],
           "SupportedGrant": []
        },
        {
           "ClientAuthPolicyOption": [],
           "OAuth10aSupported": false,
           "OAuth20Supported": true,
           "OAuthProvider": "PingFederateDomain-JWT-1",
           "PlatformAppIdentitiesInUse": false,
           "Resource": [],
           "SupportedGrant": []
        }
     ],
     "SandboxEndpoint": []
   }
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Accept	application/vnd.soa.v2019+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
APIVersionID	Path	String	Required	The unique ID for a specific API version.
oauthDetails	Form data	APIVersionOAuthDetails	Required	Includes OAuth information about an API version, such as OAuth version and settings.

Response

If successful, this operation returns HTTP status code 200. There is no response body.

Sample Response

The sample response below shows that the request message was successfully received.

Sample response headers

Status Code: 204 No Content
Date: Mon, 15 Jul 2019 21:44:57 GMT

Sample response body

None.

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	text/plain

Response Body

None.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found. For example, you might get this if you had the wrong HTTP verb.
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics