PUT /api/apps/versions/{AppVersionID}/oauthclient

Updates information about the OAuth Profile for the specified app version.

Workflow: This operation checks whether the resource is governed by a workflow, and if so whether the action is valid based on the current state of the resource. If the action is not valid, the operation will fail.

Authorization Roles/Permissions: Must be logged in. App team member, Business Admin

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/apps/versions/{AppVersionID}/oauthclient

Sample Request

The example below shows a request to update the OAuth profile for the specified app version.

Sample request URL

https://{hostname}/api/apps/versions/YRPOBZf7Msi1C1M9LqxKSUSy54fW8ycHjbRtGjlo.acmepaymentscorp/oauthclient

Sample request headers

PUT /api/apps/versions/YRPOBZf7Msi1C1M9LqxKSUSy54fW8ycHjbRtGjlo.acmepaymentscorp/oauthclient HTTP/1.1
Host:{hostname}
Accept: */*
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "Title":"Game App",
  "SubTitle":"1.0",
  "AppURI":"http://www.rcoaless.com/game",
  "Description":"Initial version",
  "LegalDisclaimer":"Copyright C 2021 rcoaless. All Rights Reserved.",
  "token_type":"Default",
  "id_token_signed_response_alg":"Default",
  "OAuthClientType":"com.soa.oauth.ctype.confidential",
  "token_endpoint_auth_method_supported_setting":"global_setting",
  "requireSignedRequests":"true",
  "request_object_signing_alg":"RS256",
  "jwks_uri":"http://jwks.example.com",
  "restrictedResponseTypes":[
    "code",
    "code id_token",
    "code id_token token"
  ],
  "grant_types_setting":"global_setting",
  "grant_expiration_setting":"grant_exp_in_hours",
  "grant_expiration_hours":"2",
  "access_token_expiry_setting":"access_token_exp_in_secs",
  "access_token_expiry":"3600",
  "supports_openid_connect":"false",
  "bypass_authorization":"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.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
AppVersionID	Path	string	Required	The unique ID for a specific app version.
OAuthClient	Body	OAuthClient	Required	Includes information about the OAuth Client settings for the specified app. Multiple RedirectURI values are supported.

Response

If successful, this operation returns HTTP status code 200, with Boolean true.

Sample Response

The sample response below shows that this operation completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Thu, 15 Jul 2021 21:07:42 GMT
Content-Type: text/plain

Sample response body

true

Response Headers

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

Header	Description
Content-Type	text/plain

Response Body

The response body is Boolean true or false, indicating whether the operation was successful.

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
400	Bad request: Returned if the client sends a malformed request; for example, invalid parameters or body content.For example, you might get this response if you send an incorrect JSON object in the request, or specified the wrong media type in the Content-Type header.
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.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics