GET /resources/{ResourceVersionKey}/settings

Used prior to login: Returns a subset of the configurable settings for the tenant, such as login domains, password policy, and API and app settings. Additional settings, such as settings for alerts, connections, reviews, discussions, and comments, are returned after login.

Updated in version: 2020.1.0 and later. Prior to version 2020.1.0, this operation returned all settings. In 2020.1.0 and later, this operation returns a subset of settings so that the user can be logged in. After login, an additional operation, GET /resources/{ResourceVersionKey}/settings with application/vnd.akana.v2020+json Accept header, returns all settings.

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

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

Authorization Roles/Permissions: Anyone can perform this operation. Login is not required. Additional settings are returned after login.

Note: The CSRF header is never required for this operation, regardless of platform settings.

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

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

Sample Request URL

http://acmepaymentscorp.com/resources/_Vfvxbl0GScGIr2QzVZKzzVw/settings

Sample request headers

Accept: application/json

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

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: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Thu, 11 Jun 2020 22:20:06 GMT

Sample response body: application/json

{
  "TenantProperties": {
    "TenantID": "open",
    "SiteAdminGroupID": "tenantadmin.acmepaymentscorp",
    "TenantBusinessID": "tenantbusiness.acmepaymentscorp",
    "BusinessAdminGroupID": "bizadmin-tenantbusiness.acmepaymentscorp",
    "TenantName": "open",
    "LaaSIntegrationSupport": "com.soa.feature.disabled"
  },
  "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": 8
    },
    "TicketSettings": {
      "TicketSupport": "com.soa.feature.enabled",
      "Visibility": "com.soa.visibility.apivisibility",
      "MarkdownSupport": "com.soa.feature.enabled",
      "ExternalLinkSupport": "com.soa.feature.disabled"
    },
    "BusinessSecuritySettings": {
      "ReadRequestCSRFSupport": "com.soa.feature.disabled",
      "WriteRequestCSRFSupport": "com.soa.feature.disabled",
      "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"
    }
  },
  "LoginDomains": {
    "LoginDomain": [
      {
        "LoginDomainID": "siteusers.acmepaymentscorp",
        "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.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+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 before login, and returns a subset of settings, the ones that will be needed for the user to log in or to use the Community Manager developer portal as an anonymous user. After login, an additional operation, GET /resources/v2{ResourceVersionKey}/settings, returns all the 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
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics