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

Returns information about the OAuth Profile settings for a specific app version.

Authorization Roles/Permissions: App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for the OAuth client properties for the specified app version.

Sample request URL

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

Sample request headers

GET /api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp/oauthclient HTTP/1.1
Host:{hostname}
Accept: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

None.

Back to top

Request Headers

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

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

Back to top

Response

If successful, this operation returns HTTP status code 200, with the OAuth profile information for the specified app version.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Date: Fri, 22 Jun 2018 17:58:35 GMT

Sample response 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": [
        "address",
        "edit",
        "phone",
        "name",
        "admin",
        "email"
    ],
    "restrictedResponseTypes": [
        "code",
        "code id_token",
        "code id_token token",
        "id_token"
    ]
}

Back to top

Response Headers

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

Header Description
Content-Type application/json, application/vnd.soa.v72+json, application/vnd.soa.v80+json

Back to top

Response Body

Name Type Description
OAuthClient OAuthClient Includes information about the OAuth Client settings for the specified app.

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
204 The server successfully processed the request, but is not returning any content; the OAuth properties do not exist.
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