Skip to main content

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

Body

required
    id string

    The password policy Id.

    description string

    Description for current password policy.

    name string

    The name of the password policy.

    dateCrated date-time

    Date the Password Policy was created.

    lastUpdated date-time

    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

    Default value: false

    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

    Default value: false

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

    requireStrongAuthn boolean

    Default value: false

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

    requireStrongAuthOffNetwork boolean

    Default value: false

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

    requireStrongAuthUntrustedGeographies boolean

    Default value: false

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

    useAccountAttributes boolean

    Default value: false

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

    useDictionary boolean

    Default value: false

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

    useIdentityAttributes boolean

    Default value: false

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

    validateAgainstAccountId boolean

    Default value: false

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

    validateAgainstAccountName boolean

    Default value: false

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

    sourceIds string[]

    List of sources IDs managed by this password policy.

Responses

Reference to the password policy.

Schema
    id string

    The password policy Id.

    description string

    Description for current password policy.

    name string

    The name of the password policy.

    dateCrated date-time

    Date the Password Policy was created.

    lastUpdated date-time

    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

    Default value: false

    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

    Default value: false

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

    requireStrongAuthn boolean

    Default value: false

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

    requireStrongAuthOffNetwork boolean

    Default value: false

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

    requireStrongAuthUntrustedGeographies boolean

    Default value: false

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

    useAccountAttributes boolean

    Default value: false

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

    useDictionary boolean

    Default value: false

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

    useIdentityAttributes boolean

    Default value: false

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

    validateAgainstAccountId boolean

    Default value: false

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

    validateAgainstAccountName boolean

    Default value: false

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

    sourceIds string[]

    List of sources IDs managed by this password policy.

Loading...