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: Must be logged in. 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/vnd.soa.v81+json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "RuntimeID":"dSwCKjy3ialB1n5qIhzK8tTJgfTIatghFXaPdsHk.acmepaymentscorp",
  "OAuthClientType":"com.soa.oauth.ctype.confidential",
  "Title":"Crosfhocal",
  "SubTitle":"1.0",
  "Description":"Crossword puzzle app.",
  "AppURI":"http://www.acmepaymentscorp.com/crosfhocal",
  "LegalDisclaimer":"Copyright C 2018 all rights reserved.",
  "logo_uri":"/api/apps/versions/dSwCKjy3ialB1n5qIhzK8tTJgfTIatghFXaPdsHk.acmepaymentscorp/publicprofile/picture?size=75&cache=false&time=1529690315790",
  "response_types":[

  ],
  "grant_types":[

  ],
  "token_type":"Default",
  "contacts":[

  ],
  "jwks_uri":"",
  "id_token_signed_response_alg":"Default",
  "id_token_encrypted_response_alg":"Default",
  "id_token_encrypted_response_enc":"Default",
  "token_endpoint_auth_method_supported_setting":"global_setting",
  "token_endpoint_auth_methods":[

  ],
  "grant_expiration_setting":"global_setting",
  "grant_types_setting":"global_setting",
  "access_token_expiry_setting":"global_setting",
  "default_acr_values":[

  ],
  "request_uris":[

  ],
  "post_logout_redirect_uris":[

  ],
  "restrictedScopes":[
    "name",
    "email"
  ],
  "restrictedResponseTypes":[
    "code",
    "id_token"
  ]
}

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. 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.

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.

Multiple RedirectURI values are supported.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows that this operation completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 22 Jun 2018 18:04:28 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

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

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
400 Bad request: Returned if the client sends 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.

Back to top

Related Topics