GET /api/businesses/{BusinessID}/passwordpolicy

Returns information about the password policy settings for a business on the platform.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/businesses/{BusinessID}/passwordpolicy

Back to top

Sample Request

The example below shows a request for the password policy for the specified business.

Request URL

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/passwordpolicy

Sample request headers

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

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

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
BusinessID Path string Required The unique ID for a specific business organization on the platform.

Back to top

Response

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

Back to top

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
Expires: Mon, 29 Dec 2014 13:44:45 GMT

Sample response body: application/json

{
  "MinPasswordLength" : 8,
  "MaxPasswordLength" : 0,
  "MinLetterCount" : 0,
  "MinNumberCount" : 1,
  "MinUpperLetterCount" : 0,
  "MinSpecialCharCount" : 0,
  "AllowedSpecialCharacters" : {
    "AllowedSpecialCharacter" : [ ",", ";", "@", "&" ]
  },
  "CanContainSpaces" : false,
  "IsCaseSensitive" : false,
  "CanMatchUserName" : false,
  "NumbersOfLastPasswordCheckCount" : 0,
  "PasswordChangeIntervalDays" : 0,
  "CanMatchEmail" : false
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Expires: Mon, 29 Dec 2014 13:46:26 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PasswordPolicy xmlns="http://soa.com/xsd/business/1.0" xmlns:ns2="http://soa.com/xsd/legals/1.0" 
xmlns:ns3="http://soa.com/xsd/dnmodel/1.0" xmlns:ns4="http://soa.com/xsd/api/1.0">
  <MinPasswordLength>8</MinPasswordLength>
  <MaxPasswordLength>0</MaxPasswordLength>
  <MinLetterCount>0</MinLetterCount>
  <MinNumberCount>1</MinNumberCount>
  <MinUpperLetterCount>0</MinUpperLetterCount>
  <MinSpecialCharCount>0</MinSpecialCharCount>
  <AllowedSpecialCharacters>
    <AllowedSpecialCharacter>,</AllowedSpecialCharacter>
    <AllowedSpecialCharacter>;</AllowedSpecialCharacter>
    <AllowedSpecialCharacter>@</AllowedSpecialCharacter>
    <AllowedSpecialCharacter>&</AllowedSpecialCharacter>
  </AllowedSpecialCharacters>
  <CanContainSpaces>false</CanContainSpaces>
  <IsCaseSensitive>false</IsCaseSensitive>
  <CanMatchUserName>false</CanMatchUserName>
  <NumbersOfLastPasswordCheckCount>0</NumbersOfLastPasswordCheckCount>
  <PasswordChangeIntervalDays>0</PasswordChangeIntervalDays>
  <CanMatchEmail>false</CanMatchEmail>
</PasswordPolicy>

Back to top

Response Headers

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

Header Description
Content-Type

application/json, application/xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Response Body

Name Type Description
PasswordPolicy PasswordPolicy Contains information about the password policy in effect for the business.

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