GET /resources/v2/{ResourceVersionKey}/settings

Used after login: Returns information about all the configurable settings for the tenant, such as app, API, ticket, and business settings.

Valid in version: 2020.1.0 and later

If you don't know the ResourceVersionKey value, run the GET /resources/resourceversionkey operation.

Note: Resource version key is basically a random string to bust the cache.

The response is cached for one month unless the ResourceVersionKey changes.

Authorization Roles/Permissions: Must be logged in.

This topic includes the following sections:

HTTP Method

GET

URL

{protocol}//{hostname}/resources/v2/{ResourceVersionKey}/settings

Sample Request

The example below shows a request for information about the settings for the specified tenant.

Sample Request URL

http://acmepaymentscorp.com/resources/v2/_VD9V6IfDkMZV6fh7nhAR2Yg/settings

Sample request headers

Accept: application/vnd.akana.v2020+json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/json, application/vnd.akana.v2020+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
ResourceVersionKey	Path	String	Required	The unique ID for the resource version.

Response

If successful, this operation returns HTTP status code 200, with the settings.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/vnd.akana.v2020+json
Date: Wed, 10 Jun 2020 00:23:52 GMT

Sample response body

{
  "TenantProperties": {
    "DefaultTheme": "default",
    "ConsoleAddress": "http://acmepaymentscorp.com/atmosphere/",
    "Themes": [
      {
        "Theme": "bonita",
        "VirtualHosts": [
          "openbonita-acmepaymentscorp.com"
        ],
        "ConsoleAddress": "http://openbonita-acmepaymentscorp.com/atmosphere/",
        "SiteTitle": "",
        "SiteDescription": "",
        "TenantID": 10041,
        "FedmemberID": "open",
        "ThemeImpl": "simpledev"
      },
      {
        "Theme": "clone",
        "VirtualHosts": [
          "openclone-acmepaymentscorp.com"
        ],
        "ConsoleAddress": "http://openclone-acmepaymentscorp.com/atmosphere",
        "SiteDescription": "",
        "TenantID": 10041,
        "FedmemberID": "open",
        "ThemeImpl": "default"
      },
      {
        "Theme": "default",
        "VirtualHosts": [
          "open-acmepaymentscorp.com"
        ],
        "ConsoleAddress": "http://open-acmepaymentscorp.com/atmosphere/",
        "TenantID": 10041,
        "FedmemberID": "open"
      },
      {
        "Theme": "devops",
        "VirtualHosts": [
          "opendevops-acmepaymentscorp.com"
        ],
        "ConsoleAddress": "http://opendevops-acmepaymentscorp.com/atmosphere",
        "SiteDescription": "",
        "TenantID": 10041,
        "FedmemberID": "open"
      },
      {
        "Theme": "hermosa",
        "VirtualHosts": [
          "opencloud-acmepaymentscorp.com"
        ],
        "ConsoleAddress": "http://opencloud-acmepaymentscorp.com/atmosphere",
        "SiteDescription": "",
        "TenantID": 10041,
        "FedmemberID": "open",
        "ThemeImpl": "default"
      },
      {
        "Theme": "simpledev",
        "VirtualHosts": [
          "opendeveloper-acmepaymentscorp.com"
        ],
        "ConsoleAddress": "http://opendeveloper-acmepaymentscorp.com/atmosphere",
        "SiteDescription": "",
        "TenantID": 10041,
        "FedmemberID": "open"
      }
    ],
    "TenantID": "open",
    "SiteAdminGroupID": "tenantadmin.acmepaymentscorp",
    "TenantBusinessID": "tenantbusiness.acmepaymentscorp",
    "TenantBusinessKey": "uddi:soa.com:atmosphere:tenant:acmepaymentscorp",
    "BusinessAdminGroupID": "bizadmin-tenantbusiness.acmepaymentscorp",
    "TenantName": "acmepaymentscorp",
    "ContactEmailAddress": "administrator@example.com",
    "FromEmailAddress": "administrator@example.com",
    "AnalyticsAccountID": "",
    "SupportedThemes": [
      {
        "Theme": "devops",
        "Cloneable": true
      },
      {
        "Theme": "bonita",
        "Cloneable": true,
        "ThemeImpl": "simpledev"
      },
      {
        "Theme": "simpledev",
        "Cloneable": true
      },
      {
        "Theme": "hermosa",
        "Cloneable": true,
        "ThemeImpl": "default"
      },
      {
        "Theme": "default",
        "Cloneable": true
      }
    ],
    "LaaSIntegrationSupport": "com.soa.feature.disabled",
    "ForwardProxyAllowedHosts": [
      "*"
    ]
  },
  "BusinessSettings": {
    "BusinessAPISettings": {
      "PublicAPISupport": "com.soa.feature.enabled",
      "PublicAPISandboxEndpointSupport": "com.soa.feature.enabled",
      "PublicAPIProductionEndpointSupport": "com.soa.feature.enabled",
      "PublicAPISandboxAutoApprovalSupport": "com.soa.feature.enabled",
      "PublicAPIProductionAutoApprovalSupport": "com.soa.feature.enabled",
      "PublicAPIBoardSupport": "com.soa.feature.enabled",
      "PublicAPIRatingsSupport": "com.soa.feature.enabled",
      "PublicAPIReviewsSupport": "com.soa.feature.enabled",
      "PrivateAPISupport": "com.soa.feature.enabled",
      "PrivateAPISandboxEndpointSupport": "com.soa.feature.enabled",
      "PrivateAPIProductionEndpointSupport": "com.soa.feature.enabled",
      "PrivateAPISandboxAutoApprovalSupport": "com.soa.feature.enabled",
      "PrivateAPIProductionAutoApprovalSupport": "com.soa.feature.enabled",
      "PrivateAPIGroupTypeSupport": "com.soa.feature.disabled",
      "PrivateAPIIndependentGroupSupport": "com.soa.feature.enabled",
      "PrivateAPIBoardSupport": "com.soa.feature.enabled",
      "PrivateAPIRatingsSupport": "com.soa.feature.enabled",
      "PrivateAPIReviewsSupport": "com.soa.feature.enabled",
      "PublicAPIResourceLevelPermissionsSupport": "com.soa.feature.enabled",
      "PrivateAPIResourceLevelPermissionsSupport": "com.soa.feature.enabled",
      "APIWithNewServiceSupport": "com.soa.feature.enabled",
      "APIWithExistingServiceSupport": "com.soa.feature.disabled",
      "APIWithAnonymousAccessSupport": "com.soa.feature.enabled",
      "APIPromotionSupport": "com.soa.feature.enabled",
      "ValidateUniqueContextPath": "com.soa.feature.enabled"
    },
    "BusinessAppSettings": {
      "PublicAppSupport": "com.soa.feature.enabled",
      "PublicAppBoardSupport": "com.soa.feature.enabled",
      "PublicAppRatingsSupport": "com.soa.feature.enabled",
      "PublicAppReviewsSupport": "com.soa.feature.enabled",
      "PrivateAppSupport": "com.soa.feature.enabled",
      "PrivateAppBoardSupport": "com.soa.feature.enabled",
      "PrivateAppRatingsSupport": "com.soa.feature.enabled",
      "PrivateAppReviewsSupport": "com.soa.feature.enabled",
      "UserDefinedIdentitySupport": "com.soa.feature.enabled.for.siteadmins",
      "SimultaneousSandboxProductAccessSupport": "com.soa.feature.enabled",
      "ReturnPlainTextSharedSecret": "com.soa.feature.enabled",
      "RegisteredUsersAppSupport": "com.soa.feature.enabled",
      "RegisteredUsersAppRatingsSupport": "com.soa.feature.enabled",
      "RegisteredUsersAppReviewsSupport": "com.soa.feature.enabled",
      "AppPromotionSupport": "com.soa.feature.disabled",
      "ContractPoliciesSupport": "com.soa.feature.enabled"
    },
    "BusinessGroupSettings": {
      "GroupSupport": "com.soa.feature.enabled",
      "PublicGroupSupport": "com.soa.feature.enabled",
      "PublicGroupBoardSupport": "com.soa.feature.enabled",
      "PublicGroupRatingsSupport": "com.soa.feature.enabled",
      "PublicGroupReviewsSupport": "com.soa.feature.enabled",
      "PrivateGroupSupport": "com.soa.feature.enabled",
      "PrivateGroupBoardSupport": "com.soa.feature.enabled",
      "PrivateGroupRatingsSupport": "com.soa.feature.enabled",
      "PrivateGroupReviewsSupport": "com.soa.feature.enabled"
    },
    "BusinessUserSettings": {
      "NewsUpdateNotification": "com.soa.feature.enabled",
      "EnforceChallengesSetupOnLogin": "com.soa.feature.disabled",
      "SelfSignup": "com.soa.feature.enabled",
      "InviteUnregisteredUsers": "com.soa.feature.enabled",
      "ResetValidCodeHours": 48,
      "UpdateEmailValidCodeHours": 48,
      "SignupUserValidDays": 7,
      "AddedUserValidDays": 30,
      "InvitedUserValidDays": 7,
      "TopApisCountAllowed": 10
    },
    "TicketSettings": {
      "TicketSupport": "com.soa.feature.enabled",
      "Visibility": "com.soa.visibility.apivisibility",
      "MarkdownSupport": "com.soa.feature.enabled",
      "ExternalLinkSupport": "com.soa.feature.disabled"
    },
    "AlertSettings": {
      "AutoPublish": false,
      "MarkdownSupport": "com.soa.feature.enabled",
      "ExternalLinkSupport": "com.soa.feature.disabled"
    },
    "ConnectionSettings": {},
    "BusinessSecuritySettings": {
      "ReadRequestCSRFSupport": "com.soa.feature.disabled",
      "WriteRequestCSRFSupport": "com.soa.feature.enabled",
      "AllowUserEnum": "com.soa.feature.enabled",
      "EncryptChallengeAnswers": "com.soa.feature.disabled",
      "ChallengeCount": 3,
      "UserModifyEmail": "com.soa.feature.enabled",
      "SiteAdminModifyEmail": "com.soa.feature.enabled",
      "AuthTokenCookieDomain": "com.soa.auth.token.cookie.domain.hostname",
      "CaptchaSupport": "com.soa.feature.disabled",
      "ExternalDocSupport": "com.soa.feature.enabled",
      "XssKeywords": "onload,onerror,onmouseout,onmouseover,eval",
      "AllowedFileTypes": "*",
      "WhiteListKeywordsSupport": "com.soa.feature.disabled"
    },
    "BusinessReviewSettings": {
      "ReviewWorkflowDefKey": "workflow:definition:review",
      "AutoPublish": false,
      "MarkdownSupport": "com.soa.feature.enabled",
      "ExternalLinkSupport": "com.soa.feature.disabled"
    },
    "BusinessDiscussionSettings": {
      "DiscussionWorkflowDefKey": "workflow:definition:discussion",
      "DiscussionCommentWorkflowDefKey": "workflow:definition:comment",
      "AutoPublish": false,
      "MarkdownSupport": "com.soa.feature.enabled",
      "ExternalLinkSupport": "com.soa.feature.disabled"
    },
    "CommentSettings": {
      "AutoPublish": false,
      "MarkdownSupport": "com.soa.feature.enabled",
      "ExternalLinkSupport": "com.soa.feature.disabled"
    },
    "Settings": {
      "MaxFileSizeForUpload": 4
    }
  },
  "LoginDomains": {
    "LoginDomain": [
      {
        "LoginDomainID": "siteusers.open",
        "FedmemberId": "open",
        "Title": "open-users",
        "Sequence": -1,
        "VirtualHost": [],
        "IdSystemType": "Policy Manager",
        "LogoAssigned": false,
        "Enabled": true
      }
    ]
  },
  "Challenges": {
    "Challenge": [
      {
        "ChallengeCode": "com.soa.challenge.question.pet",
        "ChallengeQuestion": "What is the name of your pet?"
      },
      {
        "ChallengeCode": "com.soa.challenge.question.mothers.name",
        "ChallengeQuestion": "What is your mother's maiden name?"
      },
      {
        "ChallengeCode": "com.soa.challenge.question.city.birth",
        "ChallengeQuestion": "What is the city of your birth?"
      },
      {
        "ChallengeCode": "com.soa.challenge.question.color",
        "ChallengeQuestion": "What is your favorite color?"
      }
    ]
  },
  "PasswordPolicy": {
    "MinPasswordLength": 0,
    "MaxPasswordLength": 0,
    "MinLetterCount": 0,
    "MinNumberCount": 0,
    "MinUpperLetterCount": 0,
    "MinSpecialCharCount": 0,
    "CanContainSpaces": true,
    "IsCaseSensitive": true,
    "CanMatchUserName": true,
    "NumbersOfLastPasswordCheckCount": 0,
    "PasswordChangeIntervalDays": 0,
    "CanMatchEmail": true
  }
}

Response Headers

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

Header	Description
Content-Type	application/json, application/vnd.akana.v2020+json

Response Body

Name	Type	Description
TenantSettings	TenantSettings	Contains information about the settings for the tenant, configurable by the Site Admin, such as app, API, ticket, and password policy settings. This operation is called after login, and returns all settings.

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