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

Adds or modifies the OAuth details for the specified API version. Supports only a single OAuth Provider (legacy).

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
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

PUT

URL

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

Sample Request

The example below saves OAuth settings for the production endpoint.

Sample request URL

https://{hostname}/api/apis/versions/ac320d12-8494-4b1c-b84e-26337ffd3088.acmepaymentscorp/oauthdetails

Sample request headers

PUT /api/apis/versions/ac320d12-8494-4b1c-b84e-26337ffd3088.acmepaymentscorp/oauthdetails HTTP/1.1
Host: {hostname}
Accept: text/plain
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body: using the platform OAuth Provider domain

{
  "APIVersionID":"ac320d12-8494-4b1c-b84e-26337ffd3088.acmepaymentscorp",
  "ProxyAPI":{
    "ProductionEndpoint":{
      "OAuthProvider":"OAuthacmepaymentscorp",
      "PlatformAppIdentitiesInUse":false,
      "OAuth20Supported":true,
      "OAuth10aSupported":true,
      "Resource":[
        "Scope1"
      ],
      "OAuthTokenResourceURISettings":{
        "OAuthTokenResourceURIOption":"com.soa.oauth.token.resource.uri.proxy.url"
      },
      "AuthorizationEndpointParameters":{
        "Parameter":[
        ]
      },
      "TokenEndpointParameters":{
        "Parameter":[
        ]
      }
    }
  }
}

Sample request body: using a third-party provider

{
  "APIVersionID":"b8bbed55-141c-4091-adac-b990a289012e.acmepaymentscorp",
  "ProxyAPI":{
    "ProductionEndpoint":{
      "OAuthProvider":"com.soa.oauth.provider.third-party",
      "PlatformAppIdentitiesInUse":true,
      "OAuth20Supported":true,
      "OAuth10aSupported":true,
      "OAuth20Settings":{
        "AuthorizationEndpointURL":"http://www.authserverurl20.com",
        "TokenEndpointURL":"http://www.tokenendpointurl.com",
        "TokenEndpointRequestVerb":"GET",
        "BearerTokenMethods":{
          "BearerTokenMethod":[
            "com.soa.oauth.bearer.token.method.auz.header",
            "com.soa.oauth.bearer.token.method.form.param",
            "com.soa.oauth.bearer.token.method.url.query.param"
          ]
        }
      },
      "SupportedGrant":[
        "authorization_code"
      ],
      "ClientAuthPolicyOption":[
        "com.soa.oauth.client.public"
      ],
      "OAuth10aSettings":{
        "AuthorizationEndpointURL":"http://www.authserverurl10a.com",
        "AccessTokenEndpointURL":"http://www.accesstoken10.com",
        "RequestTokenEndpointURL":"http://www.requesttokenendpoint.com",
        "TokenEndpointRequestVerb":"POST",
        "TokenParameterTransmissionMethods":{
          "TokenParameterTransmissionMethod":[
            "com.soa.oauth.token.parameter.transmission.method.header",
            "com.soa.oauth.token.parameter.transmission.method.post",
            "com.soa.oauth.token.parameter.transmission.method.querystring"
          ]
        }
      },
      "OAuthTokenResourceURISettings":{
        "OAuthTokenResourceURIOption":"com.soa.oauth.token.resource.uri.proxy.url"
      },
      "AuthorizationEndpointParameters":{
        "Parameter":[
        ]
      },
      "TokenEndpointParameters":{
        "Parameter":[
        ]
      }
    },
    "SandboxEndpoint":{
      "OAuthProvider":"com.soa.oauth.provider.none",
      "PlatformAppIdentitiesInUse":false
    }
  }
}

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, */*.
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+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

HTTP/1.1 200 OK
Date: Wed, 04 May 2016 00:09:39 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