List Password Policies
GET/password-policies
This gets list of all Password Policies. Requires role of ORG_ADMIN
Request
Query Parameters
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Default value: 0
Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information.
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of all Password Policies.
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
The password policy Id.
Description for current password policy.
The name of the password policy.
Date the Password Policy was created.
Date the Password Policy was updated.
The number of days before expiration remaninder.
The minimun length of account Id. By default is equals to -1.
The minimun length of account name. By default is equals to -1.
Maximum alpha. By default is equals to 0.
MinCharacterTypes. By default is equals to -1.
Maximum length of the password.
Minimum length of the password. By default is equals to 0.
Maximum repetition of the same character in the password. By default is equals to -1.
Minimum amount of lower case character in the password. By default is equals to 0.
Minimum amount of numeric characters in the password. By default is equals to 0.
Minimum amount of special symbols in the password. By default is equals to 0.
Minimum amount of upper case symbols in the password. By default is equals to 0.
Number of days before current password expires. By default is equals to 90.
Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default.
Defines whether this policy is enabled to expire or not. This field is false by default.
Defines whether this policy require strong Auth or not. This field is false by default.
Defines whether this policy require strong Auth of network or not. This field is false by default.
Defines whether this policy require strong Auth for untrusted geographies. This field is false by default.
Defines whether this policy uses account attributes or not. This field is false by default.
Defines whether this policy uses dictionary or not. This field is false by default.
Defines whether this policy uses identity attributes or not. This field is false by default.
Defines whether this policy validate against account id or not. This field is false by default.
Defines whether this policy validate against account name or not. This field is false by default.
List of sources IDs managed by this password policy.
[
{
"id": "2c91808e7d976f3b017d9f5ceae440c8",
"description": "Information about the Password Policy",
"name": "PasswordPolicy Example",
"dateCreated": 1639056206564,
"lastUpdated": 1939056206564,
"firstExpirationReminder": 45,
"accountIdMinWordLength": 4,
"accountNameMinWordLength": 6,
"minAlpha": 5,
"minCharacterTypes": 5,
"maxLength": 25,
"minLength": 8,
"maxRepeatedChars": 3,
"minLower": 8,
"minNumeric": 8,
"minSpecial": 8,
"minUpper": 8,
"passwordExpiration": 8,
"defaultPolicy": true,
"enablePasswdExpiration": true,
"requireStrongAuthn": true,
"requireStrongAuthOffNetwork": true,
"requireStrongAuthUntrustedGeographies": true,
"useAccountAttributes": false,
"useDictionary": false,
"useIdentityAttributes": false,
"validateAgainstAccountId": false,
"validateAgainstAccountName": true,
"created": "string",
"modified": "string",
"sourceIds": [
"2c91808382ffee0b01830de154f14034",
"2f98808382ffee0b01830de154f12134"
]
}
]
[
{
"description": "Example Password Policy",
"id": "2c91808e7d976f3b017d9f5ceae440c8",
"name": "Example PP",
"dateCreated": 1639056206564,
"lastUpdated": 1662385430753,
"firstExpirationReminder": 90,
"accountIdMinWordLength": 3,
"accountNameMinWordLength": 3,
"maxLength": 0,
"maxRepeatedChars": 4,
"minAlpha": 1,
"minCharacterTypes": -1,
"minLength": 8,
"minLower": 0,
"minNumeric": 1,
"minSpecial": 0,
"minUpper": 0,
"passwordExpiration": 90,
"defaultPolicy": false,
"enablePasswdExpiration": false,
"requireStrongAuthn": false,
"requireStrongAuthOffNetwork": false,
"requireStrongAuthUntrustedGeographies": false,
"useAccountAttributes": false,
"useDictionary": false,
"useIdentityAttributes": false,
"validateAgainstAccountId": true,
"validateAgainstAccountName": true,
"sourceIds": [
"2c91808382ffee0b01830de154f14034",
"2c91808582ffee0c01830de36511405f"
]
},
{
"description": null,
"id": "2c91808780b8b8430180ff7a093f3bf2",
"name": "Password Policy 1 test",
"dateCreated": 1653553629503,
"lastUpdated": null,
"firstExpirationReminder": null,
"accountIdMinWordLength": -1,
"accountNameMinWordLength": -1,
"maxLength": 0,
"maxRepeatedChars": -1,
"minAlpha": 1,
"minCharacterTypes": -1,
"minLength": 8,
"minLower": 0,
"minNumeric": 1,
"minSpecial": 0,
"minUpper": 0,
"passwordExpiration": 90,
"defaultPolicy": false,
"enablePasswdExpiration": false,
"requireStrongAuthn": false,
"requireStrongAuthOffNetwork": false,
"requireStrongAuthUntrustedGeographies": false,
"useAccountAttributes": false,
"useDictionary": false,
"useIdentityAttributes": true,
"validateAgainstAccountId": false,
"validateAgainstAccountName": false,
"sourceIds": []
}
]
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 500 response object
{
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}