Update Password Policy by ID

PUT 
/password-policies/:id

This API updates the specified password policy. A token with ORG_ADMIN authority is required to call this API.

Request

Path Parameters

id stringrequired
The ID of password policy to update.
Example: ff808081838d9e9d01838da6a03e0007

application/json

Body

required

id string

The password policy Id.

description stringnullable

Description for current password policy.

name string

The name of the password policy.

dateCreated date-time

Date the Password Policy was created.

lastUpdated date-timenullable

Date the Password Policy was updated.

firstExpirationReminder int64

The number of days before expiration remaninder.

accountIdMinWordLength int64

The minimun length of account Id. By default is equals to -1.

accountNameMinWordLength int64

The minimun length of account name. By default is equals to -1.

minAlpha int64

Maximum alpha. By default is equals to 0.

minCharacterTypes int64

MinCharacterTypes. By default is equals to -1.

maxLength int64

Maximum length of the password.

minLength int64

Minimum length of the password. By default is equals to 0.

maxRepeatedChars int64

Maximum repetition of the same character in the password. By default is equals to -1.

minLower int64

Minimum amount of lower case character in the password. By default is equals to 0.

minNumeric int64

Minimum amount of numeric characters in the password. By default is equals to 0.

minSpecial int64

Minimum amount of special symbols in the password. By default is equals to 0.

minUpper int64

Minimum amount of upper case symbols in the password. By default is equals to 0.

passwordExpiration int64

Number of days before current password expires. By default is equals to 90.

defaultPolicy boolean

Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default.

enablePasswdExpiration boolean

Defines whether this policy is enabled to expire or not. This field is false by default.

requireStrongAuthn boolean

Defines whether this policy require strong Auth or not. This field is false by default.

requireStrongAuthOffNetwork boolean

Defines whether this policy require strong Auth of network or not. This field is false by default.

requireStrongAuthUntrustedGeographies boolean

Defines whether this policy require strong Auth for untrusted geographies. This field is false by default.

useAccountAttributes boolean

Defines whether this policy uses account attributes or not. This field is false by default.

useDictionary boolean

Defines whether this policy uses dictionary or not. This field is false by default.

useIdentityAttributes boolean

Defines whether this policy uses identity attributes or not. This field is false by default.

validateAgainstAccountId boolean

Defines whether this policy validate against account id or not. This field is false by default.

validateAgainstAccountName boolean

Defines whether this policy validate against account name or not. This field is false by default.

created stringnullable
modified stringnullable
sourceIds string[]

List of sources IDs managed by this password policy.

Responses

200

Reference to the password policy.

application/json

Schema

Schema

id string

The password policy Id.

description stringnullable

Description for current password policy.

name string

The name of the password policy.

dateCreated date-time

Date the Password Policy was created.

lastUpdated date-timenullable

Date the Password Policy was updated.

firstExpirationReminder int64

The number of days before expiration remaninder.

accountIdMinWordLength int64

The minimun length of account Id. By default is equals to -1.

accountNameMinWordLength int64

The minimun length of account name. By default is equals to -1.

minAlpha int64

Maximum alpha. By default is equals to 0.

minCharacterTypes int64

MinCharacterTypes. By default is equals to -1.

maxLength int64

Maximum length of the password.

minLength int64

Minimum length of the password. By default is equals to 0.

maxRepeatedChars int64

Maximum repetition of the same character in the password. By default is equals to -1.

minLower int64

Minimum amount of lower case character in the password. By default is equals to 0.

minNumeric int64

Minimum amount of numeric characters in the password. By default is equals to 0.

minSpecial int64

Minimum amount of special symbols in the password. By default is equals to 0.

minUpper int64

Minimum amount of upper case symbols in the password. By default is equals to 0.

passwordExpiration int64

Number of days before current password expires. By default is equals to 90.

defaultPolicy boolean

Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default.

enablePasswdExpiration boolean

Defines whether this policy is enabled to expire or not. This field is false by default.

requireStrongAuthn boolean

Defines whether this policy require strong Auth or not. This field is false by default.

requireStrongAuthOffNetwork boolean

Defines whether this policy require strong Auth of network or not. This field is false by default.

requireStrongAuthUntrustedGeographies boolean

Defines whether this policy require strong Auth for untrusted geographies. This field is false by default.

useAccountAttributes boolean

Defines whether this policy uses account attributes or not. This field is false by default.

useDictionary boolean

Defines whether this policy uses dictionary or not. This field is false by default.

useIdentityAttributes boolean

Defines whether this policy uses identity attributes or not. This field is false by default.

validateAgainstAccountId boolean

Defines whether this policy validate against account id or not. This field is false by default.

validateAgainstAccountName boolean

Defines whether this policy validate against account name or not. This field is false by default.

created stringnullable
modified stringnullable
sourceIds string[]

List of sources IDs managed by this password policy.

Example (from schema)

{
  "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"
  ]
}

Example

{
  "description": "Password Policy after update.",
  "id": "2c91808e7d976f3b017d9f5ceae440c8",
  "name": "Improved Password Policy",
  "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"
  ]
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

403

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

404

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

429

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

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

500

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...