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

Updates information about the OAuth Profile for a specific 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: App team member, Business Admin

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

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

Back to top

Sample Request

The example below shows an update request for the OAuth client properties.

Sample request URL

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

Sample request headers

PUT /api/apps/versions/9CA3Avaz8e96zMUKhaL4mM4s.acmepaymentscorp/oauthclient HTTP/1.1
Host:{hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "Title":"MyApp",
  "SubTitle":"MyApp",
  "AppURI":"",
  "Description":"MyApp",
  "LegalDisclaimer":"Copyright 2016",
  "token_type":"Default",
  "id_token_signed_response_alg":"Default",
  "id_token_encrypted_response_alg":"Default",
  "id_token_encrypted_response_enc":"Default",
  "token_endpoint_auth_method_supported_setting":"token_endpoint_auth_methods_list",
  "token_endpoint_auth_methods":[
    "client_secret_post",
    "client_secret_basic",
    "client_secret_jwt",
    "private_key_jwt"
  ],
  "OAuthClientType":"com.soa.oauth.ctype.public",
  "grant_types_setting":"grant_types_list",
  "grant_types":[
    "authorization_code",
    "password",
    "urn:ietf:params:oauth:grant-type:jwt-bearer"
  ],
  "supports_openid_connect":"true",
  "grant_expiration_setting":"global_setting",
  "access_token_expiry_setting":"global_setting"
}

Back to top

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/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

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. The RedirectURI and OAuthClientType are required in the request.

Back to top

Response

If successful, this operation returns HTTP status code 200, with a positive response.

Back to top

Sample Response

The sample response below shows that this operation completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Thu, 14 Jan 2016 21:10:05 GMT
Content-Type: text/plain

Sample response body

true

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
OAuthClient string A value indicating whether OAuth is in use; true or false.

Back to top

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics